com.pulumi.azurenative.media.inputs.TextTrackArgs 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
A native Pulumi package for creating and managing Azure resources.
There is a newer version: 2.78.0
// *** 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.media.inputs;

import com.pulumi.azurenative.media.enums.Visibility;
import com.pulumi.azurenative.media.inputs.HlsSettingsArgs;
import com.pulumi.core.Either;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.core.internal.Codegen;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


/**
 * Represents a text track in an asset. A text track is usually used for sparse data related to the audio or video tracks.
 * 
 */
public final class TextTrackArgs extends com.pulumi.resources.ResourceArgs {

    public static final TextTrackArgs Empty = new TextTrackArgs();

    /**
     * The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.
     * 
     */
    @Import(name="displayName")
    private @Nullable Output displayName;

    /**
     * @return The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.
     * 
     */
    public Optional> displayName() {
        return Optional.ofNullable(this.displayName);
    }

    /**
     * The file name to the source file. This file is located in the storage container of the asset.
     * 
     */
    @Import(name="fileName")
    private @Nullable Output fileName;

    /**
     * @return The file name to the source file. This file is located in the storage container of the asset.
     * 
     */
    public Optional> fileName() {
        return Optional.ofNullable(this.fileName);
    }

    /**
     * The HLS specific setting for the text track.
     * 
     */
    @Import(name="hlsSettings")
    private @Nullable Output hlsSettings;

    /**
     * @return The HLS specific setting for the text track.
     * 
     */
    public Optional> hlsSettings() {
        return Optional.ofNullable(this.hlsSettings);
    }

    /**
     * The discriminator for derived types.
     * Expected value is '#Microsoft.Media.TextTrack'.
     * 
     */
    @Import(name="odataType", required=true)
    private Output odataType;

    /**
     * @return The discriminator for derived types.
     * Expected value is '#Microsoft.Media.TextTrack'.
     * 
     */
    public Output odataType() {
        return this.odataType;
    }

    /**
     * When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible".
     * 
     */
    @Import(name="playerVisibility")
    private @Nullable Output> playerVisibility;

    /**
     * @return When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible".
     * 
     */
    public Optional>> playerVisibility() {
        return Optional.ofNullable(this.playerVisibility);
    }

    private TextTrackArgs() {}

    private TextTrackArgs(TextTrackArgs $) {
        this.displayName = $.displayName;
        this.fileName = $.fileName;
        this.hlsSettings = $.hlsSettings;
        this.odataType = $.odataType;
        this.playerVisibility = $.playerVisibility;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(TextTrackArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private TextTrackArgs $;

        public Builder() {
            $ = new TextTrackArgs();
        }

        public Builder(TextTrackArgs defaults) {
            $ = new TextTrackArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param displayName The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.
         * 
         * @return builder
         * 
         */
        public Builder displayName(@Nullable Output displayName) {
            $.displayName = displayName;
            return this;
        }

        /**
         * @param displayName The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.
         * 
         * @return builder
         * 
         */
        public Builder displayName(String displayName) {
            return displayName(Output.of(displayName));
        }

        /**
         * @param fileName The file name to the source file. This file is located in the storage container of the asset.
         * 
         * @return builder
         * 
         */
        public Builder fileName(@Nullable Output fileName) {
            $.fileName = fileName;
            return this;
        }

        /**
         * @param fileName The file name to the source file. This file is located in the storage container of the asset.
         * 
         * @return builder
         * 
         */
        public Builder fileName(String fileName) {
            return fileName(Output.of(fileName));
        }

        /**
         * @param hlsSettings The HLS specific setting for the text track.
         * 
         * @return builder
         * 
         */
        public Builder hlsSettings(@Nullable Output hlsSettings) {
            $.hlsSettings = hlsSettings;
            return this;
        }

        /**
         * @param hlsSettings The HLS specific setting for the text track.
         * 
         * @return builder
         * 
         */
        public Builder hlsSettings(HlsSettingsArgs hlsSettings) {
            return hlsSettings(Output.of(hlsSettings));
        }

        /**
         * @param odataType The discriminator for derived types.
         * Expected value is '#Microsoft.Media.TextTrack'.
         * 
         * @return builder
         * 
         */
        public Builder odataType(Output odataType) {
            $.odataType = odataType;
            return this;
        }

        /**
         * @param odataType The discriminator for derived types.
         * Expected value is '#Microsoft.Media.TextTrack'.
         * 
         * @return builder
         * 
         */
        public Builder odataType(String odataType) {
            return odataType(Output.of(odataType));
        }

        /**
         * @param playerVisibility When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible".
         * 
         * @return builder
         * 
         */
        public Builder playerVisibility(@Nullable Output> playerVisibility) {
            $.playerVisibility = playerVisibility;
            return this;
        }

        /**
         * @param playerVisibility When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible".
         * 
         * @return builder
         * 
         */
        public Builder playerVisibility(Either playerVisibility) {
            return playerVisibility(Output.of(playerVisibility));
        }

        /**
         * @param playerVisibility When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible".
         * 
         * @return builder
         * 
         */
        public Builder playerVisibility(String playerVisibility) {
            return playerVisibility(Either.ofLeft(playerVisibility));
        }

        /**
         * @param playerVisibility When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible".
         * 
         * @return builder
         * 
         */
        public Builder playerVisibility(Visibility playerVisibility) {
            return playerVisibility(Either.ofRight(playerVisibility));
        }

        public TextTrackArgs build() {
            $.odataType = Codegen.stringProp("odataType").output().arg($.odataType).require();
            return $;
        }
    }

}