com.amazonaws.services.logs.model

Class PutQueryDefinitionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutQueryDefinitionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
PutQueryDefinitionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
List<String>	getLogGroupNames() Use this parameter to include specific log groups as part of your query definition.
String	getName() A name for the query definition.
String	getQueryDefinitionId() If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update.
String	getQueryString() The query string to use for this definition.
int	hashCode()
void	setClientToken(String clientToken) Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
void	setLogGroupNames(Collection<String> logGroupNames) Use this parameter to include specific log groups as part of your query definition.
void	setName(String name) A name for the query definition.
void	setQueryDefinitionId(String queryDefinitionId) If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update.
void	setQueryString(String queryString) The query string to use for this definition.
String	toString() Returns a string representation of this object.
PutQueryDefinitionRequest	withClientToken(String clientToken) Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
PutQueryDefinitionRequest	withLogGroupNames(Collection<String> logGroupNames) Use this parameter to include specific log groups as part of your query definition.
PutQueryDefinitionRequest	withLogGroupNames(String... logGroupNames) Use this parameter to include specific log groups as part of your query definition.
PutQueryDefinitionRequest	withName(String name) A name for the query definition.
PutQueryDefinitionRequest	withQueryDefinitionId(String queryDefinitionId) If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update.
PutQueryDefinitionRequest	withQueryString(String queryString) The query string to use for this definition.

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

PutQueryDefinitionRequest

public PutQueryDefinitionRequest()

Method Detail

setName

public void setName(String name)

A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

Parameters:

name - A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

getName

public String getName()

A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

Returns:

A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

withName

public PutQueryDefinitionRequest withName(String name)

A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

Parameters:

name - A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

Returns:

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

setQueryDefinitionId

public void setQueryDefinitionId(String queryDefinitionId)

If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

Parameters:

queryDefinitionId - If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

getQueryDefinitionId

public String getQueryDefinitionId()

If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

Returns:

If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

withQueryDefinitionId

public PutQueryDefinitionRequest withQueryDefinitionId(String queryDefinitionId)

If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

Parameters:

queryDefinitionId - If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

Returns:

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

getLogGroupNames

public List<String> getLogGroupNames()

Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

Returns:

Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

setLogGroupNames

public void setLogGroupNames(Collection<String> logGroupNames)

Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

Parameters:

logGroupNames - Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

withLogGroupNames

public PutQueryDefinitionRequest withLogGroupNames(String... logGroupNames)

Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

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 - Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

Returns:

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

withLogGroupNames

public PutQueryDefinitionRequest withLogGroupNames(Collection<String> logGroupNames)

Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

Parameters:

logGroupNames - Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

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 this definition. For more information, see CloudWatch Logs Insights Query Syntax.

Parameters:

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

getQueryString

public String getQueryString()

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

Returns:

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

withQueryString

public PutQueryDefinitionRequest withQueryString(String queryString)

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

Parameters:

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

Returns:

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

setClientToken

public void setClientToken(String clientToken)

Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

Parameters:

clientToken - Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

getClientToken

public String getClientToken()

Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

Returns:

Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

withClientToken

public PutQueryDefinitionRequest withClientToken(String clientToken)

Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

Parameters:

clientToken - Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

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