LivePipelineProperties Class

Package:

com.azure.media.videoanalyzer.edge.models

Maven Artifact:

com.azure:azure-media-videoanalyzer-edge:1.0.0-beta.6

• java.lang.Object
• • com.azure.media.videoanalyzer.edge.models.LivePipelineProperties

public final class LivePipelineProperties

Live pipeline properties.

Constructor Summary

Constructor	Description
LivePipelineProperties()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the description property: An optional description of the live pipeline.
List<ParameterDefinition>	getParameters() Get the parameters property: List of the instance level parameter values for the user-defined topology parameters.
LivePipelineState	getState() Get the state property: Current pipeline state (read-only).
String	getTopologyName() Get the topologyName property: The reference to an existing pipeline topology defined for real-time content processing.
LivePipelineProperties	setDescription(String description) Set the description property: An optional description of the live pipeline.
LivePipelineProperties	setParameters(List<ParameterDefinition> parameters) Set the parameters property: List of the instance level parameter values for the user-defined topology parameters.
LivePipelineProperties	setState(LivePipelineState state) Set the state property: Current pipeline state (read-only).
LivePipelineProperties	setTopologyName(String topologyName) Set the topologyName property: The reference to an existing pipeline topology defined for real-time content processing.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LivePipelineProperties

public LivePipelineProperties()

Method Details

getDescription

public String getDescription()

Get the description property: An optional description of the live pipeline.

Returns:

the description value.

getParameters

public List getParameters()

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.

getState

public LivePipelineState getState()

Get the state property: Current pipeline state (read-only).

Returns:

the state value.

getTopologyName

public String getTopologyName()

Get the topologyName property: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.

Returns:

the topologyName value.

setDescription

public LivePipelineProperties setDescription(String description)

Set the description property: An optional description of the live pipeline.

Parameters:

description - the description value to set.

Returns:

the LivePipelineProperties object itself.

setParameters

public LivePipelineProperties setParameters(List 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 LivePipelineProperties object itself.

setState

public LivePipelineProperties setState(LivePipelineState state)

Set the state property: Current pipeline state (read-only).

Parameters:

state - the state value to set.

Returns:

the LivePipelineProperties object itself.

setTopologyName

public LivePipelineProperties setTopologyName(String topologyName)

Set the topologyName property: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.

Parameters:

topologyName - the topologyName value to set.

Returns:

the LivePipelineProperties object itself.

Azure SDK for Java

Legacy