com.amazonaws.services.timestreamquery.model

Class CreateScheduledQueryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.timestreamquery.model.CreateScheduledQueryRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateScheduledQueryRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
ErrorReportConfiguration	getErrorReportConfiguration() Configuration for error reporting.
String	getKmsKeyId() The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
String	getName() Name of the scheduled query.
NotificationConfiguration	getNotificationConfiguration() Notification configuration for the scheduled query.
String	getQueryString() The query string to run.
ScheduleConfiguration	getScheduleConfiguration() The schedule configuration for the query.
String	getScheduledQueryExecutionRoleArn() The ARN for the IAM role that Timestream will assume when running the scheduled query.
List<Tag>	getTags() A list of key-value pairs to label the scheduled query.
TargetConfiguration	getTargetConfiguration() Configuration used for writing the result of a query.
int	hashCode()
void	setClientToken(String clientToken) Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
void	setErrorReportConfiguration(ErrorReportConfiguration errorReportConfiguration) Configuration for error reporting.
void	setKmsKeyId(String kmsKeyId) The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
void	setName(String name) Name of the scheduled query.
void	setNotificationConfiguration(NotificationConfiguration notificationConfiguration) Notification configuration for the scheduled query.
void	setQueryString(String queryString) The query string to run.
void	setScheduleConfiguration(ScheduleConfiguration scheduleConfiguration) The schedule configuration for the query.
void	setScheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn) The ARN for the IAM role that Timestream will assume when running the scheduled query.
void	setTags(Collection<Tag> tags) A list of key-value pairs to label the scheduled query.
void	setTargetConfiguration(TargetConfiguration targetConfiguration) Configuration used for writing the result of a query.
String	toString() Returns a string representation of this object.
CreateScheduledQueryRequest	withClientToken(String clientToken) Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
CreateScheduledQueryRequest	withErrorReportConfiguration(ErrorReportConfiguration errorReportConfiguration) Configuration for error reporting.
CreateScheduledQueryRequest	withKmsKeyId(String kmsKeyId) The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
CreateScheduledQueryRequest	withName(String name) Name of the scheduled query.
CreateScheduledQueryRequest	withNotificationConfiguration(NotificationConfiguration notificationConfiguration) Notification configuration for the scheduled query.
CreateScheduledQueryRequest	withQueryString(String queryString) The query string to run.
CreateScheduledQueryRequest	withScheduleConfiguration(ScheduleConfiguration scheduleConfiguration) The schedule configuration for the query.
CreateScheduledQueryRequest	withScheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn) The ARN for the IAM role that Timestream will assume when running the scheduled query.
CreateScheduledQueryRequest	withTags(Collection<Tag> tags) A list of key-value pairs to label the scheduled query.
CreateScheduledQueryRequest	withTags(Tag... tags) A list of key-value pairs to label the scheduled query.
CreateScheduledQueryRequest	withTargetConfiguration(TargetConfiguration targetConfiguration) Configuration used for writing the result of a 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

CreateScheduledQueryRequest

public CreateScheduledQueryRequest()

Method Detail

setName

public void setName(String name)

Name of the scheduled query.

Parameters:

name - Name of the scheduled query.

getName

public String getName()

Name of the scheduled query.

Returns:

Name of the scheduled query.

withName

public CreateScheduledQueryRequest withName(String name)

Name of the scheduled query.

Parameters:

name - Name of the scheduled query.

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 run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

Parameters:

queryString - The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

getQueryString

public String getQueryString()

The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

Returns:

The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

withQueryString

public CreateScheduledQueryRequest withQueryString(String queryString)

The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

Parameters:

queryString - The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

Returns:

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

setScheduleConfiguration

public void setScheduleConfiguration(ScheduleConfiguration scheduleConfiguration)

The schedule configuration for the query.

Parameters:

scheduleConfiguration - The schedule configuration for the query.

getScheduleConfiguration

public ScheduleConfiguration getScheduleConfiguration()

The schedule configuration for the query.

Returns:

The schedule configuration for the query.

