SearchEntitiesRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iotthingsgraph.model.IoTThingsGraphRequest
    - - software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SearchEntitiesRequest.Builder,SearchEntitiesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SearchEntitiesRequest
extends IoTThingsGraphRequest
implements ToCopyableBuilder<SearchEntitiesRequest.Builder,SearchEntitiesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SearchEntitiesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SearchEntitiesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SearchEntitiesRequest.Builder`	`builder()`
`List<EntityType>`	`entityTypes()` The entity types for which to search.
`List<String>`	`entityTypesAsStrings()` The entity types for which to search.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<EntityFilter>`	`filters()` Optional filter to apply to the search.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEntityTypes()` Returns true if the EntityTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasFilters()` Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`Integer`	`maxResults()` The maximum number of results to return in the response.
`Long`	`namespaceVersion()` The version of the user's namespace.
`String`	`nextToken()` The string that specifies the next page of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SearchEntitiesRequest.Builder>`	`serializableBuilderClass()`
`SearchEntitiesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - entityTypes
```
public final List<EntityType> entityTypes()
```
    The entity types for which to search.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEntityTypes() to see if a value was sent in this field.
    
    Returns:
    
    The entity types for which to search.
  - hasEntityTypes
```
public final boolean hasEntityTypes()
```
    Returns true if the EntityTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - entityTypesAsStrings
```
public final List<String> entityTypesAsStrings()
```
    The entity types for which to search.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEntityTypes() to see if a value was sent in this field.
    
    Returns:
    
    The entity types for which to search.
  - hasFilters
```
public final boolean hasFilters()
```
    Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - filters
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFilters() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - nextToken
```
public final String nextToken()
```
    The string that specifies the next page of results. Use this when you're paginating results.
    
    Returns:
    
    The string that specifies the next page of results. Use this when you're paginating results.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return in the response.
    
    Returns:
    
    The maximum number of results to return in the response.
  - namespaceVersion
```
public final Long namespaceVersion()
```
    The version of the user's namespace. Defaults to the latest version of the user's namespace.
    
    Returns:
    
    The version of the user's namespace. Defaults to the latest version of the user's namespace.
  - toBuilder
```
public SearchEntitiesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchEntitiesRequest.Builder,SearchEntitiesRequest>
    
    Specified by:
    
    toBuilder in class IoTThingsGraphRequest
  - builder
```
public static SearchEntitiesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SearchEntitiesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SearchEntitiesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

entityTypes

hasEntityTypes

entityTypesAsStrings

hasFilters

filters

nextToken

maxResults

namespaceVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields