Interface RequestPhoneNumberResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<RequestPhoneNumberResponse.Builder,
,RequestPhoneNumberResponse> PinpointSmsVoiceV2Response.Builder
,SdkBuilder<RequestPhoneNumberResponse.Builder,
,RequestPhoneNumberResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
RequestPhoneNumberResponse
-
Method Summary
Modifier and TypeMethodDescriptioncreatedTimestamp
(Instant createdTimestamp) The time when the phone number was created, in UNIX epoch time format.deletionProtectionEnabled
(Boolean deletionProtectionEnabled) By default this is set to false.isoCountryCode
(String isoCountryCode) The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.messageType
(String messageType) The type of message.messageType
(MessageType messageType) The type of message.monthlyLeasingPrice
(String monthlyLeasingPrice) The monthly price, in US dollars, to lease the phone number.numberCapabilities
(Collection<NumberCapability> numberCapabilities) Indicates if the phone number will be used for text messages, voice messages or both.numberCapabilities
(NumberCapability... numberCapabilities) Indicates if the phone number will be used for text messages, voice messages or both.numberCapabilitiesWithStrings
(String... numberCapabilities) Indicates if the phone number will be used for text messages, voice messages or both.numberCapabilitiesWithStrings
(Collection<String> numberCapabilities) Indicates if the phone number will be used for text messages, voice messages or both.numberType
(String numberType) The type of number that was released.numberType
(RequestableNumberType numberType) The type of number that was released.optOutListName
(String optOutListName) The name of the OptOutList that is associated with the requested phone number.phoneNumber
(String phoneNumber) The new phone number that was requested.phoneNumberArn
(String phoneNumberArn) The Amazon Resource Name (ARN) of the requested phone number.phoneNumberId
(String phoneNumberId) The unique identifier of the new phone number.The unique identifier of the pool associated with the phone numberregistrationId
(String registrationId) The unique identifier for the registration.selfManagedOptOutsEnabled
(Boolean selfManagedOptOutsEnabled) By default this is set to false.The current status of the request.status
(NumberStatus status) The current status of the request.tags
(Collection<Tag> tags) An array of key and value pair tags that are associated with the phone number.tags
(Consumer<Tag.Builder>... tags) An array of key and value pair tags that are associated with the phone number.An array of key and value pair tags that are associated with the phone number.twoWayChannelArn
(String twoWayChannelArn) The ARN used to identify the two way channel.twoWayChannelRole
(String twoWayChannelRole) An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.twoWayEnabled
(Boolean twoWayEnabled) By default this is set to false.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
phoneNumberArn
The Amazon Resource Name (ARN) of the requested phone number.
- Parameters:
phoneNumberArn
- The Amazon Resource Name (ARN) of the requested phone number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
phoneNumberId
The unique identifier of the new phone number.
- Parameters:
phoneNumberId
- The unique identifier of the new phone number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
phoneNumber
The new phone number that was requested.
- Parameters:
phoneNumber
- The new phone number that was requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The current status of the request.
- Parameters:
status
- The current status of the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The current status of the request.
- Parameters:
status
- The current status of the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- Parameters:
isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageType
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- Parameters:
messageType
- The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
messageType
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
- Parameters:
messageType
- The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
numberCapabilitiesWithStrings
RequestPhoneNumberResponse.Builder numberCapabilitiesWithStrings(Collection<String> numberCapabilities) Indicates if the phone number will be used for text messages, voice messages or both.
- Parameters:
numberCapabilities
- Indicates if the phone number will be used for text messages, voice messages or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numberCapabilitiesWithStrings
Indicates if the phone number will be used for text messages, voice messages or both.
- Parameters:
numberCapabilities
- Indicates if the phone number will be used for text messages, voice messages or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numberCapabilities
RequestPhoneNumberResponse.Builder numberCapabilities(Collection<NumberCapability> numberCapabilities) Indicates if the phone number will be used for text messages, voice messages or both.
- Parameters:
numberCapabilities
- Indicates if the phone number will be used for text messages, voice messages or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numberCapabilities
Indicates if the phone number will be used for text messages, voice messages or both.
- Parameters:
numberCapabilities
- Indicates if the phone number will be used for text messages, voice messages or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
numberType
The type of number that was released.
- Parameters:
numberType
- The type of number that was released.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
numberType
The type of number that was released.
- Parameters:
numberType
- The type of number that was released.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
monthlyLeasingPrice
The monthly price, in US dollars, to lease the phone number.
- Parameters:
monthlyLeasingPrice
- The monthly price, in US dollars, to lease the phone number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- Parameters:
twoWayEnabled
- By default this is set to false. When set to true you can receive incoming text messages from your end recipients.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
twoWayChannelArn
The ARN used to identify the two way channel.
- Parameters:
twoWayChannelArn
- The ARN used to identify the two way channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
twoWayChannelRole
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- Parameters:
twoWayChannelRole
- An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
selfManagedOptOutsEnabled
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- Parameters:
selfManagedOptOutsEnabled
- By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
optOutListName
The name of the OptOutList that is associated with the requested phone number.
- Parameters:
optOutListName
- The name of the OptOutList that is associated with the requested phone number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deletionProtectionEnabled
By default this is set to false. When set to true the phone number can't be deleted.
- Parameters:
deletionProtectionEnabled
- By default this is set to false. When set to true the phone number can't be deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
poolId
The unique identifier of the pool associated with the phone number
- Parameters:
poolId
- The unique identifier of the pool associated with the phone number- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
tags
An array of key and value pair tags that are associated with the phone number.
- Parameters:
tags
- An array of key and value pair tags that are associated with the phone number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key and value pair tags that are associated with the phone number.
- Parameters:
tags
- An array of key and value pair tags that are associated with the phone number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key and value pair tags that are associated with the phone number.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdTimestamp
The time when the phone number was created, in UNIX epoch time format.
- Parameters:
createdTimestamp
- The time when the phone number was created, in UNIX epoch time format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-