withScheduleConfiguration

public CreateScheduledQueryRequest withScheduleConfiguration(ScheduleConfiguration scheduleConfiguration)

The schedule configuration for the query.

Parameters:

scheduleConfiguration - The schedule configuration for the query.

Returns:

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

setNotificationConfiguration

public void setNotificationConfiguration(NotificationConfiguration notificationConfiguration)

Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

Parameters:

notificationConfiguration - Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

getNotificationConfiguration

public NotificationConfiguration getNotificationConfiguration()

Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

Returns:

Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

withNotificationConfiguration

public CreateScheduledQueryRequest withNotificationConfiguration(NotificationConfiguration notificationConfiguration)

Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

Parameters:

notificationConfiguration - Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

Returns:

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

setTargetConfiguration

public void setTargetConfiguration(TargetConfiguration targetConfiguration)

Configuration used for writing the result of a query.

Parameters:

targetConfiguration - Configuration used for writing the result of a query.

getTargetConfiguration

public TargetConfiguration getTargetConfiguration()

Configuration used for writing the result of a query.

Returns:

Configuration used for writing the result of a query.

withTargetConfiguration

public CreateScheduledQueryRequest withTargetConfiguration(TargetConfiguration targetConfiguration)

Configuration used for writing the result of a query.

Parameters:

targetConfiguration - Configuration used for writing the result of a query.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

• If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

Parameters:

clientToken - Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

• If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

getClientToken

public String getClientToken()

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

• If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

Returns:

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

• If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

withClientToken

public CreateScheduledQueryRequest withClientToken(String clientToken)

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

• If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

Parameters:

clientToken - Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

• If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

Returns:

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

setScheduledQueryExecutionRoleArn

public void setScheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)

The ARN for the IAM role that Timestream will assume when running the scheduled query.

Parameters:

scheduledQueryExecutionRoleArn - The ARN for the IAM role that Timestream will assume when running the scheduled query.

getScheduledQueryExecutionRoleArn

public String getScheduledQueryExecutionRoleArn()

The ARN for the IAM role that Timestream will assume when running the scheduled query.

Returns:

The ARN for the IAM role that Timestream will assume when running the scheduled query.

withScheduledQueryExecutionRoleArn

public CreateScheduledQueryRequest withScheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)

The ARN for the IAM role that Timestream will assume when running the scheduled query.

Parameters:

scheduledQueryExecutionRoleArn - The ARN for the IAM role that Timestream will assume when running the scheduled query.

Returns:

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

getTags

public List<Tag> getTags()

A list of key-value pairs to label the scheduled query.

Returns:

A list of key-value pairs to label the scheduled query.

setTags

public void setTags(Collection<Tag> tags)

A list of key-value pairs to label the scheduled query.

Parameters:

tags - A list of key-value pairs to label the scheduled query.

withTags

public CreateScheduledQueryRequest withTags(Tag... tags)

A list of key-value pairs to label the scheduled query.

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

Parameters:

tags - A list of key-value pairs to label the scheduled query.

Returns:

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

withTags

public CreateScheduledQueryRequest withTags(Collection<Tag> tags)

A list of key-value pairs to label the scheduled query.

Parameters:

tags - A list of key-value pairs to label the scheduled query.

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

Parameters:

kmsKeyId - The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

getKmsKeyId

public String getKmsKeyId()

The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

Returns:

The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

withKmsKeyId

public CreateScheduledQueryRequest withKmsKeyId(String kmsKeyId)

The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

Parameters:

kmsKeyId - The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

Returns:

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

setErrorReportConfiguration

public void setErrorReportConfiguration(ErrorReportConfiguration errorReportConfiguration)

Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

Parameters:

errorReportConfiguration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

getErrorReportConfiguration

public ErrorReportConfiguration getErrorReportConfiguration()

Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

Returns:

Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

withErrorReportConfiguration

public CreateScheduledQueryRequest withErrorReportConfiguration(ErrorReportConfiguration errorReportConfiguration)

Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

Parameters:

errorReportConfiguration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

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