Class ScheduledQueryDescription

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

Structure that describes scheduled query.

See Also:

  • Method Details

    • arn

      public final String arn()

      Scheduled query ARN.

      Returns:
      Scheduled query ARN.

    • name

      public final String name()

      Name of the scheduled query.

      Returns:
      Name of the scheduled query.

    • queryString

      public final String queryString()

      The query to be run.

      Returns:
      The query to be run.

    • creationTime

      public final Instant creationTime()

      Creation time of the scheduled query.

      Returns:
      Creation time of the scheduled query.

    • state

      public final ScheduledQueryState state()

      State of the scheduled query.

      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:
      State of the scheduled query.
      See Also:

    • stateAsString

      public final String stateAsString()

      State of the scheduled query.

      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:
      State of the scheduled query.
      See Also:

    • previousInvocationTime

      public final Instant previousInvocationTime()

      Last time the query was run.

      Returns:
      Last time the query was run.

    • nextInvocationTime

      public final Instant nextInvocationTime()

      The next time the scheduled query is scheduled to run.

      Returns:
      The next time the scheduled query is scheduled to run.

    • scheduleConfiguration

      public final ScheduleConfiguration scheduleConfiguration()

      Schedule configuration.

      Returns:
      Schedule configuration.

    • notificationConfiguration

      public final NotificationConfiguration notificationConfiguration()

      Notification configuration.

      Returns:
      Notification configuration.

    • targetConfiguration

      public final TargetConfiguration targetConfiguration()

      Scheduled query target store configuration.

      Returns:
      Scheduled query target store configuration.

    • scheduledQueryExecutionRoleArn

      public final String scheduledQueryExecutionRoleArn()

      IAM role that Timestream uses to run the schedule query.

      Returns:
      IAM role that Timestream uses to run the schedule query.

    • kmsKeyId

      public final String kmsKeyId()

      A customer provided KMS key used to encrypt the scheduled query resource.

      Returns:
      A customer provided KMS key used to encrypt the scheduled query resource.

    • errorReportConfiguration

      public final ErrorReportConfiguration errorReportConfiguration()

      Error-reporting configuration for the scheduled query.

      Returns:
      Error-reporting configuration for the scheduled query.

    • lastRunSummary

      public final ScheduledQueryRunSummary lastRunSummary()

      Runtime summary for the last scheduled query run.

      Returns:
      Runtime summary for the last scheduled query run.

    • hasRecentlyFailedRuns

      public final boolean hasRecentlyFailedRuns()
      For responses, this returns true if the service returned a value for the RecentlyFailedRuns 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.

    • recentlyFailedRuns

      public final List<ScheduledQueryRunSummary> recentlyFailedRuns()

      Runtime summary for the last five failed scheduled query runs.

      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 hasRecentlyFailedRuns() method.

      Returns:
      Runtime summary for the last five failed scheduled query runs.

    • toBuilder

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

    • builder

      public static ScheduledQueryDescription.Builder builder()

    • serializableBuilderClass

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