Class ClusterMetadata
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClusterMetadata.Builder,
ClusterMetadata>
Contains metadata about a specific cluster.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The automatically generated ID for a specific address.static ClusterMetadata.Builder
builder()
final String
The automatically generated ID for a cluster.final ClusterState
The current status of the cluster.final String
The current status of the cluster.final Instant
The creation date for this cluster.final String
The optional description of the cluster.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final JobType
jobType()
The type of job for this cluster.final String
The type of job for this cluster.final String
TheKmsKeyARN
Amazon Resource Name (ARN) associated with this cluster.final Notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.final JobResource
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.final String
roleARN()
The role ARN associated with this cluster.static Class
<? extends ClusterMetadata.Builder> final ShippingOption
The shipping speed for each node in this cluster.final String
The shipping speed for each node in this cluster.final SnowballType
The type of Snowcone device to use for this cluster.final String
The type of Snowcone device to use for this cluster.final TaxDocuments
The tax documents required in your Amazon Web Services Region.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clusterId
The automatically generated ID for a cluster.
- Returns:
- The automatically generated ID for a cluster.
-
description
The optional description of the cluster.
- Returns:
- The optional description of the cluster.
-
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
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
The current status of the cluster.
If the service returns an enum value that is not available in the current SDK version,
clusterState
will returnClusterState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclusterStateAsString()
.- Returns:
- The current status of the cluster.
- See Also:
-
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 returnClusterState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclusterStateAsString()
.- Returns:
- The current status of the cluster.
- See Also:
-
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 returnJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
. - See Also:
-
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 returnJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
. - See Also:
-
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 returnSnowballType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsnowballTypeAsString()
.- 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:
-
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 returnSnowballType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsnowballTypeAsString()
.- 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:
-
creationDate
The creation date for this cluster.
- Returns:
- The creation date for this cluster.
-
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
The automatically generated ID for a specific address.
- Returns:
- The automatically generated ID for a specific address.
-
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 returnShippingOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromshippingOptionAsString()
.- 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:
-
-
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 returnShippingOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromshippingOptionAsString()
.- 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:
-
-
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
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
The tax documents required in your Amazon Web Services Region.
- Returns:
- The tax documents required in your Amazon Web Services Region.
-
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
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 interfaceToCopyableBuilder<ClusterMetadata.Builder,
ClusterMetadata> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-