Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /proc/self/root/usr/share/mysqlsh/oci_sdk/oci/resource_search/models/ |
# coding: utf-8
# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class SearchDetails(object):
"""
A base request type containing common criteria for searching for resources.
"""
#: A constant which can be used with the matching_context_type property of a SearchDetails.
#: This constant has a value of "NONE"
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 "HIGHLIGHTS"
MATCHING_CONTEXT_TYPE_HIGHLIGHTS = "HIGHLIGHTS"
def __init__(self, **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:
* :class:`~oci.resource_search.models.StructuredSearchDetails`
* :class:`~oci.resource_search.models.FreeTextSearchDetails`
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param type:
The value to assign to the type property of this SearchDetails.
:type type: str
:param matching_context_type:
The value to assign to the matching_context_type property of this SearchDetails.
Allowed values for this property are: "NONE", "HIGHLIGHTS"
:type matching_context_type: str
"""
self.swagger_types = {
'type': 'str',
'matching_context_type': 'str'
}
self.attribute_map = {
'type': 'type',
'matching_context_type': 'matchingContextType'
}
self._type = None
self._matching_context_type = None
@staticmethod
def 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.
"""
type = object_dictionary['type']
if type == 'Structured':
return 'StructuredSearchDetails'
if type == 'FreeText':
return 'FreeTextSearchDetails'
else:
return 'SearchDetails'
@property
def type(self):
"""
**[Required]** Gets the type of this SearchDetails.
The type of SearchDetails, whether `FreeText` or `Structured`.
:return: The type of this SearchDetails.
:rtype: str
"""
return self._type
@type.setter
def type(self, type):
"""
Sets the type of this SearchDetails.
The type of SearchDetails, whether `FreeText` or `Structured`.
:param type: The type of this SearchDetails.
:type: str
"""
self._type = type
@property
def matching_context_type(self):
"""
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"
:return: The matching_context_type of this SearchDetails.
:rtype: str
"""
return self._matching_context_type
@matching_context_type.setter
def matching_context_type(self, matching_context_type):
"""
Sets 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`.
:param matching_context_type: The matching_context_type of this SearchDetails.
:type: str
"""
allowed_values = ["NONE", "HIGHLIGHTS"]
if not value_allowed_none_or_none_sentinel(matching_context_type, allowed_values):
raise ValueError(
"Invalid value for `matching_context_type`, must be None or one of {0}"
.format(allowed_values)
)
self._matching_context_type = matching_context_type
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other