Package software.amazon.awssdk.services.cloudwatchlogs.model

Class TriggerHistoryRecord

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.TriggerHistoryRecord

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TriggerHistoryRecord.Builder,TriggerHistoryRecord>

@Generated("software.amazon.awssdk:codegen")
public final class TriggerHistoryRecord
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TriggerHistoryRecord.Builder,TriggerHistoryRecord>

A record of a scheduled query execution, including execution status, timestamp, and destination processing results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TriggerHistoryRecord.Builder

Method Summary

Modifier and Type	Method	Description
static TriggerHistoryRecord.Builder	builder()
List<ScheduledQueryDestination>	destinations()	Information about destination processing for this query execution.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorMessage()	Error message if the query execution failed.
ExecutionStatus	executionStatus()	The execution status of the scheduled query run.
String	executionStatusAsString()	The execution status of the scheduled query run.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinations()	For responses, this returns true if the service returned a value for the Destinations property.
int	hashCode()
String	queryId()	The unique identifier for this query execution.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TriggerHistoryRecord.Builder>	serializableBuilderClass()
TriggerHistoryRecord.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Long	triggeredTimestamp()	The timestamp when the scheduled query execution was triggered.

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

queryId

public final String queryId()

The unique identifier for this query execution.

Returns:

The unique identifier for this query execution.

executionStatus

public final ExecutionStatus executionStatus()

The execution status of the scheduled query run.

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

Returns:

The execution status of the scheduled query run.

See Also:

ExecutionStatus

executionStatusAsString

public final String executionStatusAsString()

The execution status of the scheduled query run.

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

Returns:

The execution status of the scheduled query run.

See Also:

ExecutionStatus

triggeredTimestamp

public final Long triggeredTimestamp()

The timestamp when the scheduled query execution was triggered.

Returns:

The timestamp when the scheduled query execution was triggered.

errorMessage

public final String errorMessage()

Error message if the query execution failed.

Returns:

Error message if the query execution failed.

hasDestinations

public final boolean hasDestinations()

For responses, this returns true if the service returned a value for the Destinations 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.

destinations

public final List<ScheduledQueryDestination> destinations()

Information about destination processing for this query execution.

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

Returns:

Information about destination processing for this query execution.

toBuilder

public TriggerHistoryRecord.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TriggerHistoryRecord.Builder,TriggerHistoryRecord>

builder

public static TriggerHistoryRecord.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo