com.amazonaws.services.logs.model

Class DescribeLogGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.DescribeLogGroupsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeLogGroupsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeLogGroups operation.

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

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

See Also:

AWSLogs.describeLogGroups(DescribeLogGroupsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeLogGroupsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeLogGroupsRequest	clone()
boolean	equals(Object obj)
Integer	getLimit() The maximum number of items returned in the response.
String	getLogGroupNamePrefix() Will only return log groups that match the provided logGroupNamePrefix.
String	getNextToken() A string token used for pagination that points to the next page of results.
int	hashCode()
void	setLimit(Integer limit) The maximum number of items returned in the response.
void	setLogGroupNamePrefix(String logGroupNamePrefix) Will only return log groups that match the provided logGroupNamePrefix.
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.
DescribeLogGroupsRequest	withLimit(Integer limit) The maximum number of items returned in the response.
DescribeLogGroupsRequest	withLogGroupNamePrefix(String logGroupNamePrefix) Will only return log groups that match the provided logGroupNamePrefix.
DescribeLogGroupsRequest	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

DescribeLogGroupsRequest

public DescribeLogGroupsRequest()

Method Detail

getLogGroupNamePrefix

public String getLogGroupNamePrefix()

Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Returns:

Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.

setLogGroupNamePrefix

public void setLogGroupNamePrefix(String logGroupNamePrefix)

Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupNamePrefix - Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.

withLogGroupNamePrefix

public DescribeLogGroupsRequest withLogGroupNamePrefix(String logGroupNamePrefix)

Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.

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

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupNamePrefix - Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter 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 DescribeLogGroups request.

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 DescribeLogGroups request.

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 DescribeLogGroups request.

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 DescribeLogGroups request.

withNextToken

public DescribeLogGroupsRequest 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 DescribeLogGroups request.

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 DescribeLogGroups request.

Returns:

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

getLimit

public Integer getLimit()

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

Constraints:
Range: 1 - 50

Returns:

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

setLimit

public void setLimit(Integer limit)

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

Constraints:
Range: 1 - 50

Parameters:

limit - The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

withLimit

public DescribeLogGroupsRequest withLimit(Integer limit)

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

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

Constraints:
Range: 1 - 50

Parameters:

limit - The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

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

Overrides:

clone in class AmazonWebServiceRequest