Package software.amazon.awssdk.services.iottwinmaker.model

Interface ListEntitiesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>, IoTTwinMakerRequest.Builder, SdkBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListEntitiesRequest

@Mutable
@NotThreadSafe
public static interface ListEntitiesRequest.Builder
extends IoTTwinMakerRequest.Builder, SdkPojo, CopyableBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>

Method Summary

Modifier and Type	Method	Description
ListEntitiesRequest.Builder	filters(Collection<ListEntitiesFilter> filters)	A list of objects that filter the request.
ListEntitiesRequest.Builder	filters(Consumer<ListEntitiesFilter.Builder>... filters)	A list of objects that filter the request.
ListEntitiesRequest.Builder	filters(ListEntitiesFilter... filters)	A list of objects that filter the request.
ListEntitiesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return at one time.
ListEntitiesRequest.Builder	nextToken(String nextToken)	The string that specifies the next page of results.
ListEntitiesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListEntitiesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListEntitiesRequest.Builder	workspaceId(String workspaceId)	The ID of the workspace.

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.iottwinmaker.model.IoTTwinMakerRequest.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 Details

workspaceId

ListEntitiesRequest.Builder workspaceId(String workspaceId)

The ID of the workspace.

Parameters:

workspaceId - The ID of the workspace.

Returns:

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

filters

ListEntitiesRequest.Builder filters(Collection<ListEntitiesFilter> filters)

A list of objects that filter the request.

Only one object is accepted as a valid input.

Parameters:

filters - A list of objects that filter the request.

Only one object is accepted as a valid input.

Returns:

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

filters

ListEntitiesRequest.Builder filters(ListEntitiesFilter... filters)

A list of objects that filter the request.

Only one object is accepted as a valid input.

Parameters:

filters - A list of objects that filter the request.

Only one object is accepted as a valid input.

Returns:

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

filters

ListEntitiesRequest.Builder filters(Consumer<ListEntitiesFilter.Builder>... filters)

A list of objects that filter the request.

Only one object is accepted as a valid input.

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

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

Parameters:

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

Returns:

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

See Also:

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

maxResults

ListEntitiesRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

Parameters:

maxResults - The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

Returns:

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

nextToken

ListEntitiesRequest.Builder nextToken(String nextToken)

The string that specifies the next page of results.

Parameters:

nextToken - The string that specifies the next page of results.

Returns:

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

overrideConfiguration

ListEntitiesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder