Class ChannelDescription

java.lang.Object
software.amazon.awssdk.services.kinesis.model.ChannelDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ChannelDescription.Builder,ChannelDescription>
@Generated("software.amazon.awssdk:codegen") public final class ChannelDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ChannelDescription.Builder,ChannelDescription>

Describes the configuration and current status of a channel.

See Also:

  • Method Details

    • channelName

      public final String channelName()

      The name of the channel.

      Returns:
      The name of the channel.

    • channelARN

      public final String channelARN()

      The Amazon Resource Name (ARN) of the channel.

      Returns:
      The Amazon Resource Name (ARN) of the channel.

    • channelId

      public final String channelId()

      The unique identifier of the channel.

      Returns:
      The unique identifier of the channel.

    • channelStatus

      public final ChannelStatus channelStatus()

      The current status of the channel. Valid values:

      • CREATING - The channel is being created.

      • ACTIVE - The channel is ready to deliver records.

      • UPDATING - The channel configuration is being updated.

      • DELETING - The channel is being deleted.

      • FAILED - See ChannelStatusReason for the failure cause.

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

      Returns:
      The current status of the channel. Valid values:

      • CREATING - The channel is being created.

      • ACTIVE - The channel is ready to deliver records.

      • UPDATING - The channel configuration is being updated.

      • DELETING - The channel is being deleted.

      • FAILED - See ChannelStatusReason for the failure cause.

      See Also:

    • channelStatusAsString

      public final String channelStatusAsString()

      The current status of the channel. Valid values:

      • CREATING - The channel is being created.

      • ACTIVE - The channel is ready to deliver records.

      • UPDATING - The channel configuration is being updated.

      • DELETING - The channel is being deleted.

      • FAILED - See ChannelStatusReason for the failure cause.

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

      Returns:
      The current status of the channel. Valid values:

      • CREATING - The channel is being created.

      • ACTIVE - The channel is ready to deliver records.

      • UPDATING - The channel configuration is being updated.

      • DELETING - The channel is being deleted.

      • FAILED - See ChannelStatusReason for the failure cause.

      See Also:

    • channelStatusReason

      public final String channelStatusReason()

      A message describing the reason for a FAILED status.

      Returns:
      A message describing the reason for a FAILED status.

    • channelCreationTimestamp

      public final Instant channelCreationTimestamp()

      The time at which the channel was created.

      Returns:
      The time at which the channel was created.

    • serviceExecutionRoleARN

      public final String serviceExecutionRoleARN()

      The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

    • hasStreamConfigurationList

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

    • streamConfigurationList

      public final List<ChannelStreamDescription> streamConfigurationList()

      The source stream configuration for 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 hasStreamConfigurationList() method.

      Returns:
      The source stream configuration for the channel.

    • s3DestinationConfiguration

      public final S3DestinationDescription s3DestinationConfiguration()

      The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

      Returns:
      The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

    • s3TablesDestinationConfiguration

      public final S3TablesDestinationDescription s3TablesDestinationConfiguration()

      The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

      Returns:
      The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

    • encryptionConfiguration

      public final ChannelEncryptionConfiguration encryptionConfiguration()

      The server-side encryption configuration for the channel.

      Returns:
      The server-side encryption configuration for the channel.

    • loggingConfiguration

      public final ChannelLoggingConfiguration loggingConfiguration()

      The Amazon CloudWatch Logs configuration for the channel.

      Returns:
      The Amazon CloudWatch Logs configuration for the channel.

    • toBuilder

      public ChannelDescription.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<ChannelDescription.Builder,ChannelDescription>
      Returns:
      a builder for type T

    • builder

      public static ChannelDescription.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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