Class CreateChannelRequest

    • Method Detail

      • channelGroupName

        public final String channelGroupName()

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

        Returns:
        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
      • channelName

        public final String channelName()

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.

        Returns:
        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.
      • clientToken

        public final String clientToken()

        A unique, case-sensitive token that you provide to ensure the idempotency of the request.

        Returns:
        A unique, case-sensitive token that you provide to ensure the idempotency of the request.
      • inputType

        public final InputType inputType()

        The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

        The allowed values are:

        • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

        • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

        If the service returns an enum value that is not available in the current SDK version, inputType will return InputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputTypeAsString().

        Returns:
        The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

        The allowed values are:

        • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

        • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

        See Also:
        InputType
      • inputTypeAsString

        public final String inputTypeAsString()

        The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

        The allowed values are:

        • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

        • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

        If the service returns an enum value that is not available in the current SDK version, inputType will return InputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputTypeAsString().

        Returns:
        The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

        The allowed values are:

        • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

        • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

        See Also:
        InputType
      • description

        public final String description()

        Enter any descriptive text that helps you to identify the channel.

        Returns:
        Enter any descriptive text that helps you to identify the channel.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final Map<String,​String> tags()

        A comma-separated list of tag key:value pairs that you define. For example:

        "Key1": "Value1",

        "Key2": "Value2"

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A comma-separated list of tag key:value pairs that you define. For example:

        "Key1": "Value1",

        "Key2": "Value2"

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object