pulumi-azure-native-kotlin/com.pulumi.azurenative.videoanalyzer.kotlin.outputs/GetPipelineTopologyResult

GetPipelineTopologyResult

data class GetPipelineTopologyResult(val description: String? = null, val id: String, val kind: String, val name: String, val parameters: List<ParameterDeclarationResponse>? = null, val processors: List<EncoderProcessorResponse>? = null, val sinks: List<VideoSinkResponse>, val sku: SkuResponse, val sources: List<Either<RtspSourceResponse, VideoSourceResponse>>, val systemData: SystemDataResponse, val type: String)

Pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized. This allows individual pipelines refer to different values, such as individual cameras' RTSP endpoints and credentials. Overall a topology is composed of the following:

Parameters: list of user defined parameters that can be references across the topology nodes.
Sources: list of one or more data sources nodes such as an RTSP source which allows for content to be ingested from cameras.
Processors: list of nodes which perform data analysis or transformations.
Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations.

Constructors

constructor(description: String? = null, id: String, kind: String, name: String, parameters: List<ParameterDeclarationResponse>? = null, processors: List<EncoderProcessorResponse>? = null, sinks: List<VideoSinkResponse>, sku: SkuResponse, sources: List<Either<RtspSourceResponse, VideoSourceResponse>>, systemData: SystemDataResponse, type: String)

Types

Companion

object Companion

Properties

description

val description: String? = null

An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.

val id: String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

val kind: String

Topology kind.

name

val name: String

The name of the resource

parameters

val parameters: List<ParameterDeclarationResponse>? = null

List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.

processors

val processors: List<EncoderProcessorResponse>? = null

List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.

sinks

val sinks: List<VideoSinkResponse>

List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.

sku

val sku: SkuResponse

Describes the properties of a SKU.

sources

val sources: List<Either<RtspSourceResponse, VideoSourceResponse>>

List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.

systemData

val systemData: SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

val type: String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"