Package software.amazon.awssdk.services.pcs.model

Class ClusterSummary

java.lang.Object

software.amazon.awssdk.services.pcs.model.ClusterSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClusterSummary.Builder,ClusterSummary>

@Generated("software.amazon.awssdk:codegen")
public final class ClusterSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClusterSummary.Builder,ClusterSummary>

The object returned by the ListClusters API action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClusterSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The unique Amazon Resource Name (ARN) of the cluster.
static ClusterSummary.Builder	builder()
Instant	createdAt()	The date and time the resource was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The generated unique ID of the cluster.
Instant	modifiedAt()	The date and time the resource was modified.
String	name()	The name that identifies the cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterSummary.Builder>	serializableBuilderClass()
ClusterStatus	status()	The provisioning status of the cluster.
String	statusAsString()	The provisioning status of the cluster.
ClusterSummary.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

name

public final String name()

The name that identifies the cluster.

Returns:

The name that identifies the cluster.

id

public final String id()

The generated unique ID of the cluster.

Returns:

The generated unique ID of the cluster.

arn

public final String arn()

The unique Amazon Resource Name (ARN) of the cluster.

Returns:

The unique Amazon Resource Name (ARN) of the cluster.

createdAt

public final Instant createdAt()

The date and time the resource was created.

Returns:

The date and time the resource was created.

modifiedAt

public final Instant modifiedAt()

The date and time the resource was modified.

Returns:

The date and time the resource was modified.

status

public final ClusterStatus status()

The provisioning status of the cluster.

The provisioning status doesn't indicate the overall health of the cluster.

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

Returns:

The provisioning status of the cluster.

The provisioning status doesn't indicate the overall health of the cluster.

See Also:

ClusterStatus

statusAsString

public final String statusAsString()

The provisioning status of the cluster.

The provisioning status doesn't indicate the overall health of the cluster.

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

Returns:

The provisioning status of the cluster.

The provisioning status doesn't indicate the overall health of the cluster.

See Also:

ClusterStatus

toBuilder

public ClusterSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterSummary.Builder,ClusterSummary>

builder

public static ClusterSummary.Builder builder()

serializableBuilderClass

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