Package com.oracle.bmc.datacatalog.model

Class SearchCriteria

java.lang.Object

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

com.oracle.bmc.datacatalog.model.SearchCriteria

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

Search Query object that allows complex search predicates that cannot be expressed through simple query params.
Note: Objects should always be created or deserialized using the SearchCriteria.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 SearchCriteria.Builder, which maintain a set of all explicitly set fields called SearchCriteria.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	Description
static class	SearchCriteria.Builder

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	Description
SearchCriteria(String query, String facetedQuery, List<String> dimensions, List<FacetedSearchSortRequest> sort, FacetedSearchFilterRequest filters)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SearchCriteria.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<String>	getDimensions()	List of properties of dataObjects that needs to aggregated on for facets.
String	getFacetedQuery()	Query string that a dataObject is to be searched with.
FacetedSearchFilterRequest	getFilters()
String	getQuery()	Search query dsl that defines the query components including fields and predicates.
List<FacetedSearchSortRequest>	getSort()	Array of objects having details about sort field and order.
int	hashCode()
SearchCriteria.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

SearchCriteria

@Deprecated
@ConstructorProperties({"query","facetedQuery","dimensions","sort","filters"})
public SearchCriteria(String query,
                      String facetedQuery,
                      List<String> dimensions,
                      List<FacetedSearchSortRequest> sort,
                      FacetedSearchFilterRequest filters)

Deprecated.

Method Detail

builder

public static SearchCriteria.Builder builder()

Create a new builder.

toBuilder

public SearchCriteria.Builder toBuilder()

getQuery

public String getQuery()

Search query dsl that defines the query components including fields and predicates.

Returns:

the value

getFacetedQuery

public String getFacetedQuery()

Query string that a dataObject is to be searched with.

Used in the faceted query request

Returns:

the value

getDimensions

public List<String> getDimensions()

List of properties of dataObjects that needs to aggregated on for facets.

Returns:

the value

getSort

public List<FacetedSearchSortRequest> getSort()

Array of objects having details about sort field and order.

Returns:

the value

getFilters

public FacetedSearchFilterRequest getFilters()

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