Interface PipelineJob
-
public interface PipelineJob
An immutable client-side representation of PipelineJob.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
PipelineJob.Definition
The entirety of the PipelineJob definition.static interface
PipelineJob.DefinitionStages
The PipelineJob definition stages.static interface
PipelineJob.Update
The template for PipelineJob update.static interface
PipelineJob.UpdateStages
The PipelineJob update stages.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cancel()
Cancels a pipeline job with the given name.void
cancel(com.azure.core.util.Context context)
Cancels a pipeline job with the given name.String
description()
Gets the description property: An optional description for the pipeline.PipelineJobError
error()
Gets the error property: Details about the error, in case the pipeline job fails.OffsetDateTime
expiration()
Gets the expiration property: The date-time by when this pipeline job will be automatically deleted from your account.String
id()
Gets the id property: Fully qualified resource Id for the resource.PipelineJobInner
innerModel()
Gets the inner com.azure.resourcemanager.videoanalyzer.fluent.models.PipelineJobInner object.String
name()
Gets the name property: The name of the resource.List<ParameterDefinition>
parameters()
Gets the parameters property: List of the instance level parameter values for the user-defined topology parameters.PipelineJob
refresh()
Refreshes the resource to sync with Azure.PipelineJob
refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.String
resourceGroupName()
Gets the name of the resource group.PipelineJobState
state()
Gets the state property: Current state of the pipeline (read-only).com.azure.core.management.SystemData
systemData()
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.String
topologyName()
Gets the topologyName property: Reference to an existing pipeline topology.String
type()
Gets the type property: The type of the resource.PipelineJob.Update
update()
Begins update for the PipelineJob resource.
-
-
-
Method Detail
-
id
String id()
Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()
Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()
Gets the type property: The type of the resource.- Returns:
- the type value.
-
systemData
com.azure.core.management.SystemData systemData()
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
topologyName
String topologyName()
Gets 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.
-
description
String description()
Gets the description property: An optional description for the pipeline.- Returns:
- the description value.
-
state
PipelineJobState state()
Gets the state property: Current state of the pipeline (read-only).- Returns:
- the state value.
-
expiration
OffsetDateTime expiration()
Gets the expiration property: The date-time by when this pipeline job will be automatically deleted from your account.- Returns:
- the expiration value.
-
error
PipelineJobError error()
Gets the error property: Details about the error, in case the pipeline job fails.- Returns:
- the error value.
-
parameters
List<ParameterDefinition> parameters()
Gets 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.
-
resourceGroupName
String resourceGroupName()
Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
PipelineJobInner innerModel()
Gets the inner com.azure.resourcemanager.videoanalyzer.fluent.models.PipelineJobInner object.- Returns:
- the inner object.
-
update
PipelineJob.Update update()
Begins update for the PipelineJob resource.- Returns:
- the stage of resource update.
-
refresh
PipelineJob refresh()
Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
PipelineJob refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
cancel
void cancel()
Cancels a pipeline job with the given name.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
cancel
void cancel(com.azure.core.util.Context context)
Cancels a pipeline job with the given name.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
-