ColumnFilter

class oci.data_safe.models.ColumnFilter(**kwargs)

Bases: object

Filters that are applied to the data at the column level.

Attributes

OPERATOR_AND A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_CO A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_EQ A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_GE A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_GT A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_IN A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_LE A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_LT A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_NE A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_NOT A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_NOT_IN A constant which can be used with the operator property of a ColumnFilter.
OPERATOR_OR A constant which can be used with the operator property of a ColumnFilter.
expressions [Required] Gets the expressions of this ColumnFilter.
field_name [Required] Gets the field_name of this ColumnFilter.
is_enabled [Required] Gets the is_enabled of this ColumnFilter.
is_hidden [Required] Gets the is_hidden of this ColumnFilter.
operator [Required] Gets the operator of this ColumnFilter.

Methods

__init__(**kwargs) Initializes a new ColumnFilter object with values from keyword arguments.
OPERATOR_AND = 'AND'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “AND”

OPERATOR_CO = 'CO'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “CO”

OPERATOR_EQ = 'EQ'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “EQ”

OPERATOR_GE = 'GE'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “GE”

OPERATOR_GT = 'GT'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “GT”

OPERATOR_IN = 'IN'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “IN”

OPERATOR_LE = 'LE'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “LE”

OPERATOR_LT = 'LT'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “LT”

OPERATOR_NE = 'NE'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “NE”

OPERATOR_NOT = 'NOT'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “NOT”

OPERATOR_NOT_IN = 'NOT_IN'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “NOT_IN”

OPERATOR_OR = 'OR'

A constant which can be used with the operator property of a ColumnFilter. This constant has a value of “OR”

__init__(**kwargs)

Initializes a new ColumnFilter 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 ColumnFilter.
  • operator (str) – The value to assign to the operator property of this ColumnFilter. Allowed values for this property are: “IN”, “EQ”, “GT”, “GE”, “LT”, “LE”, “AND”, “OR”, “NE”, “CO”, “NOT”, “NOT_IN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • expressions (list[str]) – The value to assign to the expressions property of this ColumnFilter.
  • is_enabled (bool) – The value to assign to the is_enabled property of this ColumnFilter.
  • is_hidden (bool) – The value to assign to the is_hidden property of this ColumnFilter.
expressions

[Required] Gets the expressions of this ColumnFilter. An array of expressions based on the operator type. A filter may have one or more expressions.

Returns:The expressions of this ColumnFilter.
Return type:list[str]
field_name

[Required] Gets the field_name of this ColumnFilter. Name of the column on which the filter must be applied.

Returns:The field_name of this ColumnFilter.
Return type:str
is_enabled

[Required] Gets the is_enabled of this ColumnFilter. Indicates if the filter is enabled. Values can either be ‘true’ or ‘false’.

Returns:The is_enabled of this ColumnFilter.
Return type:bool
is_hidden

[Required] Gets the is_hidden of this ColumnFilter. Indicates if the filter is hidden. Values can either be ‘true’ or ‘false’.

Returns:The is_hidden of this ColumnFilter.
Return type:bool
operator

[Required] Gets the operator of this ColumnFilter. Specifies the type of operator that must be applied for example in, eq etc.

Allowed values for this property are: “IN”, “EQ”, “GT”, “GE”, “LT”, “LE”, “AND”, “OR”, “NE”, “CO”, “NOT”, “NOT_IN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The operator of this ColumnFilter.
Return type:str