Class Address

java.lang.Object
software.amazon.awssdk.services.snowball.model.Address
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Address.Builder,Address>
@Generated("software.amazon.awssdk:codegen") public final class Address extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Address.Builder,Address>

The address that you want the Snow device(s) associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.

See Also:

  • Method Details

    • addressId

      public final String addressId()

      The unique ID for an address.

      Returns:
      The unique ID for an address.

    • name

      public final String name()

      The name of a person to receive a Snow device at an address.

      Returns:
      The name of a person to receive a Snow device at an address.

    • company

      public final String company()

      The name of the company to receive a Snow device at an address.

      Returns:
      The name of the company to receive a Snow device at an address.

    • street1

      public final String street1()

      The first line in a street address that a Snow device is to be delivered to.

      Returns:
      The first line in a street address that a Snow device is to be delivered to.

    • street2

      public final String street2()

      The second line in a street address that a Snow device is to be delivered to.

      Returns:
      The second line in a street address that a Snow device is to be delivered to.

    • street3

      public final String street3()

      The third line in a street address that a Snow device is to be delivered to.

      Returns:
      The third line in a street address that a Snow device is to be delivered to.

    • city

      public final String city()

      The city in an address that a Snow device is to be delivered to.

      Returns:
      The city in an address that a Snow device is to be delivered to.

    • stateOrProvince

      public final String stateOrProvince()

      The state or province in an address that a Snow device is to be delivered to.

      Returns:
      The state or province in an address that a Snow device is to be delivered to.

    • prefectureOrDistrict

      public final String prefectureOrDistrict()

      This field is no longer used and the value is ignored.

      Returns:
      This field is no longer used and the value is ignored.

    • landmark

      public final String landmark()

      This field is no longer used and the value is ignored.

      Returns:
      This field is no longer used and the value is ignored.

    • country

      public final String country()

      The country in an address that a Snow device is to be delivered to.

      Returns:
      The country in an address that a Snow device is to be delivered to.

    • postalCode

      public final String postalCode()

      The postal code in an address that a Snow device is to be delivered to.

      Returns:
      The postal code in an address that a Snow device is to be delivered to.

    • phoneNumber

      public final String phoneNumber()

      The phone number associated with an address that a Snow device is to be delivered to.

      Returns:
      The phone number associated with an address that a Snow device is to be delivered to.

    • isRestricted

      public final Boolean isRestricted()

      If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

      Returns:
      If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

    • type

      public final AddressType type()

      Differentiates between delivery address and pickup address in the customer account. Provided at job creation.

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

      Returns:
      Differentiates between delivery address and pickup address in the customer account. Provided at job creation.
      See Also:

    • typeAsString

      public final String typeAsString()

      Differentiates between delivery address and pickup address in the customer account. Provided at job creation.

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

      Returns:
      Differentiates between delivery address and pickup address in the customer account. Provided at job creation.
      See Also:

    • toBuilder

      public Address.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<Address.Builder,Address>
      Returns:
      a builder for type T

    • builder

      public static Address.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.