BucketCommandDescriptor

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

Bases: oci.log_analytics.models.abstract_command_descriptor.AbstractCommandDescriptor

Command descriptor for querylanguage BUCKET command.

Attributes

NAME_ADD_FIELDS str(object=’’) -> str
NAME_BOTTOM str(object=’’) -> str
NAME_BUCKET str(object=’’) -> str
NAME_CLASSIFY str(object=’’) -> str
NAME_CLUSTER str(object=’’) -> str
NAME_CLUSTER_COMPARE str(object=’’) -> str
NAME_CLUSTER_DETAILS str(object=’’) -> str
NAME_CLUSTER_SPLIT str(object=’’) -> str
NAME_COMMAND str(object=’’) -> str
NAME_COMPARE str(object=’’) -> str
NAME_CREATE_VIEW str(object=’’) -> str
NAME_DELETE str(object=’’) -> str
NAME_DELTA str(object=’’) -> str
NAME_DEMO_MODE str(object=’’) -> str
NAME_DISTINCT str(object=’’) -> str
NAME_EVAL str(object=’’) -> str
NAME_EVENT_STATS str(object=’’) -> str
NAME_EXTRACT str(object=’’) -> str
NAME_FIELDS str(object=’’) -> str
NAME_FIELD_SUMMARY str(object=’’) -> str
NAME_GEO_STATS str(object=’’) -> str
NAME_HEAD str(object=’’) -> str
NAME_HIGHLIGHT str(object=’’) -> str
NAME_HIGHLIGHT_GROUPS str(object=’’) -> str
NAME_HIGHLIGHT_ROWS str(object=’’) -> str
NAME_LINK str(object=’’) -> str
NAME_LINK_DETAILS str(object=’’) -> str
NAME_LOOKUP str(object=’’) -> str
NAME_MACRO str(object=’’) -> str
NAME_MAP str(object=’’) -> str
NAME_MULTI_SEARCH str(object=’’) -> str
NAME_NLP str(object=’’) -> str
NAME_REGEX str(object=’’) -> str
NAME_RENAME str(object=’’) -> str
NAME_SEARCH str(object=’’) -> str
NAME_SEARCH_LOOKUP str(object=’’) -> str
NAME_SORT str(object=’’) -> str
NAME_STATS str(object=’’) -> str
NAME_TAIL str(object=’’) -> str
NAME_TIME_COMPARE str(object=’’) -> str
NAME_TIME_STATS str(object=’’) -> str
NAME_TOP str(object=’’) -> str
NAME_WHERE str(object=’’) -> str
category Gets the category of this AbstractCommandDescriptor.
declared_fields Gets the declared_fields of this AbstractCommandDescriptor.
default_value Gets the default_value of this BucketCommandDescriptor.
display_query_string [Required] Gets the display_query_string of this AbstractCommandDescriptor.
internal_query_string [Required] Gets the internal_query_string of this AbstractCommandDescriptor.
max_buckets Gets the max_buckets of this BucketCommandDescriptor.
name [Required] Gets the name of this AbstractCommandDescriptor.
ranges Gets the ranges of this BucketCommandDescriptor.
referenced_fields Gets the referenced_fields of this AbstractCommandDescriptor.
span Gets the span of this BucketCommandDescriptor.

Methods

__init__(**kwargs) Initializes a new BucketCommandDescriptor 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'
NAME_BOTTOM = 'BOTTOM'
NAME_BUCKET = 'BUCKET'
NAME_CLASSIFY = 'CLASSIFY'
NAME_CLUSTER = 'CLUSTER'
NAME_CLUSTER_COMPARE = 'CLUSTER_COMPARE'
NAME_CLUSTER_DETAILS = 'CLUSTER_DETAILS'
NAME_CLUSTER_SPLIT = 'CLUSTER_SPLIT'
NAME_COMMAND = 'COMMAND'
NAME_COMPARE = 'COMPARE'
NAME_CREATE_VIEW = 'CREATE_VIEW'
NAME_DELETE = 'DELETE'
NAME_DELTA = 'DELTA'
NAME_DEMO_MODE = 'DEMO_MODE'
NAME_DISTINCT = 'DISTINCT'
NAME_EVAL = 'EVAL'
NAME_EVENT_STATS = 'EVENT_STATS'
NAME_EXTRACT = 'EXTRACT'
NAME_FIELDS = 'FIELDS'
NAME_FIELD_SUMMARY = 'FIELD_SUMMARY'
NAME_GEO_STATS = 'GEO_STATS'
NAME_HEAD = 'HEAD'
NAME_HIGHLIGHT = 'HIGHLIGHT'
NAME_HIGHLIGHT_GROUPS = 'HIGHLIGHT_GROUPS'
NAME_HIGHLIGHT_ROWS = 'HIGHLIGHT_ROWS'
NAME_LOOKUP = 'LOOKUP'
NAME_MACRO = 'MACRO'
NAME_MAP = 'MAP'
NAME_NLP = 'NLP'
NAME_REGEX = 'REGEX'
NAME_RENAME = 'RENAME'
NAME_SEARCH_LOOKUP = 'SEARCH_LOOKUP'
NAME_SORT = 'SORT'
NAME_STATS = 'STATS'
NAME_TAIL = 'TAIL'
NAME_TIME_COMPARE = 'TIME_COMPARE'
NAME_TIME_STATS = 'TIME_STATS'
NAME_TOP = 'TOP'
NAME_WHERE = 'WHERE'
__init__(**kwargs)

