java.lang.Object
- software.amazon.awssdk.services.snowball.model.ClusterMetadata

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

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

Contains metadata about a specific cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ClusterMetadata.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`addressId()`	The automatically generated ID for a specific address.
`static ClusterMetadata.Builder`	`builder()`
`String`	`clusterId()`	The automatically generated ID for a cluster.
`ClusterState`	`clusterState()`	The current status of the cluster.
`String`	`clusterStateAsString()`	The current status of the cluster.
`Instant`	`creationDate()`	The creation date for this cluster.
`String`	`description()`	The optional description of the cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`forwardingAddressId()`	The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`JobType`	`jobType()`	The type of job for this cluster.
`String`	`jobTypeAsString()`	The type of job for this cluster.
`String`	`kmsKeyARN()`	The `KmsKeyARN` Amazon Resource Name (ARN) associated with this cluster.
`Notification`	`notification()`	The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
`OnDeviceServiceConfiguration`	`onDeviceServiceConfiguration()`	Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
`JobResource`	`resources()`	The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
`String`	`roleARN()`	The role ARN associated with this cluster.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ClusterMetadata.Builder>`	`serializableBuilderClass()`
`ShippingOption`	`shippingOption()`	The shipping speed for each node in this cluster.
`String`	`shippingOptionAsString()`	The shipping speed for each node in this cluster.
`SnowballType`	`snowballType()`	The type of Snowcone device to use for this cluster.
`String`	`snowballTypeAsString()`	The type of Snowcone device to use for this cluster.
`TaxDocuments`	`taxDocuments()`	The tax documents required in your Amazon Web Services Region.
`ClusterMetadata.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
  - clusterId
```
public final String clusterId()
```
    The automatically generated ID for a cluster.
    
    Returns:
    
    The automatically generated ID for a cluster.
  - description
```
public final String description()
```
    The optional description of the cluster.
    
    Returns:
    
    The optional description of the cluster.
  - kmsKeyARN
```
public final String kmsKeyARN()
```
    The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.
    
    Returns:
    
    The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.
  - roleARN
```
public final String roleARN()
```
    The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
    
    Returns:
    
    The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
  - clusterState
```
public final ClusterState clusterState()
```
    The current status of the cluster.
    
    If the service returns an enum value that is not available in the current SDK version, clusterState will return ClusterState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterStateAsString().
    
    Returns:
    
    The current status of the cluster.
    
    See Also:
    
    ClusterState
  - clusterStateAsString
```
public final String clusterStateAsString()
```
    The current status of the cluster.
    
    If the service returns an enum value that is not available in the current SDK version, clusterState will return ClusterState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterStateAsString().
    
    Returns:
    
    The current status of the cluster.
    
    See Also:
    
    ClusterState
  - jobType
```
public final JobType jobType()
```
    The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
    
    If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().
    
    Returns:
    
    The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
    
    See Also:
    
    JobType
  - jobTypeAsString
```
public final String jobTypeAsString()
```
    The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
    
    If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().
    
    Returns:
    
    The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
    
    See Also:
    
    JobType
  - snowballType
```
public final SnowballType snowballType()
```
    The type of Snowcone device to use for this cluster.
    
    For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
    
    If the service returns an enum value that is not available in the current SDK version, snowballType will return SnowballType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballTypeAsString().
    
    Returns:
    
    The type of Snowcone device to use for this cluster.
    
    For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
    
    See Also:
    
    SnowballType
  - snowballTypeAsString
```
public final String snowballTypeAsString()
```
    The type of Snowcone device to use for this cluster.
    
    For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
    
    If the service returns an enum value that is not available in the current SDK version, snowballType will return SnowballType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballTypeAsString().
    
    Returns:
    
    The type of Snowcone device to use for this cluster.
    
    For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
    
    See Also:
    
    SnowballType
  - creationDate
```
public final Instant creationDate()
```
    The creation date for this cluster.
    
    Returns:
    
    The creation date for this cluster.
  - resources
```
public final JobResource resources()
```
    The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
    
    Returns:
    
    The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
  - addressId
```
public final String addressId()
```
    The automatically generated ID for a specific address.
    
    Returns:
    
    The automatically generated ID for a specific address.
  - shippingOption
```
public final ShippingOption shippingOption()
```
    The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
    
    In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
    
    In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
    
    In India, Snow devices are delivered in one to seven days.
    
    In the US, you have access to one-day shipping and two-day shipping.
    
    If the service returns an enum value that is not available in the current SDK version, shippingOption will return ShippingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shippingOptionAsString().
    Returns:
    
    The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
    
    In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
    
    In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
    
    In India, Snow devices are delivered in one to seven days.
    
    In the US, you have access to one-day shipping and two-day shipping.
    
    See Also:
    
    ShippingOption
  - shippingOptionAsString
```
public final String shippingOptionAsString()
```
    The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
    
    In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
    
    In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
    
    In India, Snow devices are delivered in one to seven days.
    
    In the US, you have access to one-day shipping and two-day shipping.
    
    If the service returns an enum value that is not available in the current SDK version, shippingOption will return ShippingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shippingOptionAsString().
    Returns:
    
    The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
    
    In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
    
    In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
    
    In India, Snow devices are delivered in one to seven days.
    
    In the US, you have access to one-day shipping and two-day shipping.
    
    See Also:
    
    ShippingOption
  - notification
```
public final Notification notification()
```
    The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
    
    Returns:
    
    The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
  - forwardingAddressId
```
public final String forwardingAddressId()
```
    The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
    
    Returns:
    
    The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
  - taxDocuments
```
public final TaxDocuments taxDocuments()
```
    The tax documents required in your Amazon Web Services Region.
    
    Returns:
    
    The tax documents required in your Amazon Web Services Region.
  - onDeviceServiceConfiguration
```
public final OnDeviceServiceConfiguration onDeviceServiceConfiguration()
```
    Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
    
    Returns:
    
    Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
  - toBuilder
```
public ClusterMetadata.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ClusterMetadata.Builder,ClusterMetadata>
  - builder
```
public static ClusterMetadata.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ClusterMetadata.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 ClusterMetadata

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

clusterId

description

kmsKeyARN

roleARN

clusterState

clusterStateAsString

jobType

jobTypeAsString

snowballType

snowballTypeAsString

creationDate

resources

addressId

shippingOption

shippingOptionAsString

notification

forwardingAddressId

taxDocuments

onDeviceServiceConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields