FieldInfo

class oci.loggingsearch.models.FieldInfo(**kwargs)

Bases: object

Contains field schema information.

Attributes

FIELD_TYPE_ARRAY A constant which can be used with the field_type property of a FieldInfo.
FIELD_TYPE_BOOLEAN A constant which can be used with the field_type property of a FieldInfo.
FIELD_TYPE_NUMBER A constant which can be used with the field_type property of a FieldInfo.
FIELD_TYPE_STRING A constant which can be used with the field_type property of a FieldInfo.
field_name [Required] Gets the field_name of this FieldInfo.
field_type [Required] Gets the field_type of this FieldInfo.

Methods

__init__(**kwargs) Initializes a new FieldInfo object with values from keyword arguments.
FIELD_TYPE_ARRAY = 'ARRAY'

A constant which can be used with the field_type property of a FieldInfo. This constant has a value of “ARRAY”

FIELD_TYPE_BOOLEAN = 'BOOLEAN'

A constant which can be used with the field_type property of a FieldInfo. This constant has a value of “BOOLEAN”

FIELD_TYPE_NUMBER = 'NUMBER'

A constant which can be used with the field_type property of a FieldInfo. This constant has a value of “NUMBER”

FIELD_TYPE_STRING = 'STRING'

A constant which can be used with the field_type property of a FieldInfo. This constant has a value of “STRING”

__init__(**kwargs)

Initializes a new FieldInfo object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • field_name (str) – The value to assign to the field_name property of this FieldInfo.
  • field_type (str) – The value to assign to the field_type property of this FieldInfo. Allowed values for this property are: “STRING”, “NUMBER”, “BOOLEAN”, “ARRAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
field_name

[Required] Gets the field_name of this FieldInfo. Field name

Returns:The field_name of this FieldInfo.
Return type:str
field_type

[Required] Gets the field_type of this FieldInfo. Field type - * STRING: A sequence of characters. * NUMBER: Numeric type which can be an integer or floating point. * BOOLEAN: Either true or false. * ARRAY: An ordered collection of values.

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

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