java.lang.Object
- software.amazon.awssdk.services.pcs.model.Cluster

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>

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

The cluster resource and configuration.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Cluster.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The unique Amazon Resource Name (ARN) of the cluster.
`static Cluster.Builder`	`builder()`
`Instant`	`createdAt()`	The date and time the resource was created.
`List<Endpoint>`	`endpoints()`	The list of endpoints available for interaction with the scheduler.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ErrorInfo>`	`errorInfo()`	The list of errors that occurred during cluster provisioning.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEndpoints()`	For responses, this returns true if the service returned a value for the Endpoints property.
`boolean`	`hasErrorInfo()`	For responses, this returns true if the service returned a value for the ErrorInfo property.
`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.
`Networking`	`networking()`	Returns the value of the Networking property for this object.
`Scheduler`	`scheduler()`	Returns the value of the Scheduler property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Cluster.Builder>`	`serializableBuilderClass()`
`Size`	`size()`	The size of the cluster.
`String`	`sizeAsString()`	The size of the cluster.
`ClusterSlurmConfiguration`	`slurmConfiguration()`	Additional options related to the Slurm scheduler.
`ClusterStatus`	`status()`	The provisioning status of the cluster.
`String`	`statusAsString()`	The provisioning status of the cluster.
`Cluster.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.
  - 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
  - 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.
  - scheduler
```
public final Scheduler scheduler()
```
    Returns the value of the Scheduler property for this object.
    
    Returns:
    
    The value of the Scheduler property for this object.
  - size
```
public final Size size()
```
    The size of the cluster.
    
    SMALL: 32 compute nodes and 256 jobs
    
    MEDIUM: 512 compute nodes and 8192 jobs
    
    LARGE: 2048 compute nodes and 16,384 jobs
    
    If the service returns an enum value that is not available in the current SDK version, size will return Size.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sizeAsString().
    Returns:
    
    The size of the cluster.
    
    SMALL: 32 compute nodes and 256 jobs
    
    MEDIUM: 512 compute nodes and 8192 jobs
    
    LARGE: 2048 compute nodes and 16,384 jobs
    
    See Also:
    
    Size
  - sizeAsString
```
public final String sizeAsString()
```
    The size of the cluster.
    
    SMALL: 32 compute nodes and 256 jobs
    
    MEDIUM: 512 compute nodes and 8192 jobs
    
    LARGE: 2048 compute nodes and 16,384 jobs
    
    If the service returns an enum value that is not available in the current SDK version, size will return Size.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sizeAsString().
    Returns:
    
    The size of the cluster.
    
    SMALL: 32 compute nodes and 256 jobs
    
    MEDIUM: 512 compute nodes and 8192 jobs
    
    LARGE: 2048 compute nodes and 16,384 jobs
    
    See Also:
    
    Size
  - slurmConfiguration
```
public final ClusterSlurmConfiguration slurmConfiguration()
```
    Additional options related to the Slurm scheduler.
    
    Returns:
    
    Additional options related to the Slurm scheduler.
  - networking
```
public final Networking networking()
```
    Returns the value of the Networking property for this object.
    
    Returns:
    
    The value of the Networking property for this object.
  - hasEndpoints
```
public final boolean hasEndpoints()
```
    For responses, this returns true if the service returned a value for the Endpoints 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.
  - endpoints
```
public final List<Endpoint> endpoints()
```
    The list of endpoints available for interaction with the scheduler.
    
    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 hasEndpoints() method.
    
    Returns:
    
    The list of endpoints available for interaction with the scheduler.
  - hasErrorInfo
```
public final boolean hasErrorInfo()
```
    For responses, this returns true if the service returned a value for the ErrorInfo 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.
  - errorInfo
```
public final List<ErrorInfo> errorInfo()
```
    The list of errors that occurred during cluster provisioning.
    
    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 hasErrorInfo() method.
    
    Returns:
    
    The list of errors that occurred during cluster provisioning.
  - toBuilder
```
public Cluster.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
  - builder
```
public static Cluster.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Cluster.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

Class Cluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

id

arn

status

statusAsString

createdAt

modifiedAt

scheduler

size

sizeAsString

slurmConfiguration

networking

hasEndpoints

endpoints

hasErrorInfo

errorInfo

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields