software.amazon.awssdk.services.swf.model

Class GetWorkflowExecutionHistoryRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.swf.model.SwfRequest

software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetWorkflowExecutionHistoryRequest
extends SwfRequest
implements ToCopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetWorkflowExecutionHistoryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetWorkflowExecutionHistoryRequest.Builder	builder()
String	domain() The name of the domain containing the workflow execution.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
WorkflowExecution	execution() Specifies the workflow execution for which to return the history.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maximumPageSize() The maximum number of results that are returned per call.
String	nextPageToken() If NextPageToken is returned there are more results available.
Boolean	reverseOrder() When set to true, returns the events in reverse order.
List<SdkField<?>>	sdkFields()
static Class<? extends GetWorkflowExecutionHistoryRequest.Builder>	serializableBuilderClass()
GetWorkflowExecutionHistoryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

domain

public final String domain()

The name of the domain containing the workflow execution.

Returns:

The name of the domain containing the workflow execution.

execution

public final WorkflowExecution execution()

Specifies the workflow execution for which to return the history.

Returns:

Specifies the workflow execution for which to return the history.

nextPageToken

public final String nextPageToken()

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

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

Returns:

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

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

maximumPageSize

public final Integer maximumPageSize()

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Returns:

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

reverseOrder

public final Boolean reverseOrder()

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Returns:

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

toBuilder

public GetWorkflowExecutionHistoryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>

Specified by:

toBuilder in class SwfRequest

builder

public static GetWorkflowExecutionHistoryRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo