Interface SearchEntitiesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchEntitiesRequest.Builder,
,SearchEntitiesRequest> IoTThingsGraphRequest.Builder
,SdkBuilder<SearchEntitiesRequest.Builder,
,SearchEntitiesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchEntitiesRequest
-
Method Summary
Modifier and TypeMethodDescriptionentityTypes
(Collection<EntityType> entityTypes) The entity types for which to search.entityTypes
(EntityType... entityTypes) The entity types for which to search.entityTypesWithStrings
(String... entityTypes) The entity types for which to search.entityTypesWithStrings
(Collection<String> entityTypes) The entity types for which to search.filters
(Collection<EntityFilter> filters) Optional filter to apply to the search.filters
(Consumer<EntityFilter.Builder>... filters) Optional filter to apply to the search.filters
(EntityFilter... filters) Optional filter to apply to the search.maxResults
(Integer maxResults) The maximum number of results to return in the response.namespaceVersion
(Long namespaceVersion) The version of the user's namespace.The string that specifies the next page of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.iotthingsgraph.model.IoTThingsGraphRequest.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
-
entityTypesWithStrings
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
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
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
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
Optional filter to apply to the search. Valid filters are
NAME
NAMESPACE
,SEMANTIC_TYPE_PATH
andREFERENCED_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 areNAME
NAMESPACE
,SEMANTIC_TYPE_PATH
andREFERENCED_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
Optional filter to apply to the search. Valid filters are
NAME
NAMESPACE
,SEMANTIC_TYPE_PATH
andREFERENCED_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 areNAME
NAMESPACE
,SEMANTIC_TYPE_PATH
andREFERENCED_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
Optional filter to apply to the search. Valid filters are
NAME
NAMESPACE
,SEMANTIC_TYPE_PATH
andREFERENCED_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 theEntityFilter.Builder
avoiding the need to create one manually viaEntityFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<EntityFilter>)
.- Parameters:
filters
- a consumer that will call methods onEntityFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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) 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
SearchEntitiesRequest.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.
-