Package software.amazon.awssdk.services.finspace.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KxAttachedCluster.Builder

Method Summary

Modifier and Type	Method	Description
static KxAttachedCluster.Builder	builder()
String	clusterName()	A unique name for the attached cluster.
KxClusterStatus	clusterStatus()	The status of the attached cluster.
String	clusterStatusAsString()	The status of the attached cluster.
KxClusterType	clusterType()	Specifies the type of cluster.
String	clusterTypeAsString()	Specifies the type of cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends KxAttachedCluster.Builder>	serializableBuilderClass()
KxAttachedCluster.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

KxClusterType

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:

KxClusterType

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:

KxClusterStatus

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:

KxClusterStatus

toBuilder

public KxAttachedCluster.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KxAttachedCluster.Builder,KxAttachedCluster>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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