ModuleCommandDescriptor

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

Bases: AbstractCommandDescriptor

Command descriptor for querylanguage MODULE command.

Attributes:

NAME_ADD_FIELDS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_ADD_INSIGHTS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_ANOMALY

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_BOTTOM

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_BUCKET

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_CLASSIFY

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_CLUSTER

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_CLUSTER_COMPARE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_CLUSTER_DETAILS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_CLUSTER_SPLIT

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_COMMAND

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_COMPARE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_CREATETABLE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_CREATE_VIEW

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_DEDUP

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_DELETE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_DELTA

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_DEMO_MODE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_DISTINCT

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_EVAL

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_EVENT_STATS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_EXTRACT

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_FIELDS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_FIELD_SUMMARY

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_FREQUENT

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_GEO_STATS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_HEAD

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_HIGHLIGHT

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_HIGHLIGHT_GROUPS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_HIGHLIGHT_ROWS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_JSON_EXTRACT

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_LINK

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_LINK_DETAILS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_LOOKUP

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_MACRO

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_MAP

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_MODULE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_MULTI_SEARCH

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_NLP

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_OUTLIER

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_RARE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_REGEX

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_RENAME

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_SEARCH

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_SEARCH_LOOKUP

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_SEQUENCE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_SORT

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_STATS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_TAIL

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_TIME_CLUSTER

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_TIME_COMPARE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_TIME_STATS

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_TOP

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_UPDATETABLE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_WHERE

A constant which can be used with the name property of a AbstractCommandDescriptor.

NAME_XML_EXTRACT

A constant which can be used with the name property of a AbstractCommandDescriptor.

arguments

Gets the arguments of this ModuleCommandDescriptor.

category

Gets the category of this AbstractCommandDescriptor.

declared_fields

Gets the declared_fields of this AbstractCommandDescriptor.

description

Gets the description of this ModuleCommandDescriptor.

display_query_string

[Required] Gets the display_query_string of this AbstractCommandDescriptor.

example

Gets the example of this ModuleCommandDescriptor.

internal_query_string

[Required] Gets the internal_query_string of this AbstractCommandDescriptor.

is_hidden

Gets the is_hidden of this AbstractCommandDescriptor.

name

[Required] Gets the name of this AbstractCommandDescriptor.

properties

Gets the properties of this ModuleCommandDescriptor.

referenced_fields

Gets the referenced_fields of this AbstractCommandDescriptor.

Methods:

__init__(**kwargs)

Initializes a new ModuleCommandDescriptor 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_ADD_FIELDS = 'ADD_FIELDS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “ADD_FIELDS”

NAME_ADD_INSIGHTS = 'ADD_INSIGHTS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “ADD_INSIGHTS”

NAME_ANOMALY = 'ANOMALY'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “ANOMALY”

NAME_BOTTOM = 'BOTTOM'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “BOTTOM”

NAME_BUCKET = 'BUCKET'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “BUCKET”

NAME_CLASSIFY = 'CLASSIFY'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “CLASSIFY”

NAME_CLUSTER = 'CLUSTER'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “CLUSTER”

NAME_CLUSTER_COMPARE = 'CLUSTER_COMPARE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “CLUSTER_COMPARE”

NAME_CLUSTER_DETAILS = 'CLUSTER_DETAILS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “CLUSTER_DETAILS”

NAME_CLUSTER_SPLIT = 'CLUSTER_SPLIT'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “CLUSTER_SPLIT”

NAME_COMMAND = 'COMMAND'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “COMMAND”

NAME_COMPARE = 'COMPARE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “COMPARE”

NAME_CREATETABLE = 'CREATETABLE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “CREATETABLE”

NAME_CREATE_VIEW = 'CREATE_VIEW'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “CREATE_VIEW”

NAME_DEDUP = 'DEDUP'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “DEDUP”

NAME_DELETE = 'DELETE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “DELETE”

NAME_DELTA = 'DELTA'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “DELTA”

NAME_DEMO_MODE = 'DEMO_MODE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “DEMO_MODE”

NAME_DISTINCT = 'DISTINCT'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “DISTINCT”

NAME_EVAL = 'EVAL'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “EVAL”

NAME_EVENT_STATS = 'EVENT_STATS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “EVENT_STATS”

NAME_EXTRACT = 'EXTRACT'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “EXTRACT”

NAME_FIELDS = 'FIELDS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “FIELDS”

