software.amazon.awssdk.services.iotthingsgraph.model

Interface SearchEntitiesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchEntitiesRequest.Builder,SearchEntitiesRequest>, IoTThingsGraphRequest.Builder, SdkBuilder<SearchEntitiesRequest.Builder,SearchEntitiesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchEntitiesRequest

public static interface SearchEntitiesRequest.Builder
extends IoTThingsGraphRequest.Builder, SdkPojo, CopyableBuilder<SearchEntitiesRequest.Builder,SearchEntitiesRequest>

Method Summary

Modifier and Type	Method and Description
SearchEntitiesRequest.Builder	entityTypes(Collection<EntityType> entityTypes) The entity types for which to search.
SearchEntitiesRequest.Builder	entityTypes(EntityType... entityTypes) The entity types for which to search.
SearchEntitiesRequest.Builder	entityTypesWithStrings(Collection<String> entityTypes) The entity types for which to search.
SearchEntitiesRequest.Builder	entityTypesWithStrings(String... entityTypes) The entity types for which to search.
SearchEntitiesRequest.Builder	filters(Collection<EntityFilter> filters) Optional filter to apply to the search.
SearchEntitiesRequest.Builder	filters(Consumer<EntityFilter.Builder>... filters) Optional filter to apply to the search.
SearchEntitiesRequest.Builder	filters(EntityFilter... filters) Optional filter to apply to the search.
SearchEntitiesRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return in the response.
SearchEntitiesRequest.Builder	namespaceVersion(Long namespaceVersion) The version of the user's namespace.
SearchEntitiesRequest.Builder	nextToken(String nextToken) The string that specifies the next page of results.
SearchEntitiesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchEntitiesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.iotthingsgraph.model.IoTThingsGraphRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

entityTypesWithStrings

SearchEntitiesRequest.Builder entityTypesWithStrings(Collection<String> entityTypes)

The entity types for which to search.

Parameters:

entityTypes - The entity types for which to search.

Returns:

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

entityTypesWithStrings

SearchEntitiesRequest.Builder entityTypesWithStrings(String... entityTypes)

The entity types for which to search.

Parameters:

entityTypes - The entity types for which to search.

Returns:

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

entityTypes

SearchEntitiesRequest.Builder entityTypes(Collection<EntityType> entityTypes)

The entity types for which to search.

Parameters:

entityTypes - The entity types for which to search.

Returns:

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

entityTypes

SearchEntitiesRequest.Builder entityTypes(EntityType... entityTypes)

The entity types for which to search.

Parameters:

entityTypes - The entity types for which to search.

Returns:

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

filters

SearchEntitiesRequest.Builder filters(Collection<EntityFilter> filters)

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Parameters:

filters - Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Returns:

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

filters

SearchEntitiesRequest.Builder filters(EntityFilter... filters)

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Parameters:

filters - Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Returns:

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

filters

SearchEntitiesRequest.Builder filters(Consumer<EntityFilter.Builder>... filters)

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

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

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

Parameters:

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

Returns:

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

See Also:

#filters(java.util.Collection)

nextToken

SearchEntitiesRequest.Builder nextToken(String nextToken)

The string that specifies the next page of results. Use this when you're paginating results.

Parameters:

nextToken - The string that specifies the next page of results. Use this when you're paginating results.

Returns:

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

maxResults

SearchEntitiesRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in the response.

Parameters:

maxResults - The maximum number of results to return in the response.

Returns:

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

namespaceVersion

SearchEntitiesRequest.Builder namespaceVersion(Long namespaceVersion)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Parameters:

namespaceVersion - The version of the user's namespace. Defaults to the latest version of the user's namespace.

Returns:

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

overrideConfiguration

SearchEntitiesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder