StructuredSearchDetails

class oci.resource_search.models.StructuredSearchDetails(**kwargs)

Bases: oci.resource_search.models.search_details.SearchDetails

A request containing search filters using the structured search query language.

Attributes

MATCHING_CONTEXT_TYPE_HIGHLIGHTS str(object=’‘) -> str
MATCHING_CONTEXT_TYPE_NONE str(object=’‘) -> str
matching_context_type Gets the matching_context_type of this SearchDetails.
query [Required] Gets the query of this StructuredSearchDetails.
type [Required] Gets the type of this SearchDetails.

Methods

__init__(**kwargs) Initializes a new StructuredSearchDetails 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'
MATCHING_CONTEXT_TYPE_NONE = 'NONE'
__init__(**kwargs)

Initializes a new StructuredSearchDetails object with values from keyword arguments. The default value of the type attribute of this class is Structured and it should not be changed. 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 StructuredSearchDetails.
  • matching_context_type (str) – The value to assign to the matching_context_type property of this StructuredSearchDetails. Allowed values for this property are: “NONE”, “HIGHLIGHTS”
  • query (str) – The value to assign to the query property of this StructuredSearchDetails.
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. (See ResourceSummary.searchContext and SearchContext for more information.) The default setting is NONE.

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

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

[Required] Gets the query of this StructuredSearchDetails. The structured query describing which resources to search for.

Returns:The query of this StructuredSearchDetails.
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