com.oracle.bmc.datacatalog.model

Class SearchResultCollection

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.datacatalog.model.SearchResultCollection

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class SearchResultCollection
extends ExplicitlySetBmcModel

The list of search result items matching the criteria returned from the search operation. Search errors and messages, if any , will be part of the standard error response.

Note: Objects should always be created or deserialized using the SearchResultCollection.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 SearchResultCollection.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchResultCollection.Builder

Constructor Summary

Constructors

Constructor and Description
SearchResultCollection(Integer count, List<SearchResult> items, String query, List<FacetedSearchAggregation> facetedSearchAggregation, List<String> sortableFields) Deprecated.

Method Summary

Modifier and Type	Method and Description
static SearchResultCollection.Builder	builder() Create a new builder.
boolean	equals(Object o)
Integer	getCount() Total number of items returned.
List<FacetedSearchAggregation>	getFacetedSearchAggregation() Aggregations/facets on properties of data objects.
List<SearchResult>	getItems() Search result set.
String	getQuery() String that data objects are to be searched with.
List<String>	getSortableFields() A list of fields or properties used in the sorting of a search result.
int	hashCode()
SearchResultCollection.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultCollection

@Deprecated
 @ConstructorProperties(value={"count","items","query","facetedSearchAggregation","sortableFields"})
public SearchResultCollection(Integer count,
                                                                                                                                               List<SearchResult> items,
                                                                                                                                               String query,
                                                                                                                                               List<FacetedSearchAggregation> facetedSearchAggregation,
                                                                                                                                               List<String> sortableFields)

Deprecated.

Method Detail

builder

public static SearchResultCollection.Builder builder()

Create a new builder.

toBuilder

public SearchResultCollection.Builder toBuilder()

getCount

public Integer getCount()

Total number of items returned.

Returns:

the value

getItems

public List<SearchResult> getItems()

Search result set.

Returns:

the value

getQuery

public String getQuery()

String that data objects are to be searched with.

Returns:

the value

getFacetedSearchAggregation

public List<FacetedSearchAggregation> getFacetedSearchAggregation()

Aggregations/facets on properties of data objects.

Returns:

the value

getSortableFields

public List<String> getSortableFields()

A list of fields or properties used in the sorting of a search result.

Returns:

the value

toString

public String toString()

Overrides:

toString in class 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 ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel