@Generated(value="OracleSDKGenerator", comments="API Version: 0.0.4") public final class QueryableFieldDescription extends Object
An individual field that can be used as part of a query filter.
Note: Objects should always be created or deserialized using the QueryableFieldDescription.Builder
. This model distinguishes fields that are null
because they are unset from fields that are explicitly set to null
. This is done in the setter methods of the QueryableFieldDescription.Builder
, which maintain a set of all explicitly set fields called __explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take __explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
QueryableFieldDescription.Builder |
static class |
QueryableFieldDescription.FieldType
The type of the field, which dictates what semantics and query constraints you can use when searching or querying.
|
Constructor and Description |
---|
QueryableFieldDescription(QueryableFieldDescription.FieldType fieldType,
String fieldName,
Boolean isArray,
List<QueryableFieldDescription> objectProperties)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static QueryableFieldDescription.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getFieldName()
The name of the field to use when constructing the query.
|
QueryableFieldDescription.FieldType |
getFieldType()
The type of the field, which dictates what semantics and query constraints you can use when searching or querying.
|
Boolean |
getIsArray()
Indicates this field is actually an array of the specified field type.
|
List<QueryableFieldDescription> |
getObjectProperties()
If the field type is
OBJECT , then this property will provide all the individual properties on the object that can be queried. |
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"fieldType","fieldName","isArray","objectProperties"}) @Deprecated public QueryableFieldDescription(QueryableFieldDescription.FieldType fieldType, String fieldName, Boolean isArray, List<QueryableFieldDescription> objectProperties)
public static QueryableFieldDescription.Builder builder()
Create a new builder.
public QueryableFieldDescription.FieldType getFieldType()
The type of the field, which dictates what semantics and query constraints you can use when searching or querying.
public String getFieldName()
The name of the field to use when constructing the query. Field names are present for all types except OBJECT
.
public Boolean getIsArray()
Indicates this field is actually an array of the specified field type.
public List<QueryableFieldDescription> getObjectProperties()
If the field type is OBJECT
, then this property will provide all the individual properties on the object that can be queried.
Copyright © 2016–2019. All rights reserved.