com.amazonaws.services.route53.model

Class ListTrafficPolicyInstancesByHostedZoneRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.route53.model.ListTrafficPolicyInstancesByHostedZoneRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListTrafficPolicyInstancesByHostedZoneRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListTrafficPolicyInstancesByHostedZone operation.

Gets information about the traffic policy instances that you created in a specified hosted zone.

NOTE:After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

To get information about the traffic policy instances that you created in a specified hosted zone, send a GET request to the 2013-04-01/trafficpolicyinstance resource and include the ID of the hosted zone.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

The response includes four values that help you navigate from one group of MaxItems traffic policy instances to the next:

• IsTruncated

If the value of IsTruncated in the response is true , there are more traffic policy instances associated with the current AWS account.

If IsTruncated is false , this response includes the last traffic policy instance that is associated with the current account.

• MaxItems

The value that you specified for the MaxItems parameter in the request that produced the current response.

• TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker

If IsTruncated is true , these two values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByHostedZone , and specify these values in the corresponding request parameters.

If IsTruncated is false , all three elements are omitted from the response.

See Also:

AmazonRoute53.listTrafficPolicyInstancesByHostedZone(ListTrafficPolicyInstancesByHostedZoneRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListTrafficPolicyInstancesByHostedZoneRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListTrafficPolicyInstancesByHostedZoneRequest	clone()
boolean	equals(Object obj)
String	getHostedZoneId() The ID of the hosted zone for which you want to list traffic policy instances.
String	getMaxItems() The maximum number of traffic policy instances to be included in the response body for this request.
String	getTrafficPolicyInstanceNameMarker() For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
String	getTrafficPolicyInstanceTypeMarker() For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
int	hashCode()
void	setHostedZoneId(String hostedZoneId) The ID of the hosted zone for which you want to list traffic policy instances.
void	setMaxItems(String maxItems) The maximum number of traffic policy instances to be included in the response body for this request.
void	setTrafficPolicyInstanceNameMarker(String trafficPolicyInstanceNameMarker) For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
void	setTrafficPolicyInstanceTypeMarker(RRType trafficPolicyInstanceTypeMarker) For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
void	setTrafficPolicyInstanceTypeMarker(String trafficPolicyInstanceTypeMarker) For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListTrafficPolicyInstancesByHostedZoneRequest	withHostedZoneId(String hostedZoneId) The ID of the hosted zone for which you want to list traffic policy instances.
ListTrafficPolicyInstancesByHostedZoneRequest	withMaxItems(String maxItems) The maximum number of traffic policy instances to be included in the response body for this request.
ListTrafficPolicyInstancesByHostedZoneRequest	withTrafficPolicyInstanceNameMarker(String trafficPolicyInstanceNameMarker) For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
ListTrafficPolicyInstancesByHostedZoneRequest	withTrafficPolicyInstanceTypeMarker(RRType trafficPolicyInstanceTypeMarker) For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.
ListTrafficPolicyInstancesByHostedZoneRequest	withTrafficPolicyInstanceTypeMarker(String trafficPolicyInstanceTypeMarker) For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListTrafficPolicyInstancesByHostedZoneRequest

public ListTrafficPolicyInstancesByHostedZoneRequest()

Method Detail

getHostedZoneId

public String getHostedZoneId()

The ID of the hosted zone for which you want to list traffic policy instances.

Constraints:
Length: 0 - 32

Returns:

The ID of the hosted zone for which you want to list traffic policy instances.

setHostedZoneId

public void setHostedZoneId(String hostedZoneId)

The ID of the hosted zone for which you want to list traffic policy instances.

Constraints:
Length: 0 - 32

Parameters:

hostedZoneId - The ID of the hosted zone for which you want to list traffic policy instances.

withHostedZoneId

public ListTrafficPolicyInstancesByHostedZoneRequest withHostedZoneId(String hostedZoneId)

The ID of the hosted zone for which you want to list traffic policy instances.

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 for which you want to list traffic policy instances.

Returns:

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

getTrafficPolicyInstanceNameMarker

public String getTrafficPolicyInstanceNameMarker()

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

Constraints:
Length: 0 - 1024

Returns:

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

setTrafficPolicyInstanceNameMarker

public void setTrafficPolicyInstanceNameMarker(String trafficPolicyInstanceNameMarker)

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

Constraints:
Length: 0 - 1024

Parameters:

trafficPolicyInstanceNameMarker - For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

withTrafficPolicyInstanceNameMarker

public ListTrafficPolicyInstancesByHostedZoneRequest withTrafficPolicyInstanceNameMarker(String trafficPolicyInstanceNameMarker)

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

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

Constraints:
Length: 0 - 1024

Parameters:

trafficPolicyInstanceNameMarker - For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

Returns:

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

getTrafficPolicyInstanceTypeMarker

public String getTrafficPolicyInstanceTypeMarker()

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

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

Returns:

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

See Also:

RRType

setTrafficPolicyInstanceTypeMarker

public void setTrafficPolicyInstanceTypeMarker(String trafficPolicyInstanceTypeMarker)

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

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

Parameters:

trafficPolicyInstanceTypeMarker - For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

See Also:

RRType

withTrafficPolicyInstanceTypeMarker

public ListTrafficPolicyInstancesByHostedZoneRequest withTrafficPolicyInstanceTypeMarker(String trafficPolicyInstanceTypeMarker)

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

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:

trafficPolicyInstanceTypeMarker - For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

Returns:

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

See Also:

RRType

setTrafficPolicyInstanceTypeMarker

public void setTrafficPolicyInstanceTypeMarker(RRType trafficPolicyInstanceTypeMarker)

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

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

Parameters:

trafficPolicyInstanceTypeMarker - For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

See Also:

RRType

withTrafficPolicyInstanceTypeMarker

public ListTrafficPolicyInstancesByHostedZoneRequest withTrafficPolicyInstanceTypeMarker(RRType trafficPolicyInstanceTypeMarker)

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

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:

trafficPolicyInstanceTypeMarker - For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

Returns:

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

See Also:

RRType

getMaxItems

public String getMaxItems()

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

Returns:

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

setMaxItems

public void setMaxItems(String maxItems)

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

Parameters:

maxItems - The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

withMaxItems

public ListTrafficPolicyInstancesByHostedZoneRequest withMaxItems(String maxItems)

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

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

Parameters:

maxItems - The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

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

clone

public ListTrafficPolicyInstancesByHostedZoneRequest clone()

Overrides:

clone in class AmazonWebServiceRequest