com.amazonaws.services.logs.model

Class DescribeLogGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.DescribeLogGroupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeLogGroupsRequest
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
DescribeLogGroupsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeLogGroupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAccountIdentifiers() When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search.
Boolean	getIncludeLinkedAccounts() If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.
Integer	getLimit() The maximum number of items returned.
String	getLogGroupNamePattern() If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search.
String	getLogGroupNamePrefix() The prefix to match.
String	getNextToken() The token for the next set of items to return.
int	hashCode()
Boolean	isIncludeLinkedAccounts() If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.
void	setAccountIdentifiers(Collection<String> accountIdentifiers) When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search.
void	setIncludeLinkedAccounts(Boolean includeLinkedAccounts) If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.
void	setLimit(Integer limit) The maximum number of items returned.
void	setLogGroupNamePattern(String logGroupNamePattern) If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search.
void	setLogGroupNamePrefix(String logGroupNamePrefix) The prefix to match.
void	setNextToken(String nextToken) The token for the next set of items to return.
String	toString() Returns a string representation of this object.
DescribeLogGroupsRequest	withAccountIdentifiers(Collection<String> accountIdentifiers) When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search.
DescribeLogGroupsRequest	withAccountIdentifiers(String... accountIdentifiers) When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search.
DescribeLogGroupsRequest	withIncludeLinkedAccounts(Boolean includeLinkedAccounts) If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.
DescribeLogGroupsRequest	withLimit(Integer limit) The maximum number of items returned.
DescribeLogGroupsRequest	withLogGroupNamePattern(String logGroupNamePattern) If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search.
DescribeLogGroupsRequest	withLogGroupNamePrefix(String logGroupNamePrefix) The prefix to match.
DescribeLogGroupsRequest	withNextToken(String nextToken) The token for the next set of items to return.

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

DescribeLogGroupsRequest

public DescribeLogGroupsRequest()

Method Detail

getAccountIdentifiers

public List<String> getAccountIdentifiers()

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

Returns:

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

setAccountIdentifiers

public void setAccountIdentifiers(Collection<String> accountIdentifiers)

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

Parameters:

accountIdentifiers - When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

withAccountIdentifiers

public DescribeLogGroupsRequest withAccountIdentifiers(String... accountIdentifiers)

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

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

Parameters:

accountIdentifiers - When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

Returns:

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

withAccountIdentifiers

public DescribeLogGroupsRequest withAccountIdentifiers(Collection<String> accountIdentifiers)

When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

Parameters:

accountIdentifiers - When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

Returns:

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

setLogGroupNamePrefix

public void setLogGroupNamePrefix(String logGroupNamePrefix)

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

Parameters:

logGroupNamePrefix - The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

getLogGroupNamePrefix

public String getLogGroupNamePrefix()

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

Returns:

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

withLogGroupNamePrefix

public DescribeLogGroupsRequest withLogGroupNamePrefix(String logGroupNamePrefix)

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

Parameters:

logGroupNamePrefix - The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

Returns:

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

setLogGroupNamePattern

public void setLogGroupNamePattern(String logGroupNamePattern)

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

Parameters:

logGroupNamePattern - If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

getLogGroupNamePattern

public String getLogGroupNamePattern()

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

Returns:

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo , log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

withLogGroupNamePattern

public DescribeLogGroupsRequest withLogGroupNamePattern(String logGroupNamePattern)

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

Parameters:

logGroupNamePattern - If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a previous call.)

getNextToken

public String getNextToken()

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

withNextToken

public DescribeLogGroupsRequest withNextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a previous call.)

Returns:

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

setLimit

public void setLimit(Integer limit)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Parameters:

limit - The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

getLimit

public Integer getLimit()

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Returns:

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

withLimit

public DescribeLogGroupsRequest withLimit(Integer limit)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Parameters:

limit - The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Returns:

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

setIncludeLinkedAccounts

public void setIncludeLinkedAccounts(Boolean includeLinkedAccounts)

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

Parameters:

includeLinkedAccounts - If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

getIncludeLinkedAccounts

public Boolean getIncludeLinkedAccounts()

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

Returns:

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

withIncludeLinkedAccounts

public DescribeLogGroupsRequest withIncludeLinkedAccounts(Boolean includeLinkedAccounts)

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

Parameters:

includeLinkedAccounts - If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

Returns:

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

isIncludeLinkedAccounts

public Boolean isIncludeLinkedAccounts()

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

Returns:

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

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