Class SupportedAssociation

java.lang.Object
software.amazon.awssdk.services.pinpointsmsvoicev2.model.SupportedAssociation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SupportedAssociation.Builder,SupportedAssociation>

@Generated("software.amazon.awssdk:codegen") public final class SupportedAssociation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SupportedAssociation.Builder,SupportedAssociation>

The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.

See Also:
  • Method Details

    • resourceType

      public final String resourceType()

      Defines the behavior of when an origination identity and registration can be associated with each other.

      Returns:
      Defines the behavior of when an origination identity and registration can be associated with each other.
    • isoCountryCode

      public final String isoCountryCode()

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

      Returns:
      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    • associationBehavior

      public final RegistrationAssociationBehavior associationBehavior()

      The association behavior.

      • ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.

      • ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.

      • ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.

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

      Returns:
      The association behavior.

      • ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.

      • ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.

      • ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.

      See Also:
    • associationBehaviorAsString

      public final String associationBehaviorAsString()

      The association behavior.

      • ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.

      • ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.

      • ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.

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

      Returns:
      The association behavior.

      • ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.

      • ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.

      • ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.

      See Also:
    • disassociationBehavior

      public final RegistrationDisassociationBehavior disassociationBehavior()

      The disassociation behavior.

      • DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.

      • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.

      • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.

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

      Returns:
      The disassociation behavior.

      • DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.

      • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.

      • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.

      See Also:
    • disassociationBehaviorAsString

      public final String disassociationBehaviorAsString()

      The disassociation behavior.

      • DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.

      • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.

      • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.

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

      Returns:
      The disassociation behavior.

      • DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.

      • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.

      • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.

      See Also:
    • toBuilder

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

      public static SupportedAssociation.Builder builder()
    • serializableBuilderClass

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