FieldsAddRemoveField

class oci.log_analytics.models.FieldsAddRemoveField(**kwargs)

Bases: oci.log_analytics.models.abstract_field.AbstractField

Field denoting a field specified in querylanguage FIELDS command.

Attributes

NAME_FIELD str(object=’’) -> str
NAME_FIELDS str(object=’’) -> str
NAME_FUNCTION str(object=’’) -> str
NAME_SORT str(object=’’) -> str
OPERATION_ADD A constant which can be used with the operation property of a FieldsAddRemoveField.
OPERATION_REMOVE A constant which can be used with the operation property of a FieldsAddRemoveField.
VALUE_TYPE_BOOLEAN str(object=’’) -> str
VALUE_TYPE_DOUBLE str(object=’’) -> str
VALUE_TYPE_FACET str(object=’’) -> str
VALUE_TYPE_FLOAT str(object=’’) -> str
VALUE_TYPE_INTEGER str(object=’’) -> str
VALUE_TYPE_LONG str(object=’’) -> str
VALUE_TYPE_STRING str(object=’’) -> str
VALUE_TYPE_TIMESTAMP str(object=’’) -> str
alias Gets the alias of this AbstractField.
display_name Gets the display_name of this AbstractField.
filter_query_string Gets the filter_query_string of this AbstractField.
internal_name Gets the internal_name of this AbstractField.
is_declared Gets the is_declared of this AbstractField.
is_duration Gets the is_duration of this AbstractField.
is_groupable Gets the is_groupable of this AbstractField.
name [Required] Gets the name of this AbstractField.
operation Gets the operation of this FieldsAddRemoveField.
original_display_names Gets the original_display_names of this AbstractField.
unit_type Gets the unit_type of this AbstractField.
value_type Gets the value_type of this AbstractField.

Methods

__init__(**kwargs) Initializes a new FieldsAddRemoveField object with values from keyword arguments.
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.
NAME_FIELD = 'FIELD'
NAME_FIELDS = 'FIELDS'
NAME_FUNCTION = 'FUNCTION'
NAME_SORT = 'SORT'
OPERATION_ADD = 'ADD'

A constant which can be used with the operation property of a FieldsAddRemoveField. This constant has a value of “ADD”

OPERATION_REMOVE = 'REMOVE'

A constant which can be used with the operation property of a FieldsAddRemoveField. This constant has a value of “REMOVE”

VALUE_TYPE_BOOLEAN = 'BOOLEAN'
VALUE_TYPE_DOUBLE = 'DOUBLE'
VALUE_TYPE_FACET = 'FACET'
VALUE_TYPE_FLOAT = 'FLOAT'
VALUE_TYPE_INTEGER = 'INTEGER'
VALUE_TYPE_LONG = 'LONG'
VALUE_TYPE_STRING = 'STRING'
VALUE_TYPE_TIMESTAMP = 'TIMESTAMP'
__init__(**kwargs)

Initializes a new FieldsAddRemoveField object with values from keyword arguments. The default value of the name attribute of this class is FIELDS and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • name (str) – The value to assign to the name property of this FieldsAddRemoveField. Allowed values for this property are: “FIELD”, “FIELDS”, “FUNCTION”, “SORT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • display_name (str) – The value to assign to the display_name property of this FieldsAddRemoveField.
  • is_declared (bool) – The value to assign to the is_declared property of this FieldsAddRemoveField.
  • original_display_names (list[str]) – The value to assign to the original_display_names property of this FieldsAddRemoveField.
  • internal_name (str) – The value to assign to the internal_name property of this FieldsAddRemoveField.
  • value_type (str) – The value to assign to the value_type property of this FieldsAddRemoveField. Allowed values for this property are: “BOOLEAN”, “STRING”, “DOUBLE”, “FLOAT”, “LONG”, “INTEGER”, “TIMESTAMP”, “FACET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • is_groupable (bool) – The value to assign to the is_groupable property of this FieldsAddRemoveField.
  • is_duration (bool) – The value to assign to the is_duration property of this FieldsAddRemoveField.
  • alias (str) – The value to assign to the alias property of this FieldsAddRemoveField.
  • filter_query_string (str) – The value to assign to the filter_query_string property of this FieldsAddRemoveField.
  • unit_type (str) – The value to assign to the unit_type property of this FieldsAddRemoveField.
  • operation (str) – The value to assign to the operation property of this FieldsAddRemoveField. Allowed values for this property are: “ADD”, “REMOVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
alias

Gets the alias of this AbstractField. Alias of field if renamed by queryStrng.

Returns:The alias of this AbstractField.
Return type:str
display_name

Gets the display_name of this AbstractField. Field display name - will be alias if field is renamed by queryStrng.

Returns:The display_name of this AbstractField.
Return type:str
filter_query_string

Gets the filter_query_string of this AbstractField. Query used to derive this field if specified.

Returns:The filter_query_string of this AbstractField.
Return type:str
static 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.

internal_name

Gets the internal_name of this AbstractField. Internal identifier for the field.

Returns:The internal_name of this AbstractField.
Return type:str
is_declared

Gets the is_declared of this AbstractField. Field denoting if this is a declaration of the field in the queryString.

Returns:The is_declared of this AbstractField.
Return type:bool
is_duration

Gets the is_duration of this AbstractField. Identifies if this field format is a duration.

Returns:The is_duration of this AbstractField.
Return type:bool
is_groupable

Gets the is_groupable of this AbstractField. Identifies if this field can be used as a grouping field in any grouping command.

Returns:The is_groupable of this AbstractField.
Return type:bool
name

[Required] Gets the name of this AbstractField. Field type classification.

Allowed values for this property are: “FIELD”, “FIELDS”, “FUNCTION”, “SORT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The name of this AbstractField.
Return type:str
operation

Gets the operation of this FieldsAddRemoveField. Denotes if field entry in FIELDS command is to show / hide field in results.

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

Returns:The operation of this FieldsAddRemoveField.
Return type:str
original_display_names

Gets the original_display_names of this AbstractField. Same as displayName unless field renamed in which case this will hold the original display names for the field across all renames.

Returns:The original_display_names of this AbstractField.
Return type:list[str]
unit_type

Gets the unit_type of this AbstractField. Field denoting field unit type.

Returns:The unit_type of this AbstractField.
Return type:str
value_type

Gets the value_type of this AbstractField. Field denoting field data type.

Allowed values for this property are: “BOOLEAN”, “STRING”, “DOUBLE”, “FLOAT”, “LONG”, “INTEGER”, “TIMESTAMP”, “FACET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The value_type of this AbstractField.
Return type:str