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

Class ClusterOperationInfo

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

Returns information about a cluster operation.

See Also:

  • Method Details

    • clientRequestId

      public final String clientRequestId()

      The ID of the API request that triggered this operation.

      Returns:

      The ID of the API request that triggered this operation.

    • clusterArn

      public final String clusterArn()

      ARN of the cluster.

      Returns:

      ARN of the cluster.

    • creationTime

      public final Instant creationTime()

      The time that the operation was created.

      Returns:

      The time that the operation was created.

    • endTime

      public final Instant endTime()

      The time at which the operation finished.

      Returns:

      The time at which the operation finished.

    • errorInfo

      public final ErrorInfo errorInfo()

      Describes the error if the operation fails.

      Returns:

      Describes the error if the operation fails.

    • operationArn

      public final String operationArn()

      ARN of the cluster operation.

      Returns:

      ARN of the cluster operation.

    • operationState

      public final String operationState()

      State of the cluster operation.

      Returns:

      State of the cluster operation.

    • hasOperationSteps

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

    • operationSteps

      public final List<ClusterOperationStep> operationSteps()

      Steps completed during the operation.

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

      Returns:

      Steps completed during the operation.

    • operationType

      public final String operationType()

      Type of the cluster operation.

      Returns:

      Type of the cluster operation.

    • sourceClusterInfo

      public final MutableClusterInfo sourceClusterInfo()

      Information about cluster attributes before a cluster is updated.

      Returns:

      Information about cluster attributes before a cluster is updated.

    • targetClusterInfo

      public final MutableClusterInfo targetClusterInfo()

      Information about cluster attributes after a cluster is updated.

      Returns:

      Information about cluster attributes after a cluster is updated.

    • vpcConnectionInfo

      public final VpcConnectionInfo vpcConnectionInfo()

      Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

      Returns:

      Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

    • toBuilder

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

    • builder

      public static ClusterOperationInfo.Builder builder()

    • serializableBuilderClass

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