Class ScheduledQueryRunSummary

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

Run summary for the scheduled query

See Also:

  • Method Details

    • invocationTime

      public final Instant invocationTime()

      InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.

      Returns:
      InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.

    • triggerTime

      public final Instant triggerTime()

      The actual time when the query was run.

      Returns:
      The actual time when the query was run.

    • runStatus

      public final ScheduledQueryRunStatus runStatus()

      The status of a scheduled query run.

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

      Returns:
      The status of a scheduled query run.
      See Also:

    • runStatusAsString

      public final String runStatusAsString()

      The status of a scheduled query run.

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

      Returns:
      The status of a scheduled query run.
      See Also:

    • executionStats

      public final ExecutionStats executionStats()

      Runtime statistics for a scheduled run.

      Returns:
      Runtime statistics for a scheduled run.

    • queryInsightsResponse

      public final ScheduledQueryInsightsResponse queryInsightsResponse()

      Provides various insights and metrics related to the run summary of the scheduled query.

      Returns:
      Provides various insights and metrics related to the run summary of the scheduled query.

    • errorReportLocation

      public final ErrorReportLocation errorReportLocation()

      S3 location for error report.

      Returns:
      S3 location for error report.

    • failureReason

      public final String failureReason()

      Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.

      Returns:
      Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.

    • toBuilder

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

    • builder

      public static ScheduledQueryRunSummary.Builder builder()

    • serializableBuilderClass

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