Class ListPhoneNumbersV2Request
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.connect.model.ConnectRequest
-
- software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListPhoneNumbersV2Request.Builder,ListPhoneNumbersV2Request>
@Generated("software.amazon.awssdk:codegen") public final class ListPhoneNumbersV2Request extends ConnectRequest implements ToCopyableBuilder<ListPhoneNumbersV2Request.Builder,ListPhoneNumbersV2Request>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListPhoneNumbersV2Request.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListPhoneNumbersV2Request.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasPhoneNumberCountryCodes()For responses, this returns true if the service returned a value for the PhoneNumberCountryCodes property.booleanhasPhoneNumberTypes()For responses, this returns true if the service returned a value for the PhoneNumberTypes property.StringinstanceId()The identifier of the Amazon Connect instance that phone numbers are claimed to.IntegermaxResults()The maximum number of results to return per page.StringnextToken()The token for the next set of results.List<PhoneNumberCountryCode>phoneNumberCountryCodes()The ISO country code.List<String>phoneNumberCountryCodesAsStrings()The ISO country code.StringphoneNumberPrefix()The prefix of the phone number.List<PhoneNumberType>phoneNumberTypes()The type of phone number.List<String>phoneNumberTypesAsStrings()The type of phone number.List<SdkField<?>>sdkFields()static Class<? extends ListPhoneNumbersV2Request.Builder>serializableBuilderClass()StringtargetArn()The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.ListPhoneNumbersV2Request.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
targetArn
public final String targetArn()
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both
TargetArnandInstanceIdinput are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.- Returns:
- The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone
number inbound traffic is routed through. If both
TargetArnandInstanceIdinput are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
-
instanceId
public final 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. If both
TargetArnandInstanceIdare not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.- Returns:
- 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. If both
TargetArnandInstanceIdare not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.
-
maxResults
public final Integer maxResults()
The maximum number of results to return per page.
- Returns:
- The maximum number of results to return per page.
-
nextToken
public final String nextToken()
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- Returns:
- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
-
phoneNumberCountryCodes
public final List<PhoneNumberCountryCode> phoneNumberCountryCodes()
The ISO country code.
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
hasPhoneNumberCountryCodes()method.- Returns:
- The ISO country code.
-
hasPhoneNumberCountryCodes
public final boolean hasPhoneNumberCountryCodes()
For responses, this returns true if the service returned a value for the PhoneNumberCountryCodes 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.
-
phoneNumberCountryCodesAsStrings
public final List<String> phoneNumberCountryCodesAsStrings()
The ISO country code.
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
hasPhoneNumberCountryCodes()method.- Returns:
- The ISO country code.
-
phoneNumberTypes
public final List<PhoneNumberType> phoneNumberTypes()
The type of phone number.
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
hasPhoneNumberTypes()method.- Returns:
- The type of phone number.
-
hasPhoneNumberTypes
public final boolean hasPhoneNumberTypes()
For responses, this returns true if the service returned a value for the PhoneNumberTypes 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.
-
phoneNumberTypesAsStrings
public final List<String> phoneNumberTypesAsStrings()
The type of phone number.
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
hasPhoneNumberTypes()method.- Returns:
- The type of phone number.
-
phoneNumberPrefix
public final String phoneNumberPrefix()
The prefix of the phone number. If provided, it must contain
+as part of the country code.- Returns:
- The prefix of the phone number. If provided, it must contain
+as part of the country code.
-
toBuilder
public ListPhoneNumbersV2Request.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListPhoneNumbersV2Request.Builder,ListPhoneNumbersV2Request>- Specified by:
toBuilderin classConnectRequest
-
builder
public static ListPhoneNumbersV2Request.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListPhoneNumbersV2Request.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-