QueryableFieldSummary¶

class oci.optimizer.models.QueryableFieldSummary(**kwargs)¶

Bases: object

An individual field that can be used as part of a query filter.

Attributes

`FIELD_TYPE_BOOLEAN`	A constant which can be used with the field_type property of a QueryableFieldSummary.
`FIELD_TYPE_DATE_TIME`	A constant which can be used with the field_type property of a QueryableFieldSummary.
`FIELD_TYPE_INTEGER`	A constant which can be used with the field_type property of a QueryableFieldSummary.
`FIELD_TYPE_OBJECT`	A constant which can be used with the field_type property of a QueryableFieldSummary.
`FIELD_TYPE_STRING`	A constant which can be used with the field_type property of a QueryableFieldSummary.
`field_name`	[Required] Gets the field_name of this QueryableFieldSummary.
`field_type`	[Required] Gets the field_type of this QueryableFieldSummary.
`object_properties`	Gets the object_properties of this QueryableFieldSummary.

Methods

__init__(**kwargs) Initializes a new QueryableFieldSummary object with values from keyword arguments.

FIELD_TYPE_BOOLEAN = 'BOOLEAN'¶: A constant which can be used with the field_type property of a QueryableFieldSummary. This constant has a value of “BOOLEAN”

FIELD_TYPE_DATE_TIME = 'DATE_TIME'¶: A constant which can be used with the field_type property of a QueryableFieldSummary. This constant has a value of “DATE_TIME”

FIELD_TYPE_INTEGER = 'INTEGER'¶: A constant which can be used with the field_type property of a QueryableFieldSummary. This constant has a value of “INTEGER”

FIELD_TYPE_OBJECT = 'OBJECT'¶: A constant which can be used with the field_type property of a QueryableFieldSummary. This constant has a value of “OBJECT”

FIELD_TYPE_STRING = 'STRING'¶: A constant which can be used with the field_type property of a QueryableFieldSummary. This constant has a value of “STRING”

__init__(**kwargs)¶

Initializes a new QueryableFieldSummary 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 QueryableFieldSummary. Allowed values for this property are: “STRING”, “INTEGER”, “BOOLEAN”, “DATE_TIME”, “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 QueryableFieldSummary.
object_properties (list[oci.optimizer.models.QueryableFieldSummary]) – The value to assign to the object_properties property of this QueryableFieldSummary.

field_name¶

[Required] Gets the field_name of this QueryableFieldSummary. 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 QueryableFieldSummary.
Return type:	str

field_type¶

[Required] Gets the field_type of this QueryableFieldSummary. The type of the field, which dictates the semantics and query constraints that you can use when searching or querying.

Allowed values for this property are: “STRING”, “INTEGER”, “BOOLEAN”, “DATE_TIME”, “OBJECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The field_type of this QueryableFieldSummary.
Return type:	str

object_properties¶

Gets the object_properties of this QueryableFieldSummary. If the field type is OBJECT, this property lists the individual properties of the object that can be queried.

Returns:	The object_properties of this QueryableFieldSummary.
Return type:	list[oci.optimizer.models.QueryableFieldSummary]