Class CreateScheduledQueryRequest

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>

  • Method Details

    • name

      public final String name()

      A unique name for the scheduled query within the region for an AWS account. The name can contain letters, numbers, underscores, hyphens, forward slashes, periods, and hash symbols.

      Returns:
      A unique name for the scheduled query within the region for an AWS account. The name can contain letters, numbers, underscores, hyphens, forward slashes, periods, and hash symbols.

    • description

      public final String description()

      An optional description for the scheduled query to help identify its purpose.

      Returns:
      An optional description for the scheduled query to help identify its purpose.

    • queryLanguage

      public final QueryLanguage queryLanguage()

      The query language to use for the scheduled query. Valid values are LogsQL (CloudWatch Logs Insights query language), PPL (OpenSearch Service Piped Processing Language), and SQL (OpenSearch Service Structured Query Language).

      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 (CloudWatch Logs Insights query language), PPL (OpenSearch Service Piped Processing Language), and SQL (OpenSearch Service Structured Query Language).
      See Also:

    • queryLanguageAsString

      public final String queryLanguageAsString()

      The query language to use for the scheduled query. Valid values are LogsQL (CloudWatch Logs Insights query language), PPL (OpenSearch Service Piped Processing Language), and SQL (OpenSearch Service Structured Query Language).

      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 (CloudWatch Logs Insights query language), PPL (OpenSearch Service Piped Processing Language), and SQL (OpenSearch Service Structured Query Language).
      See Also:

    • queryString

      public final String queryString()

      The CloudWatch Logs Insights query string to execute. This is the actual query that will be run against your log data on the specified schedule.

      Returns:
      The CloudWatch Logs Insights query string to execute. This is the actual query that will be run against your log data on the specified schedule.

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

      The log group identifiers to query. You can specify log group names or log group ARNs. If querying log groups in a source account from a monitoring account, you must specify the ARN of the log group.

      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:
      The log group identifiers to query. You can specify log group names or log group ARNs. If querying log groups in a source account from a monitoring account, you must specify the ARN of the log group.

    • scheduleExpression

      public final String scheduleExpression()

      A cron expression that defines when the scheduled query runs. The format is cron(fields) where fields consist of six space-separated values: minutes, hours, day_of_month, month, day_of_week, year.

      Returns:
      A cron expression that defines when the scheduled query runs. The format is cron(fields) where fields consist of six space-separated values: minutes, hours, day_of_month, month, day_of_week, year.

    • timezone

      public final String timezone()

      The timezone in which the schedule expression is evaluated. If not provided, defaults to UTC.

      Returns:
      The timezone in which the schedule expression is evaluated. If not provided, defaults to UTC.

    • startTimeOffset

      public final Long startTimeOffset()

      Time offset in seconds from the execution time for the start of the query time range. This defines the lookback period for the query (for example, 3600 for the last hour).

      Returns:
      Time offset in seconds from the execution time for the start of the query time range. This defines the lookback period for the query (for example, 3600 for the last hour).

    • destinationConfiguration

      public final DestinationConfiguration destinationConfiguration()

      Configuration for destinations where the query results will be delivered after successful execution. You can configure delivery to S3 buckets or EventBridge event buses.

      Returns:
      Configuration for destinations where the query results will be delivered after successful execution. You can configure delivery to S3 buckets or EventBridge event buses.

    • scheduleStartTime

      public final Long scheduleStartTime()

      The start time for the query schedule in Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC). If not specified, the schedule starts immediately.

      Returns:
      The start time for the query schedule in Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC). If not specified, the schedule starts immediately.

    • scheduleEndTime

      public final Long scheduleEndTime()

      The end time for the query schedule in Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC). If not specified, the schedule runs indefinitely.

      Returns:
      The end time for the query schedule in Unix epoch time (seconds since January 1, 1970, 00:00:00 UTC). If not specified, the schedule runs indefinitely.

    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that CloudWatch Logs will assume to execute the scheduled query and deliver results to the specified destinations.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that CloudWatch Logs will assume to execute the scheduled query and deliver results to the specified destinations.

    • state

      public final ScheduledQueryState state()

      The initial state of the scheduled query. Valid values are ENABLED (the query will run according to its schedule) and DISABLED (the query is paused and will not run). If not provided, defaults to 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 (the query will run according to its schedule) and DISABLED (the query is paused and will not run). If not provided, defaults to ENABLED.
      See Also:

    • stateAsString

      public final String stateAsString()

      The initial state of the scheduled query. Valid values are ENABLED (the query will run according to its schedule) and DISABLED (the query is paused and will not run). If not provided, defaults to 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 (the query will run according to its schedule) and DISABLED (the query is paused and will not run). If not provided, defaults to ENABLED.
      See Also:

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

      An optional list of key-value pairs to associate with the resource.

      For more information about tagging, see Tagging Amazon Web Services resources

      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:
      An optional list of key-value pairs to associate with the resource.

      For more information about tagging, see Tagging Amazon Web Services resources

    • toBuilder

      public CreateScheduledQueryRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateScheduledQueryRequest.Builder,CreateScheduledQueryRequest>
      Specified by:
      toBuilder in class CloudWatchLogsRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.