Package software.amazon.awssdk.services.swf.model

Class GetWorkflowExecutionHistoryResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.swf.model.SwfResponse

software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetWorkflowExecutionHistoryResponse.Builder,GetWorkflowExecutionHistoryResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetWorkflowExecutionHistoryResponse
extends SwfResponse
implements ToCopyableBuilder<GetWorkflowExecutionHistoryResponse.Builder,GetWorkflowExecutionHistoryResponse>

Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetWorkflowExecutionHistoryResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetWorkflowExecutionHistoryResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<HistoryEvent>	events()	The list of history events.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEvents()	For responses, this returns true if the service returned a value for the Events property.
int	hashCode()
String	nextPageToken()	If a NextPageToken was returned by a previous call, there are more results available.
List<SdkField<?>>	sdkFields()
static Class<? extends GetWorkflowExecutionHistoryResponse.Builder>	serializableBuilderClass()
GetWorkflowExecutionHistoryResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.swf.model.SwfResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasEvents

public final boolean hasEvents()

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

events

public final List<HistoryEvent> events()

The list of history events.

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

Returns:

The list of history events.

nextPageToken

public final String nextPageToken()

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

toBuilder

public GetWorkflowExecutionHistoryResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetWorkflowExecutionHistoryResponse.Builder,GetWorkflowExecutionHistoryResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetWorkflowExecutionHistoryResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetWorkflowExecutionHistoryResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo