Class ChannelInfo

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

Summary information about a channel returned by ListChannels.

See Also:

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

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

    • creationTime

      public final Instant creationTime()

      The time when the channel was created.

      Returns:

      The time when the channel was created.

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

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

    • toBuilder

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

    • builder

      public static ChannelInfo.Builder builder()

    • serializableBuilderClass

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