NAME_FIELD_SUMMARY = 'FIELD_SUMMARY'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “FIELD_SUMMARY”

NAME_FREQUENT = 'FREQUENT'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “FREQUENT”

NAME_GEO_STATS = 'GEO_STATS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “GEO_STATS”

NAME_HEAD = 'HEAD'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “HEAD”

NAME_HIGHLIGHT = 'HIGHLIGHT'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “HIGHLIGHT”

NAME_HIGHLIGHT_GROUPS = 'HIGHLIGHT_GROUPS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “HIGHLIGHT_GROUPS”

NAME_HIGHLIGHT_ROWS = 'HIGHLIGHT_ROWS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “HIGHLIGHT_ROWS”

NAME_JSON_EXTRACT = 'JSON_EXTRACT'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “JSON_EXTRACT”

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “LINK”

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “LINK_DETAILS”

NAME_LOOKUP = 'LOOKUP'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “LOOKUP”

NAME_MACRO = 'MACRO'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “MACRO”

NAME_MAP = 'MAP'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “MAP”

NAME_MODULE = 'MODULE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “MODULE”

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “MULTI_SEARCH”

NAME_NLP = 'NLP'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “NLP”

NAME_OUTLIER = 'OUTLIER'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “OUTLIER”

NAME_RARE = 'RARE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “RARE”

NAME_REGEX = 'REGEX'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “REGEX”

NAME_RENAME = 'RENAME'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “RENAME”

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “SEARCH”

NAME_SEARCH_LOOKUP = 'SEARCH_LOOKUP'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “SEARCH_LOOKUP”

NAME_SEQUENCE = 'SEQUENCE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “SEQUENCE”

NAME_SORT = 'SORT'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “SORT”

NAME_STATS = 'STATS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “STATS”

NAME_TAIL = 'TAIL'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “TAIL”

NAME_TIME_CLUSTER = 'TIME_CLUSTER'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “TIME_CLUSTER”

NAME_TIME_COMPARE = 'TIME_COMPARE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “TIME_COMPARE”

NAME_TIME_STATS = 'TIME_STATS'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “TIME_STATS”

NAME_TOP = 'TOP'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “TOP”

NAME_UPDATETABLE = 'UPDATETABLE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “UPDATETABLE”

NAME_WHERE = 'WHERE'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “WHERE”

NAME_XML_EXTRACT = 'XML_EXTRACT'

A constant which can be used with the name property of a AbstractCommandDescriptor. This constant has a value of “XML_EXTRACT”

__init__(**kwargs)

Initializes a new ModuleCommandDescriptor object with values from keyword arguments. The default value of the name attribute of this class is MODULE 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 ModuleCommandDescriptor. Allowed values for this property are: “COMMAND”, “SEARCH”, “STATS”, “GEO_STATS”, “TIME_STATS”, “SORT”, “FIELDS”, “ADD_FIELDS”, “LINK”, “LINK_DETAILS”, “CLUSTER”, “CLUSTER_DETAILS”, “CLUSTER_SPLIT”, “EVAL”, “EXTRACT”, “JSON_EXTRACT”, “XML_EXTRACT”, “EVENT_STATS”, “BUCKET”, “CLASSIFY”, “TOP”, “BOTTOM”, “HEAD”, “TAIL”, “FIELD_SUMMARY”, “REGEX”, “RENAME”, “TIME_COMPARE”, “WHERE”, “CLUSTER_COMPARE”, “DELETE”, “CREATETABLE”, “SEQUENCE”, “UPDATETABLE”, “DELTA”, “DISTINCT”, “SEARCH_LOOKUP”, “LOOKUP”, “DEMO_MODE”, “MACRO”, “MODULE”, “MULTI_SEARCH”, “HIGHLIGHT”, “HIGHLIGHT_ROWS”, “HIGHLIGHT_GROUPS”, “CREATE_VIEW”, “MAP”, “NLP”, “COMPARE”, “ADD_INSIGHTS”, “ANOMALY”, “DEDUP”, “TIME_CLUSTER”, “FREQUENT”, “RARE”, “OUTLIER”

  • display_query_string (str) – The value to assign to the display_query_string property of this ModuleCommandDescriptor.

  • internal_query_string (str) – The value to assign to the internal_query_string property of this ModuleCommandDescriptor.

  • category (str) – The value to assign to the category property of this ModuleCommandDescriptor.

  • referenced_fields (list[oci.log_analytics.models.AbstractField]) – The value to assign to the referenced_fields property of this ModuleCommandDescriptor.

  • declared_fields (list[oci.log_analytics.models.AbstractField]) – The value to assign to the declared_fields property of this ModuleCommandDescriptor.

  • is_hidden (bool) – The value to assign to the is_hidden property of this ModuleCommandDescriptor.

  • description (str) – The value to assign to the description property of this ModuleCommandDescriptor.

  • example (str) – The value to assign to the example property of this ModuleCommandDescriptor.

  • properties (list[oci.log_analytics.models.PropertyDefinition]) – The value to assign to the properties property of this ModuleCommandDescriptor.

  • arguments (list[oci.log_analytics.models.VariableDefinition]) – The value to assign to the arguments property of this ModuleCommandDescriptor.

property arguments

Gets the arguments of this ModuleCommandDescriptor. Optional list of arguments used in the macro.

Returns

The arguments of this ModuleCommandDescriptor.

Return type

list[oci.log_analytics.models.VariableDefinition]

property category

Gets the category of this AbstractCommandDescriptor. querylanguage command designation for example; reporting vs filtering

Returns

The category of this AbstractCommandDescriptor.

Return type

str

property declared_fields

Gets the declared_fields of this AbstractCommandDescriptor. Fields declared in command fragment from user specified query string.

Returns

The declared_fields of this AbstractCommandDescriptor.

Return type

list[oci.log_analytics.models.AbstractField]

property description

Gets the description of this ModuleCommandDescriptor. Description of the macro.

Returns

The description of this ModuleCommandDescriptor.

Return type

str

property display_query_string

[Required] Gets the display_query_string of this AbstractCommandDescriptor. Command fragment display string from user specified query string formatted by query builder.

Returns

The display_query_string of this AbstractCommandDescriptor.

Return type

str

property example

Gets the example of this ModuleCommandDescriptor. Description of the macro.

Returns

The example of this ModuleCommandDescriptor.

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.

property internal_query_string

[Required] Gets the internal_query_string of this AbstractCommandDescriptor. Command fragment internal string from user specified query string formatted by query builder.

Returns

The internal_query_string of this AbstractCommandDescriptor.

Return type

str

property is_hidden

Gets the is_hidden of this AbstractCommandDescriptor. Field denoting if this is a hidden command that is not shown in the query string.

Returns

The is_hidden of this AbstractCommandDescriptor.

Return type

bool

property name

[Required] Gets the name of this AbstractCommandDescriptor. Name of querylanguage command

Allowed values for this property are: “COMMAND”, “SEARCH”, “STATS”, “GEO_STATS”, “TIME_STATS”, “SORT”, “FIELDS”, “ADD_FIELDS”, “LINK”, “LINK_DETAILS”, “CLUSTER”, “CLUSTER_DETAILS”, “CLUSTER_SPLIT”, “EVAL”, “EXTRACT”, “JSON_EXTRACT”, “XML_EXTRACT”, “EVENT_STATS”, “BUCKET”, “CLASSIFY”, “TOP”, “BOTTOM”, “HEAD”, “TAIL”, “FIELD_SUMMARY”, “REGEX”, “RENAME”, “TIME_COMPARE”, “WHERE”, “CLUSTER_COMPARE”, “DELETE”, “CREATETABLE”, “SEQUENCE”, “UPDATETABLE”, “DELTA”, “DISTINCT”, “SEARCH_LOOKUP”, “LOOKUP”, “DEMO_MODE”, “MACRO”, “MODULE”, “MULTI_SEARCH”, “HIGHLIGHT”, “HIGHLIGHT_ROWS”, “HIGHLIGHT_GROUPS”, “CREATE_VIEW”, “MAP”, “NLP”, “COMPARE”, “ADD_INSIGHTS”, “ANOMALY”, “DEDUP”, “TIME_CLUSTER”, “FREQUENT”, “RARE”, “OUTLIER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The name of this AbstractCommandDescriptor.

Return type

str

property properties

Gets the properties of this ModuleCommandDescriptor. Optional list of properties for the macro.

Returns

The properties of this ModuleCommandDescriptor.

Return type

list[oci.log_analytics.models.PropertyDefinition]

property referenced_fields

Gets the referenced_fields of this AbstractCommandDescriptor. Fields referenced in command fragment from user specified query string.

Returns

The referenced_fields of this AbstractCommandDescriptor.

Return type

list[oci.log_analytics.models.AbstractField]