Interface ListWorkflowRunsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CodeCatalystRequest.Builder, CopyableBuilder<ListWorkflowRunsRequest.Builder,ListWorkflowRunsRequest>, SdkBuilder<ListWorkflowRunsRequest.Builder,ListWorkflowRunsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListWorkflowRunsRequest

@Mutable
@NotThreadSafe
public static interface ListWorkflowRunsRequest.Builder
extends CodeCatalystRequest.Builder, SdkPojo, CopyableBuilder<ListWorkflowRunsRequest.Builder,ListWorkflowRunsRequest>

Method Summary

Modifier and Type	Method	Description
ListWorkflowRunsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to show in a single call to this API.
ListWorkflowRunsRequest.Builder	nextToken(String nextToken)	A token returned from a call to this API to indicate the next batch of results to return, if any.
ListWorkflowRunsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListWorkflowRunsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListWorkflowRunsRequest.Builder	projectName(String projectName)	The name of the project in the space.
ListWorkflowRunsRequest.Builder	sortBy(Collection<WorkflowRunSortCriteria> sortBy)	Information used to sort the items in the returned list.
ListWorkflowRunsRequest.Builder	sortBy(Consumer<WorkflowRunSortCriteria.Builder>... sortBy)	Information used to sort the items in the returned list.
ListWorkflowRunsRequest.Builder	sortBy(WorkflowRunSortCriteria... sortBy)	Information used to sort the items in the returned list.
ListWorkflowRunsRequest.Builder	spaceName(String spaceName)	The name of the space.
ListWorkflowRunsRequest.Builder	workflowId(String workflowId)	The ID of the workflow.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.codecatalyst.model.CodeCatalystRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

spaceName

ListWorkflowRunsRequest.Builder spaceName(String spaceName)

The name of the space.

Parameters:

spaceName - The name of the space.

Returns:

Returns a reference to this object so that method calls can be chained together.

workflowId

ListWorkflowRunsRequest.Builder workflowId(String workflowId)

The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

Parameters:

workflowId - The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

Returns:

Returns a reference to this object so that method calls can be chained together.

projectName

ListWorkflowRunsRequest.Builder projectName(String projectName)

The name of the project in the space.

Parameters:

projectName - The name of the project in the space.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

ListWorkflowRunsRequest.Builder nextToken(String nextToken)

A token returned from a call to this API to indicate the next batch of results to return, if any.

Parameters:

nextToken - A token returned from a call to this API to indicate the next batch of results to return, if any.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

ListWorkflowRunsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

Parameters:

maxResults - The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

Returns:

Returns a reference to this object so that method calls can be chained together.

sortBy

ListWorkflowRunsRequest.Builder sortBy(Collection<WorkflowRunSortCriteria> sortBy)

Information used to sort the items in the returned list.

Parameters:

sortBy - Information used to sort the items in the returned list.

Returns:

Returns a reference to this object so that method calls can be chained together.

sortBy

ListWorkflowRunsRequest.Builder sortBy(WorkflowRunSortCriteria... sortBy)

Information used to sort the items in the returned list.

Parameters:

sortBy - Information used to sort the items in the returned list.

Returns:

Returns a reference to this object so that method calls can be chained together.

sortBy

ListWorkflowRunsRequest.Builder sortBy(Consumer<WorkflowRunSortCriteria.Builder>... sortBy)

Information used to sort the items in the returned list.

This is a convenience method that creates an instance of the WorkflowRunSortCriteria.Builder avoiding the need to create one manually via WorkflowRunSortCriteria.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortBy(List<WorkflowRunSortCriteria>).

Parameters:

sortBy - a consumer that will call methods on WorkflowRunSortCriteria.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sortBy(java.util.Collection<WorkflowRunSortCriteria>)

overrideConfiguration

ListWorkflowRunsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ListWorkflowRunsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.