FacetedSearchAggregation¶
- class oci.data_catalog.models.FacetedSearchAggregation(**kwargs)¶
Bases:
objectAggregation/facets on properties of data object.
Attributes:
A constant which can be used with the property_type property of a FacetedSearchAggregation.
A constant which can be used with the property_type property of a FacetedSearchAggregation.
Gets the aggregation of this FacetedSearchAggregation.
Gets the data_type of this FacetedSearchAggregation.
Gets the property_type of this FacetedSearchAggregation.
Gets the type of this FacetedSearchAggregation.
Methods:
__init__(**kwargs)Initializes a new FacetedSearchAggregation object with values from keyword arguments.
- PROPERTY_TYPE_CUSTOM_PROPERTY = 'CUSTOM_PROPERTY'¶
A constant which can be used with the property_type property of a FacetedSearchAggregation. This constant has a value of “CUSTOM_PROPERTY”
- PROPERTY_TYPE_DEFAULT_PROPERTY = 'DEFAULT_PROPERTY'¶
A constant which can be used with the property_type property of a FacetedSearchAggregation. This constant has a value of “DEFAULT_PROPERTY”
- __init__(**kwargs)¶
Initializes a new FacetedSearchAggregation object with values from keyword arguments. 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 FacetedSearchAggregation.
aggregation (dict(str, int)) – The value to assign to the aggregation property of this FacetedSearchAggregation.
data_type (str) – The value to assign to the data_type property of this FacetedSearchAggregation.
property_type (str) – The value to assign to the property_type property of this FacetedSearchAggregation. Allowed values for this property are: “CUSTOM_PROPERTY”, “DEFAULT_PROPERTY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property aggregation¶
Gets the aggregation of this FacetedSearchAggregation. Count of number of data objects having property.
- Returns
The aggregation of this FacetedSearchAggregation.
- Return type
dict(str, int)
- property data_type¶
Gets the data_type of this FacetedSearchAggregation. Data type of object property.
- Returns
The data_type of this FacetedSearchAggregation.
- Return type
str
- property property_type¶
Gets the property_type of this FacetedSearchAggregation. Type of property that indicates if it was defined by the user or system. CUSTOM_PROPERTY is defined by the user on a data object. DEFAULT_PROPERTY is defined by the system on a data object.
Allowed values for this property are: “CUSTOM_PROPERTY”, “DEFAULT_PROPERTY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The property_type of this FacetedSearchAggregation.
- Return type
str
- property type¶
Gets the type of this FacetedSearchAggregation. Name of data object property
- Returns
The type of this FacetedSearchAggregation.
- Return type
str