software.amazon.awssdk.services.timestreamquery.model

Class CreateScheduledQueryRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.timestreamquery.model.TimestreamQueryRequest

software.amazon.awssdk.services.timestreamquery.model.CreateScheduledQueryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateScheduledQueryRequest
extends TimestreamQueryRequest
implements ToCopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateScheduledQueryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateScheduledQueryRequest.Builder	builder()
String	clientToken() Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorReportConfiguration	errorReportConfiguration() Configuration for error reporting.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyId() The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
String	name() Name of the scheduled query.
NotificationConfiguration	notificationConfiguration() Notification configuration for the scheduled query.
String	queryString() The query string to run.
ScheduleConfiguration	scheduleConfiguration() The schedule configuration for the query.
String	scheduledQueryExecutionRoleArn() The ARN for the IAM role that Timestream will assume when running the scheduled query.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateScheduledQueryRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of key-value pairs to label the scheduled query.
TargetConfiguration	targetConfiguration() Configuration used for writing the result of a query.
CreateScheduledQueryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

Name of the scheduled query.

Returns:

Name of the scheduled query.

queryString

public final 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.

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.

scheduleConfiguration

public final ScheduleConfiguration scheduleConfiguration()

The schedule configuration for the query.

Returns:

The schedule configuration for the query.

notificationConfiguration

public final 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.

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.

targetConfiguration

public final TargetConfiguration targetConfiguration()

Configuration used for writing the result of a query.

Returns:

Configuration used for writing the result of a query.

clientToken

public final 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.

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.

scheduledQueryExecutionRoleArn

public final String scheduledQueryExecutionRoleArn()

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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

kmsKeyId

public final 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.

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.

errorReportConfiguration

public final ErrorReportConfiguration errorReportConfiguration()

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.

toBuilder

public CreateScheduledQueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>

Specified by:

toBuilder in class TimestreamQueryRequest

builder

public static CreateScheduledQueryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateScheduledQueryRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo