com.amazonaws.services.logs.model

Class StartQueryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.StartQueryRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
StartQueryRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getEndTime() The end of the time range to query.
Integer	getLimit() The maximum number of log events to return in the query.
List<String>	getLogGroupIdentifiers() The list of log groups to query.
String	getLogGroupName() The log group on which to perform the query.
List<String>	getLogGroupNames() The list of log groups to be queried.
String	getQueryString() The query string to use.
Long	getStartTime() The beginning of the time range to query.
int	hashCode()
void	setEndTime(Long endTime) The end of the time range to query.
void	setLimit(Integer limit) The maximum number of log events to return in the query.
void	setLogGroupIdentifiers(Collection<String> logGroupIdentifiers) The list of log groups to query.
void	setLogGroupName(String logGroupName) The log group on which to perform the query.
void	setLogGroupNames(Collection<String> logGroupNames) The list of log groups to be queried.
void	setQueryString(String queryString) The query string to use.
void	setStartTime(Long startTime) The beginning of the time range to query.
String	toString() Returns a string representation of this object.
StartQueryRequest	withEndTime(Long endTime) The end of the time range to query.
StartQueryRequest	withLimit(Integer limit) The maximum number of log events to return in the query.
StartQueryRequest	withLogGroupIdentifiers(Collection<String> logGroupIdentifiers) The list of log groups to query.
StartQueryRequest	withLogGroupIdentifiers(String... logGroupIdentifiers) The list of log groups to query.
StartQueryRequest	withLogGroupName(String logGroupName) The log group on which to perform the query.
StartQueryRequest	withLogGroupNames(Collection<String> logGroupNames) The list of log groups to be queried.
StartQueryRequest	withLogGroupNames(String... logGroupNames) The list of log groups to be queried.
StartQueryRequest	withQueryString(String queryString) The query string to use.
StartQueryRequest	withStartTime(Long startTime) The beginning of the time range to query.

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

StartQueryRequest

public StartQueryRequest()

Method Detail

setLogGroupName

public void setLogGroupName(String logGroupName)

The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupName - The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

getLogGroupName

public String getLogGroupName()

The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

withLogGroupName

public StartQueryRequest withLogGroupName(String logGroupName)

The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupName - The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

getLogGroupNames

public List<String> getLogGroupNames()

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

setLogGroupNames

public void setLogGroupNames(Collection<String> logGroupNames)

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupNames - The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

withLogGroupNames

public StartQueryRequest withLogGroupNames(String... logGroupNames)

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

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

Parameters:

logGroupNames - The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

withLogGroupNames

public StartQueryRequest withLogGroupNames(Collection<String> logGroupNames)

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupNames - The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

getLogGroupIdentifiers

public List<String> getLogGroupIdentifiers()

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

setLogGroupIdentifiers

public void setLogGroupIdentifiers(Collection<String> logGroupIdentifiers)

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupIdentifiers - The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

withLogGroupIdentifiers

public StartQueryRequest withLogGroupIdentifiers(String... logGroupIdentifiers)

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

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

Parameters:

logGroupIdentifiers - The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

withLogGroupIdentifiers

public StartQueryRequest withLogGroupIdentifiers(Collection<String> logGroupIdentifiers)

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupIdentifiers - The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

setStartTime

public void setStartTime(Long startTime)

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Parameters:

startTime - The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

getStartTime

public Long getStartTime()

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

withStartTime

public StartQueryRequest withStartTime(Long startTime)

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Parameters:

startTime - The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

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

setEndTime

public void setEndTime(Long endTime)

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Parameters:

endTime - The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

getEndTime

public Long getEndTime()

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

withEndTime

public StartQueryRequest withEndTime(Long endTime)

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Parameters:

endTime - The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

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

setQueryString

public void setQueryString(String queryString)

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

Parameters:

queryString - The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

getQueryString

public String getQueryString()

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

Returns:

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

withQueryString

public StartQueryRequest withQueryString(String queryString)

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

Parameters:

queryString - The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

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 log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

Parameters:

limit - The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

getLimit

public Integer getLimit()

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

Returns:

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

withLimit

public StartQueryRequest withLimit(Integer limit)

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

Parameters:

limit - The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

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