Class CreateChannelResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.mediapackagev2.model.MediaPackageV2Response
software.amazon.awssdk.services.mediapackagev2.model.CreateChannelResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateChannelResponse.Builder,CreateChannelResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateChannelResponse extends MediaPackageV2Response implements ToCopyableBuilder<CreateChannelResponse.Builder,CreateChannelResponse>

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) associated with the resource.

      Returns:
      The Amazon Resource Name (ARN) associated with the resource.

    • 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.

      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.

    • 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.

    • createdAt

      public final Instant createdAt()

      The date and time the channel was created.

      Returns:
      The date and time the channel was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time the channel was modified.

      Returns:
      The date and time the channel was modified.

    • description

      public final String description()

      The description for your channel.

      Returns:
      The description for your channel.

    • hasIngestEndpoints

      public final boolean hasIngestEndpoints()
      For responses, this returns true if the service returned a value for the IngestEndpoints 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.

    • ingestEndpoints

      public final List<IngestEndpoint> ingestEndpoints()
      Returns the value of the IngestEndpoints property for this object.

      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 hasIngestEndpoints() method.

      Returns:
      The value of the IngestEndpoints property for this object.

    • 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:

    • 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:

    • eTag

      public final String eTag()

      The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      Returns:
      The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

    • 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()

      The comma-separated list of tag key:value pairs assigned to the channel.

      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:
      The comma-separated list of tag key:value pairs assigned to the channel.

    • inputSwitchConfiguration

      public final InputSwitchConfiguration inputSwitchConfiguration()

      The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.

      Returns:
      The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.

    • outputHeaderConfiguration

      public final OutputHeaderConfiguration outputHeaderConfiguration()

      The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.

      Returns:
      The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.

    • toBuilder

      public CreateChannelResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateChannelResponse.Builder,CreateChannelResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateChannelResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateChannelResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.