FreeTextSearchDetails¶
- class oci.marketplace.models.FreeTextSearchDetails(**kwargs)¶
Bases:
SearchListingsDetailsA request containing arbitrary text that must be present in the Marketplace Applications.
Attributes:
A constant which can be used with the matching_context_type property of a SearchListingsDetails.
A constant which can be used with the matching_context_type property of a SearchListingsDetails.
A constant which can be used with the type property of a SearchListingsDetails.
A constant which can be used with the type property of a SearchListingsDetails.
Gets the matching_context_type of this SearchListingsDetails.
[Required] Gets the text of this FreeTextSearchDetails.
[Required] Gets the type of this SearchListingsDetails.
Methods:
__init__(**kwargs)Initializes a new FreeTextSearchDetails 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 SearchListingsDetails. 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 SearchListingsDetails. This constant has a value of “NONE”
- TYPE_FREE_TEXT = 'FreeText'¶
A constant which can be used with the type property of a SearchListingsDetails. This constant has a value of “FreeText”
- TYPE_STRUCTURED = 'Structured'¶
A constant which can be used with the type property of a SearchListingsDetails. This constant has a value of “Structured”
- __init__(**kwargs)¶
Initializes a new FreeTextSearchDetails object with values from keyword arguments. The default value of the
typeattribute of this class isFreeTextand 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 FreeTextSearchDetails. Allowed values for this property are: “FreeText”, “Structured”
matching_context_type (str) – The value to assign to the matching_context_type property of this FreeTextSearchDetails. Allowed values for this property are: “NONE”, “HIGHLIGHTS”
text (str) – The value to assign to the text property of this FreeTextSearchDetails.
- 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.
- property matching_context_type¶
Gets the matching_context_type of this SearchListingsDetails. The type of matching context returned in the response. If you specify HIGHLIGHTS, then the service will highlight fragments in its response. The default value is NONE.
Allowed values for this property are: “NONE”, “HIGHLIGHTS”
- Returns
The matching_context_type of this SearchListingsDetails.
- Return type
str
- property text¶
[Required] Gets the text of this FreeTextSearchDetails. The text to search for.
- Returns
The text of this FreeTextSearchDetails.
- Return type
str
- property type¶
[Required] Gets the type of this SearchListingsDetails. The type of SearchDetails, whether FreeText or Structured.
Allowed values for this property are: “FreeText”, “Structured”
- Returns
The type of this SearchListingsDetails.
- Return type
str