Class Address
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique ID for an address.static Address.Builder
builder()
final String
city()
The city in an address that a Snow device is to be delivered to.final String
company()
The name of the company to receive a Snow device at an address.final String
country()
The country in an address that a Snow device is to be delivered to.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
If the address you are creating is a primary address, then set this option to true.final String
landmark()
This field is no longer used and the value is ignored.final String
name()
The name of a person to receive a Snow device at an address.final String
The phone number associated with an address that a Snow device is to be delivered to.final String
The postal code in an address that a Snow device is to be delivered to.final String
This field is no longer used and the value is ignored.static Class
<? extends Address.Builder> final String
The state or province in an address that a Snow device is to be delivered to.final String
street1()
The first line in a street address that a Snow device is to be delivered to.final String
street2()
The second line in a street address that a Snow device is to be delivered to.final String
street3()
The third line in a street address that a Snow device is to be delivered to.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.final AddressType
type()
Differentiates between delivery address and pickup address in the customer account.final String
Differentiates between delivery address and pickup address in the customer account.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
addressId
The unique ID for an address.
- Returns:
- The unique ID for an address.
-
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
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
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
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
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
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
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
This field is no longer used and the value is ignored.
- Returns:
- This field is no longer used and the value is ignored.
-
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
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
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
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
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
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 returnAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Differentiates between delivery address and pickup address in the customer account. Provided at job creation.
- See Also:
-
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 returnAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Differentiates between delivery address and pickup address in the customer account. Provided at job creation.
- See Also:
-
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<Address.Builder,
Address> - 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
-