java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest
    - - software.amazon.awssdk.services.cloudwatchlogs.model.CreateScheduledQueryRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateScheduledQueryRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateScheduledQueryRequest.Builder`	`builder()`
`String`	`description()`	An optional description for the scheduled query to help identify its purpose and functionality.
`DestinationConfiguration`	`destinationConfiguration()`	Configuration for where to deliver query results.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleArn()`	The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLogGroupIdentifiers()`	For responses, this returns true if the service returned a value for the LogGroupIdentifiers property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`List<String>`	`logGroupIdentifiers()`	An array of log group names or ARNs to query.
`String`	`name()`	The name of the scheduled query.
`QueryLanguage`	`queryLanguage()`	The query language to use for the scheduled query.
`String`	`queryLanguageAsString()`	The query language to use for the scheduled query.
`String`	`queryString()`	The query string to execute.
`Long`	`scheduleEndTime()`	The end time for the scheduled query in Unix epoch format.
`String`	`scheduleExpression()`	A cron expression that defines when the scheduled query runs.
`Long`	`scheduleStartTime()`	The start time for the scheduled query in Unix epoch format.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateScheduledQueryRequest.Builder>`	`serializableBuilderClass()`
`Long`	`startTimeOffset()`	The time offset in seconds that defines the lookback period for the query.
`ScheduledQueryState`	`state()`	The initial state of the scheduled query.
`String`	`stateAsString()`	The initial state of the scheduled query.
`Map<String,String>`	`tags()`	Key-value pairs to associate with the scheduled query for resource management and cost allocation.
`String`	`timezone()`	The timezone for evaluating the schedule expression.
`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()
```
    The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.
    
    Returns:
    
    The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.
  - description
```
public final String description()
```
    An optional description for the scheduled query to help identify its purpose and functionality.
    
    Returns:
    
    An optional description for the scheduled query to help identify its purpose and functionality.
  - queryLanguage
```
public final QueryLanguage queryLanguage()
```
    The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.
    
    If the service returns an enum value that is not available in the current SDK version, queryLanguage will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLanguageAsString().
    
    Returns:
    
    The query language to use for the scheduled query. Valid values are LogsQL, PPL , and SQL.
    
    See Also:
    
    QueryLanguage
  - queryLanguageAsString
```
public final String queryLanguageAsString()
```
    The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.
    
    If the service returns an enum value that is not available in the current SDK version, queryLanguage will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLanguageAsString().
    
    Returns:
    
    The query language to use for the scheduled query. Valid values are LogsQL, PPL , and SQL.
    
    See Also:
    
    QueryLanguage
  - queryString
```
public final String queryString()
```
    The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.
    
    Returns:
    
    The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.
  - hasLogGroupIdentifiers
```
public final boolean hasLogGroupIdentifiers()
```
    For responses, this returns true if the service returned a value for the LogGroupIdentifiers 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.
  - logGroupIdentifiers
```
public final List<String> logGroupIdentifiers()
```
    An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.
    
    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 hasLogGroupIdentifiers() method.
    
    Returns:
    
    An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.
  - scheduleExpression
```
public final String scheduleExpression()
```
    A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.
    
    Returns:
    
    A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.
  - timezone
```
public final String timezone()
```
    The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.
    
    Returns:
    
    The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.
  - startTimeOffset
```
public final Long startTimeOffset()
```
    The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.
    
    Returns:
    
    The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.
  - destinationConfiguration
```
public final DestinationConfiguration destinationConfiguration()
```
    Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.
    
    Returns:
    
    Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.
  - scheduleStartTime
```
public final Long scheduleStartTime()
```
    The start time for the scheduled query in Unix epoch format. The query will not execute before this time.
    
    Returns:
    
    The start time for the scheduled query in Unix epoch format. The query will not execute before this time.
  - scheduleEndTime
```
public final Long scheduleEndTime()
```
    The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.
    
    Returns:
    
    The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.
  - executionRoleArn
```
public final String executionRoleArn()
```
    The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.
    
    Returns:
    
    The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.
  - state
```
public final ScheduledQueryState state()
```
    The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ScheduledQueryState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The initial state of the scheduled query. Valid values are ENABLED and DISABLED . Default is ENABLED.
    
    See Also:
    
    ScheduledQueryState
  - stateAsString
```
public final String stateAsString()
```
    The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ScheduledQueryState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The initial state of the scheduled query. Valid values are ENABLED and DISABLED . Default is ENABLED.
    
    See Also:
    
    ScheduledQueryState
  - 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 Map<String,String> tags()
```
    Key-value pairs to associate with the scheduled query for resource management and cost allocation.
    
    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:
    
    Key-value pairs to associate with the scheduled query for resource management and cost allocation.
  - toBuilder
```
public CreateScheduledQueryRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>
    
    Specified by:
    
    toBuilder in class CloudWatchLogsRequest
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateScheduledQueryRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

name

description

queryLanguage

queryLanguageAsString

queryString

hasLogGroupIdentifiers

logGroupIdentifiers

scheduleExpression

timezone

startTimeOffset

destinationConfiguration

scheduleStartTime

scheduleEndTime

executionRoleArn

state

stateAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField