@Generated(value="software.amazon.awssdk:codegen") public final class SearchEntitiesRequest extends IoTThingsGraphRequest implements ToCopyableBuilder<SearchEntitiesRequest.Builder,SearchEntitiesRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
SearchEntitiesRequest.Builder |
| 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()
For responses, this returns true if the service returned a value for the EntityTypes property.
|
boolean |
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEntityTypes() method.
public final boolean hasEntityTypes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEntityTypes() method.
public final boolean hasFilters()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasFilters() method.
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.
public final String nextToken()
The string that specifies the next page of results. Use this when you're paginating results.
public final Integer maxResults()
The maximum number of results to return in the response.
public final Long namespaceVersion()
The version of the user's namespace. Defaults to the latest version of the user's namespace.
public SearchEntitiesRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<SearchEntitiesRequest.Builder,SearchEntitiesRequest>toBuilder in class IoTThingsGraphRequestpublic static SearchEntitiesRequest.Builder builder()
public static Class<? extends SearchEntitiesRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.