@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 ExplicitlySetBmcModel.__explicitlySet__
. The hashCode()
and
equals(Object)
methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__
into account.
The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the
constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
SearchCriteria.Builder |
Constructor and Description |
---|
SearchCriteria(String query,
String facetedQuery,
List<String> dimensions,
List<FacetedSearchSortRequest> sort,
FacetedSearchFilterRequest filters)
Deprecated.
|
Modifier and Type | Method and 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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"query","facetedQuery","dimensions","sort","filters"}) public SearchCriteria(String query, String facetedQuery, List<String> dimensions, List<FacetedSearchSortRequest> sort, FacetedSearchFilterRequest filters)
public static SearchCriteria.Builder builder()
Create a new builder.
public SearchCriteria.Builder toBuilder()
public String getQuery()
Search query dsl that defines the query components including fields and predicates.
public String getFacetedQuery()
Query string that a dataObject is to be searched with. Used in the faceted query request
public List<String> getDimensions()
List of properties of dataObjects that needs to aggregated on for facets.
public List<FacetedSearchSortRequest> getSort()
Array of objects having details about sort field and order.
public FacetedSearchFilterRequest getFilters()
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2023. All rights reserved.