Package software.amazon.awssdk.services.proton.model

Interface ListServiceInstancesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListServiceInstancesRequest.Builder,ListServiceInstancesRequest>, ProtonRequest.Builder, SdkBuilder<ListServiceInstancesRequest.Builder,ListServiceInstancesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListServiceInstancesRequest

public static interface ListServiceInstancesRequest.Builder
extends ProtonRequest.Builder, SdkPojo, CopyableBuilder<ListServiceInstancesRequest.Builder,ListServiceInstancesRequest>

Method Summary

Modifier and Type	Method	Description
ListServiceInstancesRequest.Builder	filters(Collection<ListServiceInstancesFilter> filters)	An array of filtering criteria that scope down the result list.
ListServiceInstancesRequest.Builder	filters(Consumer<ListServiceInstancesFilter.Builder>... filters)	An array of filtering criteria that scope down the result list.
ListServiceInstancesRequest.Builder	filters(ListServiceInstancesFilter... filters)	An array of filtering criteria that scope down the result list.
ListServiceInstancesRequest.Builder	maxResults(Integer maxResults)	The maximum number of service instances to list.
ListServiceInstancesRequest.Builder	nextToken(String nextToken)	A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
ListServiceInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListServiceInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListServiceInstancesRequest.Builder	serviceName(String serviceName)	The name of the service that the service instance belongs to.
ListServiceInstancesRequest.Builder	sortBy(String sortBy)	The field that the result list is sorted by.
ListServiceInstancesRequest.Builder	sortBy(ListServiceInstancesSortBy sortBy)	The field that the result list is sorted by.
ListServiceInstancesRequest.Builder	sortOrder(String sortOrder)	Result list sort order.
ListServiceInstancesRequest.Builder	sortOrder(SortOrder sortOrder)	Result list sort order.

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.proton.model.ProtonRequest.Builder

build

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

filters

ListServiceInstancesRequest.Builder filters(Collection<ListServiceInstancesFilter> filters)

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Parameters:

filters - An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Returns:

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

filters

ListServiceInstancesRequest.Builder filters(ListServiceInstancesFilter... filters)

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Parameters:

filters - An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Returns:

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

filters

ListServiceInstancesRequest.Builder filters(Consumer<ListServiceInstancesFilter.Builder>... filters)

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

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

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

Parameters:

filters - a consumer that will call methods on ListServiceInstancesFilter.Builder

Returns:

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

See Also:

• filters(java.util.Collection<ListServiceInstancesFilter>)

maxResults

ListServiceInstancesRequest.Builder maxResults(Integer maxResults)

The maximum number of service instances to list.

Parameters:

maxResults - The maximum number of service instances to list.

Returns:

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

nextToken

ListServiceInstancesRequest.Builder nextToken(String nextToken)

A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

Parameters:

nextToken - A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

Returns:

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

serviceName

ListServiceInstancesRequest.Builder serviceName(String serviceName)

The name of the service that the service instance belongs to.

Parameters:

serviceName - The name of the service that the service instance belongs to.

Returns:

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

sortBy

ListServiceInstancesRequest.Builder sortBy(String sortBy)

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Parameters:

sortBy - The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Returns:

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

See Also:

• ListServiceInstancesSortBy
• ListServiceInstancesSortBy

sortBy

ListServiceInstancesRequest.Builder sortBy(ListServiceInstancesSortBy sortBy)

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Parameters:

sortBy - The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Returns:

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

See Also:

• ListServiceInstancesSortBy
• ListServiceInstancesSortBy

sortOrder

ListServiceInstancesRequest.Builder sortOrder(String sortOrder)

Result list sort order.

Default: ASCENDING

Parameters:

sortOrder - Result list sort order.

Default: ASCENDING

Returns:

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

See Also:

• SortOrder
• SortOrder

sortOrder

ListServiceInstancesRequest.Builder sortOrder(SortOrder sortOrder)

Result list sort order.

Default: ASCENDING

Parameters:

sortOrder - Result list sort order.

Default: ASCENDING

Returns:

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

See Also:

• SortOrder
• SortOrder

overrideConfiguration

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

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