QueryableFieldDescription¶
- class oci.resource_search.models.QueryableFieldDescription(**kwargs)¶
Bases:
objectAn individual field that can be used as part of a query filter.
Attributes:
A constant which can be used with the field_type property of a QueryableFieldDescription.
A constant which can be used with the field_type property of a QueryableFieldDescription.
A constant which can be used with the field_type property of a QueryableFieldDescription.
A constant which can be used with the field_type property of a QueryableFieldDescription.
A constant which can be used with the field_type property of a QueryableFieldDescription.
A constant which can be used with the field_type property of a QueryableFieldDescription.
A constant which can be used with the field_type property of a QueryableFieldDescription.
A constant which can be used with the field_type property of a QueryableFieldDescription.
[Required] Gets the field_name of this QueryableFieldDescription.
[Required] Gets the field_type of this QueryableFieldDescription.
Gets the is_array of this QueryableFieldDescription.
Gets the object_properties of this QueryableFieldDescription.
Methods:
__init__(**kwargs)Initializes a new QueryableFieldDescription object with values from keyword arguments.
- FIELD_TYPE_BOOLEAN = 'BOOLEAN'¶
A constant which can be used with the field_type property of a QueryableFieldDescription. This constant has a value of “BOOLEAN”
- FIELD_TYPE_DATETIME = 'DATETIME'¶
A constant which can be used with the field_type property of a QueryableFieldDescription. This constant has a value of “DATETIME”
- FIELD_TYPE_IDENTIFIER = 'IDENTIFIER'¶
A constant which can be used with the field_type property of a QueryableFieldDescription. This constant has a value of “IDENTIFIER”
- FIELD_TYPE_INTEGER = 'INTEGER'¶
A constant which can be used with the field_type property of a QueryableFieldDescription. This constant has a value of “INTEGER”
- FIELD_TYPE_IP = 'IP'¶
A constant which can be used with the field_type property of a QueryableFieldDescription. This constant has a value of “IP”
- FIELD_TYPE_OBJECT = 'OBJECT'¶
A constant which can be used with the field_type property of a QueryableFieldDescription. This constant has a value of “OBJECT”
- FIELD_TYPE_RATIONAL = 'RATIONAL'¶
A constant which can be used with the field_type property of a QueryableFieldDescription. This constant has a value of “RATIONAL”
- FIELD_TYPE_STRING = 'STRING'¶
A constant which can be used with the field_type property of a QueryableFieldDescription. This constant has a value of “STRING”
- __init__(**kwargs)¶
Initializes a new QueryableFieldDescription object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
field_type (str) – The value to assign to the field_type property of this QueryableFieldDescription. Allowed values for this property are: “IDENTIFIER”, “STRING”, “INTEGER”, “RATIONAL”, “BOOLEAN”, “DATETIME”, “IP”, “OBJECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
field_name (str) – The value to assign to the field_name property of this QueryableFieldDescription.
is_array (bool) – The value to assign to the is_array property of this QueryableFieldDescription.
object_properties (list[oci.resource_search.models.QueryableFieldDescription]) – The value to assign to the object_properties property of this QueryableFieldDescription.
- property field_name¶
[Required] Gets the field_name of this QueryableFieldDescription. The name of the field to use when constructing the query. Field names are present for all types except OBJECT.
- Returns
The field_name of this QueryableFieldDescription.
- Return type
str
- property field_type¶
[Required] Gets the field_type of this QueryableFieldDescription. The type of the field, which dictates what semantics and query constraints you can use when searching or querying.
Allowed values for this property are: “IDENTIFIER”, “STRING”, “INTEGER”, “RATIONAL”, “BOOLEAN”, “DATETIME”, “IP”, “OBJECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The field_type of this QueryableFieldDescription.
- Return type
str
- property is_array¶
Gets the is_array of this QueryableFieldDescription. Indicates that this field is actually an array of the specified field type.
- Returns
The is_array of this QueryableFieldDescription.
- Return type
bool
- property object_properties¶
Gets the object_properties of this QueryableFieldDescription. If the field type is OBJECT, then this property will provide all the individual properties of the object that can be queried.
- Returns
The object_properties of this QueryableFieldDescription.
- Return type