Class GetScheduledQueryResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsResponse
software.amazon.awssdk.services.cloudwatchlogs.model.GetScheduledQueryResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetScheduledQueryResponse.Builder,GetScheduledQueryResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetScheduledQueryResponse extends CloudWatchLogsResponse implements ToCopyableBuilder<GetScheduledQueryResponse.Builder,GetScheduledQueryResponse>

  • Method Details

    • scheduledQueryArn

      public final String scheduledQueryArn()

      The Amazon Resource Name (ARN) of the scheduled query.

      Returns:
      The Amazon Resource Name (ARN) of the scheduled query.

    • name

      public final String name()

      The name of the scheduled query.

      Returns:
      The name of the scheduled query.

    • description

      public final String description()

      The description of the scheduled query.

      Returns:
      The description of the scheduled query.

    • queryLanguage

      public final QueryLanguage queryLanguage()

      The query language used by the scheduled query (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:
      The query language used by the scheduled query (LogsQL, PPL, or SQL).
      See Also:

    • queryLanguageAsString

      public final String queryLanguageAsString()

      The query language used by the scheduled query (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:
      The query language used by the scheduled query (LogsQL, PPL, or SQL).
      See Also:

    • queryString

      public final String queryString()

      The CloudWatch Logs Insights query string being executed.

      Returns:
      The CloudWatch Logs Insights query string being executed.

    • 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 being queried by 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 hasLogGroupIdentifiers() method.

      Returns:
      The log group identifiers being queried by the scheduled query.

    • scheduleExpression

      public final String scheduleExpression()

      The cron expression that defines when the scheduled query runs.

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

    • timezone

      public final String timezone()

      The timezone in which the schedule expression is evaluated.

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

    • startTimeOffset

      public final Long startTimeOffset()

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

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

    • destinationConfiguration

      public final DestinationConfiguration destinationConfiguration()

      Configuration for destinations where the query results are delivered.

      Returns:
      Configuration for destinations where the query results are delivered.

    • state

      public final ScheduledQueryState state()

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

    • stateAsString

      public final String stateAsString()

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

    • lastTriggeredTime

      public final Long lastTriggeredTime()

      The time when the scheduled query was last executed, in Unix epoch time.

      Returns:
      The time when the scheduled query was last executed, in Unix epoch time.

    • lastExecutionStatus

      public final ExecutionStatus lastExecutionStatus()

      The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).

      If the service returns an enum value that is not available in the current SDK version, lastExecutionStatus will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lastExecutionStatusAsString().

      Returns:
      The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).
      See Also:

    • lastExecutionStatusAsString

      public final String lastExecutionStatusAsString()

      The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).

      If the service returns an enum value that is not available in the current SDK version, lastExecutionStatus will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lastExecutionStatusAsString().

      Returns:
      The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).
      See Also:

    • scheduleStartTime

      public final Long scheduleStartTime()

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

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

    • scheduleEndTime

      public final Long scheduleEndTime()

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

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

    • executionRoleArn

      public final String executionRoleArn()

      The ARN of the IAM role used to execute the scheduled query.

      Returns:
      The ARN of the IAM role used to execute the scheduled query.

    • creationTime

      public final Long creationTime()

      The time when the scheduled query was created, in Unix epoch time.

      Returns:
      The time when the scheduled query was created, in Unix epoch time.

    • lastUpdatedTime

      public final Long lastUpdatedTime()

      The time when the scheduled query was last updated, in Unix epoch time.

      Returns:
      The time when the scheduled query was last updated, in Unix epoch time.

    • toBuilder

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

    • builder

      public static GetScheduledQueryResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.