Class ClusterMetadata

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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<ClusterMetadata.Builder,ClusterMetadata>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.