com.amazonaws.services.logs.model

Class DescribeDestinationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.DescribeDestinationsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeDestinationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeDestinations operation.

Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.

By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a nextToken value in the response body. You can also limit the number of destinations returned in the response by specifying the limit parameter in the request.

See Also:

AWSLogs.describeDestinations(DescribeDestinationsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDestinationsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDestinationsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDestinationNamePrefix() Will only return destinations that match the provided destinationNamePrefix.
Integer	getLimit() The maximum number of results to return.
String	getNextToken() A string token used for pagination that points to the next page of results.
int	hashCode()
void	setDestinationNamePrefix(String destinationNamePrefix) Will only return destinations that match the provided destinationNamePrefix.
void	setLimit(Integer limit) The maximum number of results to return.
void	setNextToken(String nextToken) A string token used for pagination that points to the next page of results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDestinationsRequest	withDestinationNamePrefix(String destinationNamePrefix) Will only return destinations that match the provided destinationNamePrefix.
DescribeDestinationsRequest	withLimit(Integer limit) The maximum number of results to return.
DescribeDestinationsRequest	withNextToken(String nextToken) A string token used for pagination that points to the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeDestinationsRequest

public DescribeDestinationsRequest()

Method Detail

getDestinationNamePrefix

public String getDestinationNamePrefix()

Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Returns:

Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.

setDestinationNamePrefix

public void setDestinationNamePrefix(String destinationNamePrefix)

Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:

destinationNamePrefix - Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.

withDestinationNamePrefix

public DescribeDestinationsRequest withDestinationNamePrefix(String destinationNamePrefix)

Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.

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

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:

destinationNamePrefix - Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.

Returns:

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

getNextToken

public String getNextToken()

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.

Constraints:
Length: 1 -

Returns:

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.

setNextToken

public void setNextToken(String nextToken)

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.

Constraints:
Length: 1 -

Parameters:

nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.

withNextToken

public DescribeDestinationsRequest withNextToken(String nextToken)

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.

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

Constraints:
Length: 1 -

Parameters:

nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.

Returns:

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

getLimit

public Integer getLimit()

The maximum number of results to return.

Constraints:
Range: 1 - 50

Returns:

The maximum number of results to return.

setLimit

public void setLimit(Integer limit)

The maximum number of results to return.

Constraints:
Range: 1 - 50

Parameters:

limit - The maximum number of results to return.

withLimit

public DescribeDestinationsRequest withLimit(Integer limit)

The maximum number of results to return.

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

Constraints:
Range: 1 - 50

Parameters:

limit - The maximum number of results to return.

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 DescribeDestinationsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()