Package software.amazon.awssdk.services.partnercentralselling.model

Interface ListEngagementsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListEngagementsRequest.Builder,ListEngagementsRequest>, PartnerCentralSellingRequest.Builder, SdkBuilder<ListEngagementsRequest.Builder,ListEngagementsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListEngagementsRequest

public static interface ListEngagementsRequest.Builder
extends PartnerCentralSellingRequest.Builder, SdkPojo, CopyableBuilder<ListEngagementsRequest.Builder,ListEngagementsRequest>

Method Summary

Modifier and Type	Method	Description
ListEngagementsRequest.Builder	catalog(String catalog)	Specifies the catalog related to the request.
ListEngagementsRequest.Builder	createdBy(String... createdBy)	A list of AWS account IDs.
ListEngagementsRequest.Builder	createdBy(Collection<String> createdBy)	A list of AWS account IDs.
ListEngagementsRequest.Builder	engagementIdentifier(String... engagementIdentifier)	An array of strings representing engagement identifiers to retrieve.
ListEngagementsRequest.Builder	engagementIdentifier(Collection<String> engagementIdentifier)	An array of strings representing engagement identifiers to retrieve.
ListEngagementsRequest.Builder	excludeCreatedBy(String... excludeCreatedBy)	An array of strings representing AWS Account IDs.
ListEngagementsRequest.Builder	excludeCreatedBy(Collection<String> excludeCreatedBy)	An array of strings representing AWS Account IDs.
ListEngagementsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in a single call.
ListEngagementsRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
ListEngagementsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListEngagementsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default ListEngagementsRequest.Builder	sort(Consumer<EngagementSort.Builder> sort)	An object that specifies the sort order of the results.
ListEngagementsRequest.Builder	sort(EngagementSort sort)	An object that specifies the sort order of the results.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingRequest.Builder

build

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 Detail

catalog

ListEngagementsRequest.Builder catalog(String catalog)

Specifies the catalog related to the request.

Parameters:

catalog - Specifies the catalog related to the request.

Returns:

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

createdBy

ListEngagementsRequest.Builder createdBy(Collection<String> createdBy)

A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

Parameters:

createdBy - A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

Returns:

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

createdBy

ListEngagementsRequest.Builder createdBy(String... createdBy)

A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

Parameters:

createdBy - A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

Returns:

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

engagementIdentifier

ListEngagementsRequest.Builder engagementIdentifier(Collection<String> engagementIdentifier)

An array of strings representing engagement identifiers to retrieve.

Parameters:

engagementIdentifier - An array of strings representing engagement identifiers to retrieve.

Returns:

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

engagementIdentifier

ListEngagementsRequest.Builder engagementIdentifier(String... engagementIdentifier)

An array of strings representing engagement identifiers to retrieve.

Parameters:

engagementIdentifier - An array of strings representing engagement identifiers to retrieve.

Returns:

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

excludeCreatedBy

ListEngagementsRequest.Builder excludeCreatedBy(Collection<String> excludeCreatedBy)

An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

Parameters:

excludeCreatedBy - An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

Returns:

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

excludeCreatedBy

ListEngagementsRequest.Builder excludeCreatedBy(String... excludeCreatedBy)

An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

Parameters:

excludeCreatedBy - An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

Returns:

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

maxResults

ListEngagementsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in a single call.

Parameters:

maxResults - The maximum number of results to return in a single call.

Returns:

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

nextToken

ListEngagementsRequest.Builder nextToken(String nextToken)

The token for the next set of results. This value is returned from a previous call.

Parameters:

nextToken - The token for the next set of results. This value is returned from a previous call.

Returns:

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

sort

ListEngagementsRequest.Builder sort(EngagementSort sort)

An object that specifies the sort order of the results.

Parameters:

sort - An object that specifies the sort order of the results.

Returns:

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

sort

default ListEngagementsRequest.Builder sort(Consumer<EngagementSort.Builder> sort)

An object that specifies the sort order of the results.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sort(EngagementSort).

Parameters:

sort - a consumer that will call methods on EngagementSort.Builder

Returns:

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

See Also:

sort(EngagementSort)

overrideConfiguration

ListEngagementsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder