com.amazonaws.services.route53.model
Class ListResourceRecordSetsRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.route53.model.ListResourceRecordSetsRequest

All Implemented Interfaces:

Serializable

public class ListResourceRecordSetsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListResourceRecordSets operation.

Imagine all the resource record sets in a zone listed out in front of you. Imagine them sorted lexicographically first by DNS name (with the labels reversed, like "com.amazon.www" for example), and secondarily, lexicographically by record type. This operation retrieves at most MaxItems resource record sets from this list, in order, starting at a position specified by the Name and Type arguments:

• If both Name and Type are omitted, this means start the results at the first RRSET in the HostedZone.
• If Name is specified but Type is omitted, this means start the results at the first RRSET in the list whose name is greater than or equal to Name.
• If both Name and Type are specified, this means start the results at the first RRSET in the list whose name is greater than or equal to Name and whose type is greater than or equal to Type.
• It is an error to specify the Type but not the Name.

Use ListResourceRecordSets to retrieve a single known record set by specifying the record set's name and type, and setting MaxItems = 1

To retrieve all the records in a HostedZone, first pause any processes making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets without a Name and Type to get the first page of record sets. For subsequent calls, set Name and Type to the NextName and NextType values returned by the previous response.

In the presence of concurrent ChangeResourceRecordSets calls, there is no consistency of results across calls to ListResourceRecordSets. The only way to get a consistent multi-page snapshot of all RRSETs in a zone is to stop making changes while pagination is in progress.

However, the results from ListResourceRecordSets are consistent within a page. If MakeChange calls are taking place concurrently, the result of each one will either be completely visible in your results or not at all. You will not see partial changes, or changes that do not ultimately succeed. (This follows from the fact that MakeChange is atomic)

The results from ListResourceRecordSets are strongly consistent with ChangeResourceRecordSets. To be precise, if a single process makes a call to ChangeResourceRecordSets and receives a successful response, the effects of that change will be visible in a subsequent call to ListResourceRecordSets by that process.

See Also:

AmazonRoute53.listResourceRecordSets(ListResourceRecordSetsRequest), Serialized Form

Constructor Summary

ListResourceRecordSetsRequest()
Default constructor for a new ListResourceRecordSetsRequest object.

ListResourceRecordSetsRequest(String hostedZoneId)
Constructs a new ListResourceRecordSetsRequest object.

Method Summary

boolean	equals(Object obj)
String	getHostedZoneId() The ID of the hosted zone that contains the resource record sets that you want to get.
String	getMaxItems() The maximum number of records you want in the response body.
String	getStartRecordIdentifier() Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
String	getStartRecordName() The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
String	getStartRecordType() The DNS type at which to begin the listing of resource record sets.
int	hashCode()
void	setHostedZoneId(String hostedZoneId) The ID of the hosted zone that contains the resource record sets that you want to get.
void	setMaxItems(String maxItems) The maximum number of records you want in the response body.
void	setStartRecordIdentifier(String startRecordIdentifier) Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
void	setStartRecordName(String startRecordName) The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
void	setStartRecordType(RRType startRecordType) The DNS type at which to begin the listing of resource record sets.
void	setStartRecordType(String startRecordType) The DNS type at which to begin the listing of resource record sets.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListResourceRecordSetsRequest	withHostedZoneId(String hostedZoneId) The ID of the hosted zone that contains the resource record sets that you want to get.
ListResourceRecordSetsRequest	withMaxItems(String maxItems) The maximum number of records you want in the response body.
ListResourceRecordSetsRequest	withStartRecordIdentifier(String startRecordIdentifier) Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
ListResourceRecordSetsRequest	withStartRecordName(String startRecordName) The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
ListResourceRecordSetsRequest	withStartRecordType(RRType startRecordType) The DNS type at which to begin the listing of resource record sets.
ListResourceRecordSetsRequest	withStartRecordType(String startRecordType) The DNS type at which to begin the listing of resource record sets.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListResourceRecordSetsRequest

public ListResourceRecordSetsRequest()

Default constructor for a new ListResourceRecordSetsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

ListResourceRecordSetsRequest

public ListResourceRecordSetsRequest(String hostedZoneId)

Constructs a new ListResourceRecordSetsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

hostedZoneId - The ID of the hosted zone that contains the resource record sets that you want to get.

Method Detail

getHostedZoneId

public String getHostedZoneId()

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

Constraints:
Length: 0 - 32

Returns:

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

setHostedZoneId

public void setHostedZoneId(String hostedZoneId)

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

Constraints:
Length: 0 - 32

Parameters:

hostedZoneId - The ID of the hosted zone that contains the resource record sets that you want to get.

withHostedZoneId

public ListResourceRecordSetsRequest withHostedZoneId(String hostedZoneId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 32

Parameters:

hostedZoneId - The ID of the hosted zone that contains the resource record sets that you want to get.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartRecordName

public String getStartRecordName()

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

Constraints:
Length: 0 - 1024

Returns:

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

setStartRecordName

public void setStartRecordName(String startRecordName)

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

Constraints:
Length: 0 - 1024

Parameters:

startRecordName - The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

withStartRecordName

public ListResourceRecordSetsRequest withStartRecordName(String startRecordName)

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 1024

Parameters:

startRecordName - The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartRecordType

public String getStartRecordType()

The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA

Returns:

The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

See Also:

RRType

setStartRecordType

public void setStartRecordType(String startRecordType)

The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA

Parameters:

startRecordType - The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

See Also:

RRType

withStartRecordType

public ListResourceRecordSetsRequest withStartRecordType(String startRecordType)

The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA

Parameters:

startRecordType - The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

RRType

setStartRecordType

public void setStartRecordType(RRType startRecordType)

The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA

Parameters:

startRecordType - The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

See Also:

RRType

withStartRecordType

public ListResourceRecordSetsRequest withStartRecordType(RRType startRecordType)

The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA

Parameters:

startRecordType - The DNS type at which to begin the listing of resource record sets.

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

Values for Alias Resource Record Sets: A | AAAA

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

RRType

getStartRecordIdentifier

public String getStartRecordIdentifier()

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

Constraints:
Length: 1 - 128

Returns:

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

setStartRecordIdentifier

public void setStartRecordIdentifier(String startRecordIdentifier)

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

Constraints:
Length: 1 - 128

Parameters:

startRecordIdentifier - Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

withStartRecordIdentifier

public ListResourceRecordSetsRequest withStartRecordIdentifier(String startRecordIdentifier)

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128

Parameters:

startRecordIdentifier - Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxItems

public String getMaxItems()

The maximum number of records you want in the response body.

Returns:

The maximum number of records you want in the response body.

setMaxItems

public void setMaxItems(String maxItems)

The maximum number of records you want in the response body.

Parameters:

maxItems - The maximum number of records you want in the response body.

withMaxItems

public ListResourceRecordSetsRequest withMaxItems(String maxItems)

The maximum number of records you want in the response body.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxItems - The maximum number of records you want in the response body.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object