Class ListDomainsRequest

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

The ListDomains request includes the following elements.

  • Method Details

    • hasFilterConditions

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

    • filterConditions

      public final List<FilterCondition> filterConditions()

      A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can include domain name and domain expiration.

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

      Returns:
      A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can include domain name and domain expiration.

    • sortCondition

      public final SortCondition sortCondition()

      A complex type that contains information about the requested ordering of domains in the returned list.

      Returns:
      A complex type that contains information about the requested ordering of domains in the returned list.

    • marker

      public final String marker()

      For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current Amazon Web Services account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

      Constraints: The marker must match the value specified in the previous request.

      Returns:
      For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current Amazon Web Services account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

      Constraints: The marker must match the value specified in the previous request.

    • maxItems

      public final Integer maxItems()

      Number of domains to be returned.

      Default: 20

      Returns:
      Number of domains to be returned.

      Default: 20

    • toBuilder

      public ListDomainsRequest.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<ListDomainsRequest.Builder,ListDomainsRequest>
      Specified by:
      toBuilder in class Route53DomainsRequest
      Returns:
      a builder for type T

    • builder

      public static ListDomainsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListDomainsRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.