SearchDetails¶

class oci.resource_search.models.SearchDetails(**kwargs)¶

Bases: object

A base request type that contains common criteria for searching for resources.

Attributes

`MATCHING_CONTEXT_TYPE_HIGHLIGHTS`	A constant which can be used with the matching_context_type property of a SearchDetails.
`MATCHING_CONTEXT_TYPE_NONE`	A constant which can be used with the matching_context_type property of a SearchDetails.
`matching_context_type`	Gets the matching_context_type of this SearchDetails.
`type`	[Required] Gets the type of this SearchDetails.

Methods

`__init__`(**kwargs)	Initializes a new SearchDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

MATCHING_CONTEXT_TYPE_HIGHLIGHTS = 'HIGHLIGHTS'¶: A constant which can be used with the matching_context_type property of a SearchDetails. This constant has a value of “HIGHLIGHTS”

MATCHING_CONTEXT_TYPE_NONE = 'NONE'¶: A constant which can be used with the matching_context_type property of a SearchDetails. This constant has a value of “NONE”

__init__(**kwargs)¶

Initializes a new SearchDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:	type (str) – The value to assign to the type property of this SearchDetails. matching_context_type (str) – The value to assign to the matching_context_type property of this SearchDetails. Allowed values for this property are: “NONE”, “HIGHLIGHTS”

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

matching_context_type¶

Gets the matching_context_type of this SearchDetails. The type of matching context returned in the response. If you specify HIGHLIGHTS, then the service will highlight fragments in its response. (For more information, see ResourceSummary.searchContext and SearchContext.) The default setting is NONE.

Allowed values for this property are: “NONE”, “HIGHLIGHTS”

Returns:	The matching_context_type of this SearchDetails.
Return type:	str

type¶

[Required] Gets the type of this SearchDetails. The type of SearchDetails, whether FreeText or Structured.

Returns:	The type of this SearchDetails.
Return type:	str