com.pulumi.azurenative.videoanalyzer.LivePipeline Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.videoanalyzer;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.videoanalyzer.LivePipelineArgs;
import com.pulumi.azurenative.videoanalyzer.outputs.ParameterDefinitionResponse;
import com.pulumi.azurenative.videoanalyzer.outputs.SystemDataResponse;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera.
* Azure REST API version: 2021-11-01-preview. Prior API version in Azure Native 1.x: 2021-11-01-preview.
*
* ## Example Usage
* ### Create or update a live pipeline
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.videoanalyzer.LivePipeline;
* import com.pulumi.azurenative.videoanalyzer.LivePipelineArgs;
* import com.pulumi.azurenative.videoanalyzer.inputs.ParameterDefinitionArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var livePipeline = new LivePipeline("livePipeline", LivePipelineArgs.builder()
* .accountName("testaccount2")
* .bitrateKbps(500)
* .description("Live Pipeline 1 Description")
* .livePipelineName("livePipeline1")
* .parameters(ParameterDefinitionArgs.builder()
* .name("rtspUrlParameter")
* .value("rtsp://contoso.com/stream")
* .build())
* .resourceGroupName("testrg")
* .topologyName("pipelinetopology1")
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:videoanalyzer:LivePipeline livePipeline1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName}
* ```
*
*/
@ResourceType(type="azure-native:videoanalyzer:LivePipeline")
public class LivePipeline extends com.pulumi.resources.CustomResource {
/**
* Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
*
*/
@Export(name="bitrateKbps", refs={Integer.class}, tree="[0]")
private Output bitrateKbps;
/**
* @return Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
*
*/
public Output bitrateKbps() {
return this.bitrateKbps;
}
/**
* An optional description for the pipeline.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return An optional description for the pipeline.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* The name of the resource
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the resource
*
*/
public Output name() {
return this.name;
}
/**
* 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.
*
*/
@Export(name="parameters", refs={List.class,ParameterDefinitionResponse.class}, tree="[0,1]")
private Output> parameters;
/**
* @return 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.
*
*/
public Output>> parameters() {
return Codegen.optional(this.parameters);
}
/**
* Current state of the pipeline (read-only).
*
*/
@Export(name="state", refs={String.class}, tree="[0]")
private Output state;
/**
* @return Current state of the pipeline (read-only).
*
*/
public Output state() {
return this.state;
}
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
@Export(name="systemData", refs={SystemDataResponse.class}, tree="[0]")
private Output systemData;
/**
* @return Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
public Output systemData() {
return this.systemData;
}
/**
* 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.
*
*/
@Export(name="topologyName", refs={String.class}, tree="[0]")
private Output topologyName;
/**
* @return 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.
*
*/
public Output topologyName() {
return this.topologyName;
}
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
public Output type() {
return this.type;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public LivePipeline(java.lang.String name) {
this(name, LivePipelineArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public LivePipeline(java.lang.String name, LivePipelineArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public LivePipeline(java.lang.String name, LivePipelineArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:videoanalyzer:LivePipeline", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private LivePipeline(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:videoanalyzer:LivePipeline", name, null, makeResourceOptions(options, id), false);
}
private static LivePipelineArgs makeArgs(LivePipelineArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? LivePipelineArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:videoanalyzer/v20211101preview:LivePipeline").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static LivePipeline get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new LivePipeline(name, id, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy