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)
WorkflowExecution	execution() Specifies the workflow execution for which to return the history.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maximumPageSize() The maximum number of results that are returned per call.
String	nextPageToken() If a NextPageToken was returned by a previous call, 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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domain

public String domain()

The name of the domain containing the workflow execution.

Returns:

The name of the domain containing the workflow execution.

execution

public 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 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.

maximumPageSize

public Integer maximumPageSize()

The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Returns:

The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

reverseOrder

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

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<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>

Specified by:

toBuilder in class SwfRequest

Returns:

a builder for type T

builder

public static GetWorkflowExecutionHistoryRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.