Initializes a new BucketCommandDescriptor object with values from keyword arguments. The default value of the name attribute of this class is BUCKET 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 BucketCommandDescriptor. 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”, “EVENT_STATS”, “BUCKET”, “CLASSIFY”, “TOP”, “BOTTOM”, “HEAD”, “TAIL”, “FIELD_SUMMARY”, “REGEX”, “RENAME”, “TIME_COMPARE”, “WHERE”, “CLUSTER_COMPARE”, “DELETE”, “DELTA”, “DISTINCT”, “SEARCH_LOOKUP”, “LOOKUP”, “DEMO_MODE”, “MACRO”, “MULTI_SEARCH”, “HIGHLIGHT”, “HIGHLIGHT_ROWS”, “HIGHLIGHT_GROUPS”, “CREATE_VIEW”, “MAP”, “NLP”, “COMPARE”
  • display_query_string (str) – The value to assign to the display_query_string property of this BucketCommandDescriptor.
  • internal_query_string (str) – The value to assign to the internal_query_string property of this BucketCommandDescriptor.
  • category (str) – The value to assign to the category property of this BucketCommandDescriptor.
  • referenced_fields (list[oci.log_analytics.models.AbstractField]) – The value to assign to the referenced_fields property of this BucketCommandDescriptor.
  • declared_fields (list[oci.log_analytics.models.AbstractField]) – The value to assign to the declared_fields property of this BucketCommandDescriptor.
  • max_buckets (int) – The value to assign to the max_buckets property of this BucketCommandDescriptor.
  • span (float) – The value to assign to the span property of this BucketCommandDescriptor.
  • ranges (list[oci.log_analytics.models.BucketRange]) – The value to assign to the ranges property of this BucketCommandDescriptor.
  • default_value (str) – The value to assign to the default_value property of this BucketCommandDescriptor.
category

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

Returns:The category of this AbstractCommandDescriptor.
Return type:str
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]
default_value

Gets the default_value of this BucketCommandDescriptor. Default value to use in place of null if a result does not fit into any of the specified / calculated ranges.

Returns:The default_value of this BucketCommandDescriptor.
Return type:str
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
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_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
max_buckets

Gets the max_buckets of this BucketCommandDescriptor. number of auto calculated ranges to compute if specified.

Returns:The max_buckets of this BucketCommandDescriptor.
Return type:int
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”, “EVENT_STATS”, “BUCKET”, “CLASSIFY”, “TOP”, “BOTTOM”, “HEAD”, “TAIL”, “FIELD_SUMMARY”, “REGEX”, “RENAME”, “TIME_COMPARE”, “WHERE”, “CLUSTER_COMPARE”, “DELETE”, “DELTA”, “DISTINCT”, “SEARCH_LOOKUP”, “LOOKUP”, “DEMO_MODE”, “MACRO”, “MULTI_SEARCH”, “HIGHLIGHT”, “HIGHLIGHT_ROWS”, “HIGHLIGHT_GROUPS”, “CREATE_VIEW”, “MAP”, “NLP”, “COMPARE”, ‘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
ranges

Gets the ranges of this BucketCommandDescriptor. List of the specified numeric ranges.

Returns:The ranges of this BucketCommandDescriptor.
Return type:list[oci.log_analytics.models.BucketRange]
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]
span

Gets the span of this BucketCommandDescriptor. Size of each numeric range if specified. Data type should match numeric field data type specified in the query string.

Returns:The span of this BucketCommandDescriptor.
Return type:float