Class UpdateScheduledQueryRequest

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.UpdateScheduledQueryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateScheduledQueryRequest.Builder,UpdateScheduledQueryRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateScheduledQueryRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<UpdateScheduledQueryRequest.Builder,UpdateScheduledQueryRequest>

  • Method Details

    • identifier

      public final String identifier()

      The name or ARN of the scheduled query to update.

      Returns:
      The name or ARN of the scheduled query to update.

    • description

      public final String description()

      Updated description for the scheduled query.

      Returns:
      Updated description for the scheduled query.

    • queryLanguage

      public final QueryLanguage queryLanguage()

      Updated query language to use (LogsQL, PPL, or 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:
      Updated query language to use (LogsQL, PPL, or SQL).
      See Also:

    • queryLanguageAsString

      public final String queryLanguageAsString()

      Updated query language to use (LogsQL, PPL, or 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:
      Updated query language to use (LogsQL, PPL, or SQL).
      See Also:

    • queryString

      public final String queryString()

      Updated CloudWatch Logs Insights query string to execute.

      Returns:
      Updated CloudWatch Logs Insights query string to execute.

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

      Updated log group identifiers to 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 hasLogGroupIdentifiers() method.

      Returns:
      Updated log group identifiers to query.

    • scheduleExpression

      public final String scheduleExpression()

      Updated cron expression that defines when the scheduled query runs.

      Returns:
      Updated cron expression that defines when the scheduled query runs.

    • timezone

      public final String timezone()

      Updated timezone in which the schedule expression is evaluated.

      Returns:
      Updated timezone in which the schedule expression is evaluated.

    • startTimeOffset

      public final Long startTimeOffset()

      Updated time offset in seconds from the execution time for the start of the query time range.

      Returns:
      Updated time offset in seconds from the execution time for the start of the query time range.

    • destinationConfiguration

      public final DestinationConfiguration destinationConfiguration()

      Updated configuration for destinations where the query results will be delivered.

      Returns:
      Updated configuration for destinations where the query results will be delivered.

    • scheduleStartTime

      public final Long scheduleStartTime()

      Updated start time for the query schedule in Unix epoch time.

      Returns:
      Updated start time for the query schedule in Unix epoch time.

    • scheduleEndTime

      public final Long scheduleEndTime()

      Updated end time for the query schedule in Unix epoch time.

      Returns:
      Updated end time for the query schedule in Unix epoch time.

    • executionRoleArn

      public final String executionRoleArn()

      Updated ARN of the IAM role that CloudWatch Logs will assume to execute the scheduled query.

      Returns:
      Updated ARN of the IAM role that CloudWatch Logs will assume to execute the scheduled query.

    • state

      public final ScheduledQueryState state()

      Updated state of the scheduled query (ENABLED or DISABLED).

      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:
      Updated state of the scheduled query (ENABLED or DISABLED).
      See Also:

    • stateAsString

      public final String stateAsString()

      Updated state of the scheduled query (ENABLED or DISABLED).

      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:
      Updated state of the scheduled query (ENABLED or DISABLED).
      See Also:

    • toBuilder

      public UpdateScheduledQueryRequest.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<UpdateScheduledQueryRequest.Builder,UpdateScheduledQueryRequest>
      Specified by:
      toBuilder in class CloudWatchLogsRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateScheduledQueryRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateScheduledQueryRequest.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.