com.amazonaws.services.synthetics.model

Class DescribeCanariesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.synthetics.model.DescribeCanariesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeCanariesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeCanariesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeCanariesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getMaxResults() Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation.
List<String>	getNames() Use this parameter to return only canaries that match the names that you specify here.
String	getNextToken() A token that indicates that there is more data available.
int	hashCode()
void	setMaxResults(Integer maxResults) Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation.
void	setNames(Collection<String> names) Use this parameter to return only canaries that match the names that you specify here.
void	setNextToken(String nextToken) A token that indicates that there is more data available.
String	toString() Returns a string representation of this object.
DescribeCanariesRequest	withMaxResults(Integer maxResults) Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation.
DescribeCanariesRequest	withNames(Collection<String> names) Use this parameter to return only canaries that match the names that you specify here.
DescribeCanariesRequest	withNames(String... names) Use this parameter to return only canaries that match the names that you specify here.
DescribeCanariesRequest	withNextToken(String nextToken) A token that indicates that there is more data available.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeCanariesRequest

public DescribeCanariesRequest()

Method Detail

setNextToken

public void setNextToken(String nextToken)

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Parameters:

nextToken - A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

getNextToken

public String getNextToken()

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Returns:

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

withNextToken

public DescribeCanariesRequest withNextToken(String nextToken)

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Parameters:

nextToken - A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Parameters:

maxResults - Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

getMaxResults

public Integer getMaxResults()

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Returns:

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

withMaxResults

public DescribeCanariesRequest withMaxResults(Integer maxResults)

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Parameters:

maxResults - Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Returns:

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

getNames

public List<String> getNames()

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Returns:

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

setNames

public void setNames(Collection<String> names)

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Parameters:

names - Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

withNames

public DescribeCanariesRequest withNames(String... names)

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

NOTE: This method appends the values to the existing list (if any). Use setNames(java.util.Collection) or withNames(java.util.Collection) if you want to override the existing values.

Parameters:

names - Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Returns:

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

withNames

public DescribeCanariesRequest withNames(Collection<String> names)

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Parameters:

names - Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeCanariesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()