Class KxAttachedCluster

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

The structure containing the metadata of the attached clusters.

See Also:

  • Method Details

    • clusterName

      public final String clusterName()

      A unique name for the attached cluster.

      Returns:
      A unique name for the attached cluster.

    • clusterType

      public final KxClusterType clusterType()

      Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.

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

      Returns:
      Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.
      See Also:

    • clusterTypeAsString

      public final String clusterTypeAsString()

      Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.

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

      Returns:
      Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.
      See Also:

    • clusterStatus

      public final KxClusterStatus clusterStatus()

      The status of the attached cluster.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

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

      Returns:
      The status of the attached cluster.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

      See Also:

    • clusterStatusAsString

      public final String clusterStatusAsString()

      The status of the attached cluster.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

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

      Returns:
      The status of the attached cluster.

      • PENDING – The cluster is pending creation.

      • CREATING – The cluster creation process is in progress.

      • CREATE_FAILED – The cluster creation process has failed.

      • RUNNING – The cluster creation process is running.

      • UPDATING – The cluster is in the process of being updated.

      • DELETING – The cluster is in the process of being deleted.

      • DELETED – The cluster has been deleted.

      • DELETE_FAILED – The cluster failed to delete.

      See Also:

    • toBuilder

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

    • builder

      public static KxAttachedCluster.Builder builder()

    • serializableBuilderClass

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