Class DescribePoolsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request
software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePoolsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribePoolsRequest.Builder,DescribePoolsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribePoolsRequest extends PinpointSmsVoiceV2Request implements ToCopyableBuilder<DescribePoolsRequest.Builder,DescribePoolsRequest>

  • Method Details

    • hasPoolIds

      public final boolean hasPoolIds()
      For responses, this returns true if the service returned a value for the PoolIds 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.

    • poolIds

      public final List<String> poolIds()

      The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      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 hasPoolIds() method.

      Returns:
      The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    • hasFilters

      public final boolean hasFilters()
      For responses, this returns true if the service returned a value for the Filters 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.

    • filters

      public final List<PoolFilter> filters()

      An array of PoolFilter objects to filter the results.

      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 hasFilters() method.

      Returns:
      An array of PoolFilter objects to filter the results.

    • nextToken

      public final String nextToken()

      The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

      Returns:
      The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return per each request.

      Returns:
      The maximum number of results to return per each request.

    • owner

      public final Owner owner()

      Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.

      If the service returns an enum value that is not available in the current SDK version, owner will return Owner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownerAsString().

      Returns:
      Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.
      See Also:

    • ownerAsString

      public final String ownerAsString()

      Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.

      If the service returns an enum value that is not available in the current SDK version, owner will return Owner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownerAsString().

      Returns:
      Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.
      See Also:

    • toBuilder

      public DescribePoolsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribePoolsRequest.Builder,DescribePoolsRequest>
      Specified by:
      toBuilder in class PinpointSmsVoiceV2Request
      Returns:
      a builder for type T

    • builder

      public static DescribePoolsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribePoolsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.