Interface ListWorkflowRunsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CodeCatalystRequest.Builder
,CopyableBuilder<ListWorkflowRunsRequest.Builder,
,ListWorkflowRunsRequest> SdkBuilder<ListWorkflowRunsRequest.Builder,
,ListWorkflowRunsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListWorkflowRunsRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The maximum number of results to show in a single call to this API.A token returned from a call to this API to indicate the next batch of results to return, if any.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.projectName
(String projectName) The name of the project in the space.sortBy
(Collection<WorkflowRunSortCriteria> sortBy) Information used to sort the items in the returned list.sortBy
(Consumer<WorkflowRunSortCriteria.Builder>... sortBy) Information used to sort the items in the returned list.sortBy
(WorkflowRunSortCriteria... sortBy) Information used to sort the items in the returned list.The name of the space.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, sdkFields
-
Method Details
-
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
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
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
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
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 aNextToken
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
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
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
Information used to sort the items in the returned list.
This is a convenience method that creates an instance of theWorkflowRunSortCriteria.Builder
avoiding the need to create one manually viaWorkflowRunSortCriteria.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortBy(List<WorkflowRunSortCriteria>)
.- Parameters:
sortBy
- a consumer that will call methods onWorkflowRunSortCriteria.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListWorkflowRunsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-