Class ScheduledQuery

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

Scheduled Query

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name.

      Returns:
      The Amazon Resource Name.

    • name

      public final String name()

      The name of the scheduled query.

      Returns:
      The name of the scheduled query.

    • creationTime

      public final Instant creationTime()

      The creation time of the scheduled query.

      Returns:
      The creation time of the scheduled query.

    • state

      public final ScheduledQueryState state()

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

    • stateAsString

      public final String stateAsString()

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

    • previousInvocationTime

      public final Instant previousInvocationTime()

      The last time the scheduled query was run.

      Returns:
      The last time the scheduled query was run.

    • nextInvocationTime

      public final Instant nextInvocationTime()

      The next time the scheduled query is to be run.

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

    • errorReportConfiguration

      public final ErrorReportConfiguration errorReportConfiguration()

      Configuration for scheduled query error reporting.

      Returns:
      Configuration for scheduled query error reporting.

    • targetDestination

      public final TargetDestination targetDestination()

      Target data source where final scheduled query result will be written.

      Returns:
      Target data source where final scheduled query result will be written.

    • lastRunStatus

      public final ScheduledQueryRunStatus lastRunStatus()

      Status of the last scheduled query run.

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

      Returns:
      Status of the last scheduled query run.
      See Also:

    • lastRunStatusAsString

      public final String lastRunStatusAsString()

      Status of the last scheduled query run.

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

      Returns:
      Status of the last scheduled query run.
      See Also:

    • toBuilder

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

    • builder

      public static ScheduledQuery.Builder builder()

    • serializableBuilderClass

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