Package software.amazon.awssdk.services.kafka.model

Class DescribeReplicatorResponse

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.DescribeReplicatorResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeReplicatorResponse.Builder,DescribeReplicatorResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeReplicatorResponse extends KafkaResponse implements ToCopyableBuilder<DescribeReplicatorResponse.Builder,DescribeReplicatorResponse>

  • Method Details

    • creationTime

      public final Instant creationTime()

      The time when the replicator was created.

      Returns:
      The time when the replicator was created.

    • currentVersion

      public final String currentVersion()

      The current version number of the replicator.

      Returns:
      The current version number of the replicator.

    • isReplicatorReference

      public final Boolean isReplicatorReference()

      Whether this resource is a replicator reference.

      Returns:
      Whether this resource is a replicator reference.

    • hasKafkaClusters

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

    • kafkaClusters

      public final List<KafkaClusterDescription> kafkaClusters()

      Kafka Clusters used in setting up sources / targets for replication.

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

      Returns:
      Kafka Clusters used in setting up sources / targets for replication.

    • hasReplicationInfoList

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

    • replicationInfoList

      public final List<ReplicationInfoDescription> replicationInfoList()

      A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

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

      Returns:
      A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

    • replicatorArn

      public final String replicatorArn()

      The Amazon Resource Name (ARN) of the replicator.

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

    • replicatorDescription

      public final String replicatorDescription()

      The description of the replicator.

      Returns:
      The description of the replicator.

    • replicatorName

      public final String replicatorName()

      The name of the replicator.

      Returns:
      The name of the replicator.

    • replicatorResourceArn

      public final String replicatorResourceArn()

      The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

      Returns:
      The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

    • replicatorState

      public final ReplicatorState replicatorState()

      State of the replicator.

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

      Returns:
      State of the replicator.
      See Also:

    • replicatorStateAsString

      public final String replicatorStateAsString()

      State of the replicator.

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

      Returns:
      State of the replicator.
      See Also:

    • serviceExecutionRoleArn

      public final String serviceExecutionRoleArn()

      The Amazon Resource Name (ARN) of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

      Returns:
      The Amazon Resource Name (ARN) of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

    • stateInfo

      public final ReplicationStateInfo stateInfo()

      Details about the state of the replicator.

      Returns:
      Details about the state of the replicator.

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

      List of tags attached to the Replicator.

      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:
      List of tags attached to the Replicator.

    • toBuilder

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

    • builder

      public static DescribeReplicatorResponse.Builder builder()

    • serializableBuilderClass

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