Class ScheduledQuerySummary

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.ScheduledQuerySummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScheduledQuerySummary.Builder,ScheduledQuerySummary>
@Generated("software.amazon.awssdk:codegen") public final class ScheduledQuerySummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledQuerySummary.Builder,ScheduledQuerySummary>

Summary information about a scheduled query, used in list operations.

See Also:

  • Method Details

    • scheduledQueryArn

      public final String scheduledQueryArn()

      The ARN of the scheduled query.

      Returns:
      The ARN of the scheduled query.

    • name

      public final String name()

      The name of the scheduled query.

      Returns:
      The name of the scheduled query.

    • 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.

      Returns:
      The time when the scheduled query was last executed.

    • lastExecutionStatus

      public final ExecutionStatus lastExecutionStatus()

      The status of the last execution (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 execution (Running, Complete, Failed, Timeout, or InvalidQuery).
      See Also:

    • lastExecutionStatusAsString

      public final String lastExecutionStatusAsString()

      The status of the last execution (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 execution (Running, Complete, Failed, Timeout, or InvalidQuery).
      See Also:

    • 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.

    • destinationConfiguration

      public final DestinationConfiguration destinationConfiguration()

      Configuration for destinations where the query results are delivered.

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

    • creationTime

      public final Long creationTime()

      The time when the scheduled query was created.

      Returns:
      The time when the scheduled query was created.

    • lastUpdatedTime

      public final Long lastUpdatedTime()

      The time when the scheduled query was last updated.

      Returns:
      The time when the scheduled query was last updated.

    • toBuilder

      public ScheduledQuerySummary.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<ScheduledQuerySummary.Builder,ScheduledQuerySummary>
      Returns:
      a builder for type T

    • builder

      public static ScheduledQuerySummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

    • 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.