Class RegistrationInformation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RegistrationInformation.Builder,
RegistrationInformation>
Provides information about the requested registration.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionMetadata about a given registration which is specific to that registration type.final Long
The version number of the registration that was approved.builder()
final Instant
The time when the registration was created, in UNIX epoch time format.final Long
The current version number of the registration.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 boolean
For responses, this returns true if the service returned a value for the AdditionalAttributes property.final int
hashCode()
final Long
The latest version number of the registration that was denied.final String
The Amazon Resource Name (ARN) for the registration.final String
The unique identifier for the registration.final RegistrationStatus
The status of the registration.final String
The status of the registration.final String
The type of registration form.static Class
<? extends RegistrationInformation.Builder> 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
-
registrationArn
The Amazon Resource Name (ARN) for the registration.
- Returns:
- The Amazon Resource Name (ARN) for the registration.
-
registrationId
The unique identifier for the registration.
- Returns:
- The unique identifier for the registration.
-
registrationType
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
- Returns:
- The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
-
registrationStatus
The status of the registration.
-
CREATED
: Your registration is created but not submitted. -
SUBMITTED
: Your registration has been submitted and is awaiting review. -
REVIEWING
: Your registration has been accepted and is being reviewed. -
PROVISIONING
: Your registration has been approved and your origination identity is being created. -
COMPLETE
: Your registration has been approved and and your origination identity has been created. -
REQUIRES_UPDATES
: You must fix your registration and resubmit it. -
CLOSED
: The phone number or sender ID has been deleted and you must also delete the registration for the number. -
DELETED
: The registration has been deleted.
If the service returns an enum value that is not available in the current SDK version,
registrationStatus
will returnRegistrationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromregistrationStatusAsString()
.- Returns:
- The status of the registration.
-
CREATED
: Your registration is created but not submitted. -
SUBMITTED
: Your registration has been submitted and is awaiting review. -
REVIEWING
: Your registration has been accepted and is being reviewed. -
PROVISIONING
: Your registration has been approved and your origination identity is being created. -
COMPLETE
: Your registration has been approved and and your origination identity has been created. -
REQUIRES_UPDATES
: You must fix your registration and resubmit it. -
CLOSED
: The phone number or sender ID has been deleted and you must also delete the registration for the number. -
DELETED
: The registration has been deleted.
-
- See Also:
-
-
registrationStatusAsString
The status of the registration.
-
CREATED
: Your registration is created but not submitted. -
SUBMITTED
: Your registration has been submitted and is awaiting review. -
REVIEWING
: Your registration has been accepted and is being reviewed. -
PROVISIONING
: Your registration has been approved and your origination identity is being created. -
COMPLETE
: Your registration has been approved and and your origination identity has been created. -
REQUIRES_UPDATES
: You must fix your registration and resubmit it. -
CLOSED
: The phone number or sender ID has been deleted and you must also delete the registration for the number. -
DELETED
: The registration has been deleted.
If the service returns an enum value that is not available in the current SDK version,
registrationStatus
will returnRegistrationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromregistrationStatusAsString()
.- Returns:
- The status of the registration.
-
CREATED
: Your registration is created but not submitted. -
SUBMITTED
: Your registration has been submitted and is awaiting review. -
REVIEWING
: Your registration has been accepted and is being reviewed. -
PROVISIONING
: Your registration has been approved and your origination identity is being created. -
COMPLETE
: Your registration has been approved and and your origination identity has been created. -
REQUIRES_UPDATES
: You must fix your registration and resubmit it. -
CLOSED
: The phone number or sender ID has been deleted and you must also delete the registration for the number. -
DELETED
: The registration has been deleted.
-
- See Also:
-
-
currentVersionNumber
The current version number of the registration.
- Returns:
- The current version number of the registration.
-
approvedVersionNumber
The version number of the registration that was approved.
- Returns:
- The version number of the registration that was approved.
-
latestDeniedVersionNumber
The latest version number of the registration that was denied.
- Returns:
- The latest version number of the registration that was denied.
-
hasAdditionalAttributes
public final boolean hasAdditionalAttributes()For responses, this returns true if the service returned a value for the AdditionalAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
additionalAttributes
Metadata about a given registration which is specific to that registration type.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAdditionalAttributes()
method.- Returns:
- Metadata about a given registration which is specific to that registration type.
-
createdTimestamp
The time when the registration was created, in UNIX epoch time format.
- Returns:
- The time when the registration was created, in UNIX epoch time format.
-
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<RegistrationInformation.Builder,
RegistrationInformation> - 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
-