Package software.amazon.awssdk.services.connect.model

Interface ClaimedPhoneNumberSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ClaimedPhoneNumberSummary.Builder,ClaimedPhoneNumberSummary>, SdkBuilder<ClaimedPhoneNumberSummary.Builder,ClaimedPhoneNumberSummary>, SdkPojo
Enclosing class:
ClaimedPhoneNumberSummary
public static interface ClaimedPhoneNumberSummary.Builder extends SdkPojo, CopyableBuilder<ClaimedPhoneNumberSummary.Builder,ClaimedPhoneNumberSummary>

  • Method Details

    • phoneNumberId

      ClaimedPhoneNumberSummary.Builder phoneNumberId(String phoneNumberId)

      A unique identifier for the phone number.

      Parameters:
      phoneNumberId - A unique identifier for the phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumberArn

      ClaimedPhoneNumberSummary.Builder phoneNumberArn(String phoneNumberArn)

      The Amazon Resource Name (ARN) of the phone number.

      Parameters:
      phoneNumberArn - The Amazon Resource Name (ARN) of the phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumber

      ClaimedPhoneNumberSummary.Builder phoneNumber(String phoneNumber)

      The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

      Parameters:
      phoneNumber - The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumberCountryCode

      ClaimedPhoneNumberSummary.Builder phoneNumberCountryCode(String phoneNumberCountryCode)

      The ISO country code.

      Parameters:
      phoneNumberCountryCode - The ISO country code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • phoneNumberCountryCode

      ClaimedPhoneNumberSummary.Builder phoneNumberCountryCode(PhoneNumberCountryCode phoneNumberCountryCode)

      The ISO country code.

      Parameters:
      phoneNumberCountryCode - The ISO country code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • phoneNumberType

      ClaimedPhoneNumberSummary.Builder phoneNumberType(String phoneNumberType)

      The type of phone number.

      Parameters:
      phoneNumberType - The type of phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • phoneNumberType

      ClaimedPhoneNumberSummary.Builder phoneNumberType(PhoneNumberType phoneNumberType)

      The type of phone number.

      Parameters:
      phoneNumberType - The type of phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • phoneNumberDescription

      ClaimedPhoneNumberSummary.Builder phoneNumberDescription(String phoneNumberDescription)

      The description of the phone number.

      Parameters:
      phoneNumberDescription - The description of the phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetArn

      ClaimedPhoneNumberSummary.Builder targetArn(String targetArn)

      The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.

      Parameters:
      targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceId

      ClaimedPhoneNumberSummary.Builder instanceId(String instanceId)

      The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      Parameters:
      instanceId - The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      ClaimedPhoneNumberSummary.Builder tags(Map<String,String> tags)

      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

      Parameters:
      tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumberStatus

      ClaimedPhoneNumberSummary.Builder phoneNumberStatus(PhoneNumberStatus phoneNumberStatus)

      The status of the phone number.

      • CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

      • IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

      • FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

      You will not be billed for the phone number during the 1-day period if number claiming fails.

      Parameters:
      phoneNumberStatus - The status of the phone number.

      • CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

      • IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

      • FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

      You will not be billed for the phone number during the 1-day period if number claiming fails.

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

    • phoneNumberStatus

      default ClaimedPhoneNumberSummary.Builder phoneNumberStatus(Consumer<PhoneNumberStatus.Builder> phoneNumberStatus)

      The status of the phone number.

      • CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

      • IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

      • FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

      You will not be billed for the phone number during the 1-day period if number claiming fails.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to phoneNumberStatus(PhoneNumberStatus).

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

    • sourcePhoneNumberArn

      ClaimedPhoneNumberSummary.Builder sourcePhoneNumberArn(String sourcePhoneNumberArn)

      The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.

      Parameters:
      sourcePhoneNumberArn - The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.