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

Class ListPhoneNumbersRequest

    • Method Detail

      • instanceId

        public final String instanceId()

        The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

        Returns:
        The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      • phoneNumberTypes

        public final List<PhoneNumberType> phoneNumberTypes()

        The type of phone number.

        We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.

        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.

        We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.

      • 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 the isEmpty() 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.

        We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.

        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.

        We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.

      • 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 the isEmpty() 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.

      • 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.

      • maxResults

        public final Integer maxResults()

        The maximum number of results to return per page. The default MaxResult size is 100.

        Returns:
        The maximum number of results to return per page. The default MaxResult size is 100.

      • 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