com.oracle.bmc.resourcesearch.model

Class SearchContext

java.lang.Object

com.oracle.bmc.resourcesearch.model.SearchContext

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180409")
public final class SearchContext
extends Object

Contains search context, such as highlighting, for found resources.
Note: Objects should always be created or deserialized using the SearchContext.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 SearchContext.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchContext.Builder

Constructor Summary

Constructors

Constructor and Description
SearchContext(Map<String,List<String>> highlights) Deprecated.

Method Summary

Modifier and Type	Method and Description
static SearchContext.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
Map<String,List<String>>	getHighlights() Describes what in each field matched the search criteria by showing highlighted values, but only for free text searches or for structured queries that use a MATCHING clause.
int	hashCode()
SearchContext.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchContext

@ConstructorProperties(value="highlights")
 @Deprecated
public SearchContext(Map<String,List<String>> highlights)

Deprecated.

Method Detail

builder

public static SearchContext.Builder builder()

Create a new builder.

toBuilder

public SearchContext.Builder toBuilder()

getHighlights

public Map<String,List<String>> getHighlights()

Describes what in each field matched the search criteria by showing highlighted values, but only for free text searches or for structured queries that use a MATCHING clause. The list of strings represents fragments of values that matched the query conditions. Highlighted values are wrapped with <h1>..</h1> tags. All values are HTML-encoded (except <h1> tags).

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object