Package software.amazon.awssdk.services.timestreamquery.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScheduledQueryRunSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ScheduledQueryRunSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorReportLocation	errorReportLocation()	S3 location for error report.
ExecutionStats	executionStats()	Runtime statistics for a scheduled run.
String	failureReason()	Error message for the scheduled query in case of failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	invocationTime()	InvocationTime for this run.
ScheduledQueryRunStatus	runStatus()	The status of a scheduled query run.
String	runStatusAsString()	The status of a scheduled query run.
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduledQueryRunSummary.Builder>	serializableBuilderClass()
ScheduledQueryRunSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	triggerTime()	The actual time when the query was run.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ScheduledQueryRunStatus

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:

ScheduledQueryRunStatus

executionStats

public final ExecutionStats executionStats()

Runtime statistics for a scheduled run.

Returns:

Runtime statistics for a scheduled run.

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

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduledQueryRunSummary.Builder,ScheduledQueryRunSummary>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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