Class CreateChannelRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.medialive.model.MediaLiveRequest
software.amazon.awssdk.services.medialive.model.CreateChannelRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateChannelRequest extends MediaLiveRequest implements ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>
A request to create a channel

  • Method Details

    • cdiInputSpecification

      public final CdiInputSpecification cdiInputSpecification()
      Specification of CDI inputs for this channel
      Returns:
      Specification of CDI inputs for this channel

    • channelClass

      public final ChannelClass channelClass()
      The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

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

      Returns:
      The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
      See Also:

    • channelClassAsString

      public final String channelClassAsString()
      The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

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

      Returns:
      The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
      See Also:

    • hasDestinations

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

    • destinations

      public final List<OutputDestination> destinations()
      Returns the value of the Destinations 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 hasDestinations() method.

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

    • encoderSettings

      public final EncoderSettings encoderSettings()
      Returns the value of the EncoderSettings property for this object.
      Returns:
      The value of the EncoderSettings property for this object.

    • hasInputAttachments

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

    • inputAttachments

      public final List<InputAttachment> inputAttachments()
      List of input attachments for 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 hasInputAttachments() method.

      Returns:
      List of input attachments for channel.

    • inputSpecification

      public final InputSpecification inputSpecification()
      Specification of network and file inputs for this channel
      Returns:
      Specification of network and file inputs for this channel

    • logLevel

      public final LogLevel logLevel()
      The log level to write to CloudWatch Logs.

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

      Returns:
      The log level to write to CloudWatch Logs.
      See Also:

    • logLevelAsString

      public final String logLevelAsString()
      The log level to write to CloudWatch Logs.

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

      Returns:
      The log level to write to CloudWatch Logs.
      See Also:

    • maintenance

      public final MaintenanceCreateSettings maintenance()
      Maintenance settings for this channel.
      Returns:
      Maintenance settings for this channel.

    • name

      public final String name()
      Name of channel.
      Returns:
      Name of channel.

    • requestId

      public final String requestId()
      Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.
      Returns:
      Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.

    • reserved

      @Deprecated public final String reserved()
      Deprecated.
      Deprecated field that's only usable by whitelisted customers.
      Returns:
      Deprecated field that's only usable by whitelisted customers.

    • roleArn

      public final String roleArn()
      An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.
      Returns:
      An optional Amazon Resource Name (ARN) of the role to assume when running 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 collection of key-value pairs.

      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 collection of key-value pairs.

    • vpc

      public final VpcOutputSettings vpc()
      Settings for the VPC outputs
      Returns:
      Settings for the VPC outputs

    • anywhereSettings

      public final AnywhereSettings anywhereSettings()
      The Elemental Anywhere settings for this channel.
      Returns:
      The Elemental Anywhere settings for this channel.

    • toBuilder

      public CreateChannelRequest.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<CreateChannelRequest.Builder,CreateChannelRequest>
      Specified by:
      toBuilder in class MediaLiveRequest
      Returns:
      a builder for type T

    • builder

      public static CreateChannelRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.