Package software.amazon.awssdk.services.route53.model

Class ListResourceRecordSetsRequest

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

A request for the resource record sets that are associated with a specified hosted zone.

  • Method Details

    • hostedZoneId

      public final String hostedZoneId()

      The ID of the hosted zone that contains the resource record sets that you want to list.

      Returns:
      The ID of the hosted zone that contains the resource record sets that you want to list.

    • startRecordName

      public final String startRecordName()

      The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name.

      Returns:
      The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name.

    • startRecordType

      public final RRType startRecordType()

      The type of resource record set to begin the record listing from.

      Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

      Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

      Values for alias resource record sets:

      • API Gateway custom regional API or edge-optimized API: A

      • CloudFront distribution: A or AAAA

      • Elastic Beanstalk environment that has a regionalized subdomain: A

      • Elastic Load Balancing load balancer: A | AAAA

      • S3 bucket: A

      • VPC interface VPC endpoint: A

      • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

      Constraint: Specifying type without specifying name returns an InvalidInput error.

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

      Returns:
      The type of resource record set to begin the record listing from.

      Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

      Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

      Values for alias resource record sets:

      • API Gateway custom regional API or edge-optimized API: A

      • CloudFront distribution: A or AAAA

      • Elastic Beanstalk environment that has a regionalized subdomain: A

      • Elastic Load Balancing load balancer: A | AAAA

      • S3 bucket: A

      • VPC interface VPC endpoint: A

      • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

      Constraint: Specifying type without specifying name returns an InvalidInput error.

      See Also:

    • startRecordTypeAsString

      public final String startRecordTypeAsString()

      The type of resource record set to begin the record listing from.

      Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

      Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

      Values for alias resource record sets:

      • API Gateway custom regional API or edge-optimized API: A

      • CloudFront distribution: A or AAAA

      • Elastic Beanstalk environment that has a regionalized subdomain: A

      • Elastic Load Balancing load balancer: A | AAAA

      • S3 bucket: A

      • VPC interface VPC endpoint: A

      • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

      Constraint: Specifying type without specifying name returns an InvalidInput error.

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

      Returns:
      The type of resource record set to begin the record listing from.

      Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

      Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

      Values for alias resource record sets:

      • API Gateway custom regional API or edge-optimized API: A

      • CloudFront distribution: A or AAAA

      • Elastic Beanstalk environment that has a regionalized subdomain: A

      • Elastic Load Balancing load balancer: A | AAAA

      • S3 bucket: A

      • VPC interface VPC endpoint: A

      • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

      Constraint: Specifying type without specifying name returns an InvalidInput error.

      See Also:

    • startRecordIdentifier

      public final String startRecordIdentifier()

      Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

      Returns:
      Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

    • maxItems

      public final String maxItems()

      (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

      Returns:
      (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

    • toBuilder

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

    • builder

      public static ListResourceRecordSetsRequest.Builder builder()

    • serializableBuilderClass

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