Class DescribeChannelResponse

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

Contains the current configuration and state of a channel.

  • Method Details

    • channelArn

      public final String channelArn()

      The Amazon Resource Name (ARN) that uniquely identifies the channel.

      Returns:

      The Amazon Resource Name (ARN) that uniquely identifies the channel.

    • channelName

      public final String channelName()

      The name of the channel.

      Returns:
      The name of the channel.

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      The encryption configuration applied to the channel.

      Returns:
      The encryption configuration applied to the channel.

    • icebergDestinationConfiguration

      public final IcebergDestinationConfiguration icebergDestinationConfiguration()

      The Apache Iceberg destination for the channel, if configured.

      Returns:
      The Apache Iceberg destination for the channel, if configured.

    • s3DestinationConfiguration

      public final S3DestinationConfiguration s3DestinationConfiguration()

      The Amazon S3 destination for the channel, if configured.

      Returns:
      The Amazon S3 destination for the channel, if configured.

    • status

      public final ChannelStatus status()

      The current lifecycle state of the channel.

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

      Returns:
      The current lifecycle state of the channel.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current lifecycle state of the channel.

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

      Returns:
      The current lifecycle state of the channel.
      See Also:

    • destinationType

      public final ChannelDestinationType destinationType()

      The type of destination configured for the channel.

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

      Returns:
      The type of destination configured for the channel.
      See Also:

    • destinationTypeAsString

      public final String destinationTypeAsString()

      The type of destination configured for the channel.

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

      Returns:
      The type of destination configured for the channel.
      See Also:

    • creationTime

      public final Instant creationTime()

      The time when the channel was created.

      Returns:

      The time when the channel was created.

    • hasTopicConfigurationList

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

    • topicConfigurationList

      public final List<TopicConfiguration> topicConfigurationList()

      The list of topic configurations 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 hasTopicConfigurationList() method.

      Returns:
      The list of topic configurations for the channel.

    • loggingInfo

      public final ChannelLoggingInfo loggingInfo()

      The destinations to which the channel publishes operational logs.

      Returns:
      The destinations to which the channel publishes operational logs.

    • stateInfo

      public final ChannelStateInfo stateInfo()

      Additional context for the current channel state, populated when the channel is in FAILED.

      Returns:
      Additional context for the current channel state, populated when the channel is in FAILED.

    • clusterOperationArn

      public final String clusterOperationArn()

      The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

      Returns:
      The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

    • 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 tags attached 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 tags attached to the channel.

    • toBuilder

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

    • builder

      public static DescribeChannelResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeChannelResponse.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.