Class PipelineJobProperties
- java.lang.Object
-
- com.azure.resourcemanager.videoanalyzer.fluent.models.PipelineJobProperties
-
public final class PipelineJobProperties extends Object
Pipeline job properties.
-
-
Constructor Summary
Constructors Constructor Description PipelineJobProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
description()
Get the description property: An optional description for the pipeline.PipelineJobError
error()
Get the error property: Details about the error, in case the pipeline job fails.OffsetDateTime
expiration()
Get the expiration property: The date-time by when this pipeline job will be automatically deleted from your account.List<ParameterDefinition>
parameters()
Get the parameters property: List of the instance level parameter values for the user-defined topology parameters.PipelineJobState
state()
Get the state property: Current state of the pipeline (read-only).String
topologyName()
Get the topologyName property: Reference to an existing pipeline topology.void
validate()
Validates the instance.PipelineJobProperties
withDescription(String description)
Set the description property: An optional description for the pipeline.PipelineJobProperties
withParameters(List<ParameterDefinition> parameters)
Set the parameters property: List of the instance level parameter values for the user-defined topology parameters.PipelineJobProperties
withTopologyName(String topologyName)
Set the topologyName property: Reference to an existing pipeline topology.
-
-
-
Method Detail
-
topologyName
public String topologyName()
Get the topologyName property: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.- Returns:
- the topologyName value.
-
withTopologyName
public PipelineJobProperties withTopologyName(String topologyName)
Set the topologyName property: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.- Parameters:
topologyName
- the topologyName value to set.- Returns:
- the PipelineJobProperties object itself.
-
description
public String description()
Get the description property: An optional description for the pipeline.- Returns:
- the description value.
-
withDescription
public PipelineJobProperties withDescription(String description)
Set the description property: An optional description for the pipeline.- Parameters:
description
- the description value to set.- Returns:
- the PipelineJobProperties object itself.
-
state
public PipelineJobState state()
Get the state property: Current state of the pipeline (read-only).- Returns:
- the state value.
-
expiration
public OffsetDateTime expiration()
Get the expiration property: The date-time by when this pipeline job will be automatically deleted from your account.- Returns:
- the expiration value.
-
error
public PipelineJobError error()
Get the error property: Details about the error, in case the pipeline job fails.- Returns:
- the error value.
-
parameters
public List<ParameterDefinition> parameters()
Get the parameters property: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.- Returns:
- the parameters value.
-
withParameters
public PipelineJobProperties withParameters(List<ParameterDefinition> parameters)
Set the parameters property: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.- Parameters:
parameters
- the parameters value to set.- Returns:
- the PipelineJobProperties object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-