com.oracle.bmc.resourcesearch.model

Class QueryableFieldDescription

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.resourcesearch.model.QueryableFieldDescription

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180409")
public final class QueryableFieldDescription
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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 QueryableFieldDescription.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

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.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
QueryableFieldDescription(QueryableFieldDescription.FieldType fieldType, String fieldName, Boolean isArray, List<QueryableFieldDescription> objectProperties) Deprecated.

Method Summary

Modifier and Type	Method and Description
static QueryableFieldDescription.Builder	builder() Create a new builder.
boolean	equals(Object o)
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 that 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 of the object that can be queried.
int	hashCode()
QueryableFieldDescription.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryableFieldDescription

@Deprecated
 @ConstructorProperties(value={"fieldType","fieldName","isArray","objectProperties"})
public QueryableFieldDescription(QueryableFieldDescription.FieldType fieldType,
                                                                                                                                   String fieldName,
                                                                                                                                   Boolean isArray,
                                                                                                                                   List<QueryableFieldDescription> objectProperties)

Deprecated.

Method Detail

builder

public static QueryableFieldDescription.Builder builder()

Create a new builder.

toBuilder

public QueryableFieldDescription.Builder toBuilder()

getFieldType

public QueryableFieldDescription.FieldType getFieldType()

The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

Returns:

the value

getFieldName

public String getFieldName()

The name of the field to use when constructing the query. Field names are present for all types except OBJECT.

Returns:

the value

getIsArray

public Boolean getIsArray()

Indicates that this field is actually an array of the specified field type.

Returns:

the value

getObjectProperties

public List<QueryableFieldDescription> getObjectProperties()

If the field type is OBJECT, then this property will provide all the individual properties of the object that can be queried.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel