com.amazonaws.services.route53.model

Class ListTrafficPolicyInstancesByPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.route53.model.ListTrafficPolicyInstancesByPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListTrafficPolicyInstancesByPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListTrafficPolicyInstancesByPolicy operation.

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

NOTE:After you submit a CreateTrafficPolicyInstance or 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 by using a specify traffic policy version, send a GET request to the 2013-04-01/trafficpolicyinstance resource and include the ID and version of the traffic policy.

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 five 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 specified traffic policy.

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

• MaxItems

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

• HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker

  If IsTruncated is true , these 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 ListTrafficPolicyInstancesByPolicy , and specify these values in the corresponding request parameters.

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

See Also:

AmazonRoute53.listTrafficPolicyInstancesByPolicy(ListTrafficPolicyInstancesByPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListTrafficPolicyInstancesByPolicyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListTrafficPolicyInstancesByPolicyRequest	clone()
boolean	equals(Object obj)
String	getHostedZoneIdMarker() For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
String	getMaxItems() The maximum number of traffic policy instances to be included in the response body for this request.
String	getTrafficPolicyId() The ID of the traffic policy for which you want to list traffic policy instances.
String	getTrafficPolicyInstanceNameMarker() For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
String	getTrafficPolicyInstanceTypeMarker() For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
Integer	getTrafficPolicyVersion() The version of the traffic policy for which you want to list traffic policy instances.
int	hashCode()
void	setHostedZoneIdMarker(String hostedZoneIdMarker) For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
void	setMaxItems(String maxItems) The maximum number of traffic policy instances to be included in the response body for this request.
void	setTrafficPolicyId(String trafficPolicyId) The ID of the traffic policy for which you want to list traffic policy instances.
void	setTrafficPolicyInstanceNameMarker(String trafficPolicyInstanceNameMarker) For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
void	setTrafficPolicyInstanceTypeMarker(RRType trafficPolicyInstanceTypeMarker) For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
void	setTrafficPolicyInstanceTypeMarker(String trafficPolicyInstanceTypeMarker) For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
void	setTrafficPolicyVersion(Integer trafficPolicyVersion) The version of the traffic policy for which you want to list traffic policy instances.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListTrafficPolicyInstancesByPolicyRequest	withHostedZoneIdMarker(String hostedZoneIdMarker) For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
ListTrafficPolicyInstancesByPolicyRequest	withMaxItems(String maxItems) The maximum number of traffic policy instances to be included in the response body for this request.
ListTrafficPolicyInstancesByPolicyRequest	withTrafficPolicyId(String trafficPolicyId) The ID of the traffic policy for which you want to list traffic policy instances.
ListTrafficPolicyInstancesByPolicyRequest	withTrafficPolicyInstanceNameMarker(String trafficPolicyInstanceNameMarker) For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
ListTrafficPolicyInstancesByPolicyRequest	withTrafficPolicyInstanceTypeMarker(RRType trafficPolicyInstanceTypeMarker) For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
ListTrafficPolicyInstancesByPolicyRequest	withTrafficPolicyInstanceTypeMarker(String trafficPolicyInstanceTypeMarker) For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.
ListTrafficPolicyInstancesByPolicyRequest	withTrafficPolicyVersion(Integer trafficPolicyVersion) The version of the traffic policy for which you want to list traffic policy instances.

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

ListTrafficPolicyInstancesByPolicyRequest

public ListTrafficPolicyInstancesByPolicyRequest()

Method Detail

getTrafficPolicyId

public String getTrafficPolicyId()

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

Constraints:
Length: 0 - 36

Returns:

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

setTrafficPolicyId

public void setTrafficPolicyId(String trafficPolicyId)

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

Constraints:
Length: 0 - 36

Parameters:

trafficPolicyId - The ID of the traffic policy for which you want to list traffic policy instances.

withTrafficPolicyId

public ListTrafficPolicyInstancesByPolicyRequest withTrafficPolicyId(String trafficPolicyId)

The ID of the traffic policy 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 - 36

Parameters:

trafficPolicyId - The ID of the traffic policy for which you want to list traffic policy instances.

Returns:

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

getTrafficPolicyVersion

public Integer getTrafficPolicyVersion()

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

Constraints:
Range: 1 - 1000

Returns:

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

setTrafficPolicyVersion

public void setTrafficPolicyVersion(Integer trafficPolicyVersion)

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

Constraints:
Range: 1 - 1000

Parameters:

trafficPolicyVersion - The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

withTrafficPolicyVersion

public ListTrafficPolicyInstancesByPolicyRequest withTrafficPolicyVersion(Integer trafficPolicyVersion)

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

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

Constraints:
Range: 1 - 1000

Parameters:

trafficPolicyVersion - The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

Returns:

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

getHostedZoneIdMarker

public String getHostedZoneIdMarker()

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for 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 - 32

Returns:

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for 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.

setHostedZoneIdMarker

public void setHostedZoneIdMarker(String hostedZoneIdMarker)

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for 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 - 32

Parameters:

hostedZoneIdMarker - For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for 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.

withHostedZoneIdMarker

public ListTrafficPolicyInstancesByPolicyRequest withHostedZoneIdMarker(String hostedZoneIdMarker)

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for 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 - 32

Parameters:

hostedZoneIdMarker - For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for 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.

getTrafficPolicyInstanceNameMarker

public String getTrafficPolicyInstanceNameMarker()

For the first request to ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicyRequest withTrafficPolicyInstanceNameMarker(String trafficPolicyInstanceNameMarker)

For the first request to ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicyRequest withTrafficPolicyInstanceTypeMarker(String trafficPolicyInstanceTypeMarker)

For the first request to ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicyRequest withTrafficPolicyInstanceTypeMarker(RRType trafficPolicyInstanceTypeMarker)

For the first request to ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicy, 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 ListTrafficPolicyInstancesByPolicyRequest 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 ListTrafficPolicyInstancesByPolicyRequest clone()

Overrides:

clone in class AmazonWebServiceRequest