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 Details

    • 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<EntityFilter>).

      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:

    • 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)
      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

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