Interface CreateRegistrationResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CreateRegistrationResponse.Builder,CreateRegistrationResponse>, PinpointSmsVoiceV2Response.Builder, SdkBuilder<CreateRegistrationResponse.Builder,CreateRegistrationResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CreateRegistrationResponse
@Mutable @NotThreadSafe public static interface CreateRegistrationResponse.Builder extends PinpointSmsVoiceV2Response.Builder, SdkPojo, CopyableBuilder<CreateRegistrationResponse.Builder,CreateRegistrationResponse>

  • Method Details

    • registrationArn

      CreateRegistrationResponse.Builder registrationArn(String registrationArn)

      The Amazon Resource Name (ARN) for the registration.

      Parameters:
      registrationArn - The Amazon Resource Name (ARN) for the registration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registrationId

      CreateRegistrationResponse.Builder registrationId(String registrationId)

      The unique identifier for the registration.

      Parameters:
      registrationId - The unique identifier for the registration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registrationType

      CreateRegistrationResponse.Builder registrationType(String registrationType)

      The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

      Parameters:
      registrationType - The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registrationStatus

      CreateRegistrationResponse.Builder registrationStatus(String registrationStatus)

      The status of the registration.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • CREATED: Your registration is created but not submitted.

      • COMPLETE: Your registration has been approved and your origination identity has been created.

      • DELETED: The registration has been deleted.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      Parameters:
      registrationStatus - The status of the registration.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • CREATED: Your registration is created but not submitted.

      • COMPLETE: Your registration has been approved and your origination identity has been created.

      • DELETED: The registration has been deleted.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • registrationStatus

      CreateRegistrationResponse.Builder registrationStatus(RegistrationStatus registrationStatus)

      The status of the registration.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • CREATED: Your registration is created but not submitted.

      • COMPLETE: Your registration has been approved and your origination identity has been created.

      • DELETED: The registration has been deleted.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      Parameters:
      registrationStatus - The status of the registration.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • CREATED: Your registration is created but not submitted.

      • COMPLETE: Your registration has been approved and your origination identity has been created.

      • DELETED: The registration has been deleted.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • currentVersionNumber

      CreateRegistrationResponse.Builder currentVersionNumber(Long currentVersionNumber)

      The current version number of the registration.

      Parameters:
      currentVersionNumber - The current version number of the registration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalAttributes

      CreateRegistrationResponse.Builder additionalAttributes(Map<String,String> additionalAttributes)

      Metadata about a given registration which is specific to that registration type.

      Parameters:
      additionalAttributes - Metadata about a given registration which is specific to that registration type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRegistrationResponse.Builder tags(Collection<Tag> tags)

      An array of tags (key and value pairs) to associate with the registration.

      Parameters:
      tags - An array of tags (key and value pairs) to associate with the registration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRegistrationResponse.Builder tags(Tag... tags)

      An array of tags (key and value pairs) to associate with the registration.

      Parameters:
      tags - An array of tags (key and value pairs) to associate with the registration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateRegistrationResponse.Builder tags(Consumer<Tag.Builder>... tags)

      An array of tags (key and value pairs) to associate with the registration.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdTimestamp

      CreateRegistrationResponse.Builder createdTimestamp(Instant createdTimestamp)

      The time when the registration was created, in UNIX epoch time format.

      Parameters:
      createdTimestamp - The time when the registration was created, in UNIX epoch time format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.