GeoStatsCommandDescriptor¶

class oci.log_analytics.models.GeoStatsCommandDescriptor(**kwargs)¶

Bases: oci.log_analytics.models.abstract_command_descriptor.AbstractCommandDescriptor

Command descriptor for querylanguage GEOSTATS command. This is similiar to STATS with some built in functions for City, State and Country by Coordinates.

Attributes

`INCLUDE_CLIENT`	A constant which can be used with the include property of a GeoStatsCommandDescriptor.
`INCLUDE_CLIENT_AND_SERVER`	A constant which can be used with the include property of a GeoStatsCommandDescriptor.
`INCLUDE_CUSTOM`	A constant which can be used with the include property of a GeoStatsCommandDescriptor.
`INCLUDE_SERVER`	A constant which can be used with the include property of a GeoStatsCommandDescriptor.
`NAME_ADD_FIELDS`	str(object=’’) -> str
`NAME_ADD_INSIGHTS`	str(object=’’) -> str
`NAME_ANOMALY`	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_CREATETABLE`	str(object=’’) -> str
`NAME_CREATE_VIEW`	str(object=’’) -> str
`NAME_DEDUP`	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_FREQUENT`	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_JSON_EXTRACT`	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_MODULE`	str(object=’’) -> str
`NAME_MULTI_SEARCH`	str(object=’’) -> str
`NAME_NLP`	str(object=’’) -> str
`NAME_OUTLIER`	str(object=’’) -> str
`NAME_RARE`	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_SEQUENCE`	str(object=’’) -> str
`NAME_SORT`	str(object=’’) -> str
`NAME_STATS`	str(object=’’) -> str
`NAME_TAIL`	str(object=’’) -> str
`NAME_TIME_CLUSTER`	str(object=’’) -> str
`NAME_TIME_COMPARE`	str(object=’’) -> str
`NAME_TIME_STATS`	str(object=’’) -> str
`NAME_TOP`	str(object=’’) -> str
`NAME_UPDATETABLE`	str(object=’’) -> str
`NAME_WHERE`	str(object=’’) -> str
`NAME_XML_EXTRACT`	str(object=’’) -> str
`category`	Gets the category of this AbstractCommandDescriptor.
`city_field`	Gets the city_field of this GeoStatsCommandDescriptor.
`continent_field`	Gets the continent_field of this GeoStatsCommandDescriptor.
`coordinates_field`	Gets the coordinates_field of this GeoStatsCommandDescriptor.
`country_field`	Gets the country_field of this GeoStatsCommandDescriptor.
`declared_fields`	Gets the declared_fields of this AbstractCommandDescriptor.
`display_query_string`	[Required] Gets the display_query_string of this AbstractCommandDescriptor.
`functions`	Gets the functions of this GeoStatsCommandDescriptor.
`group_by_fields`	Gets the group_by_fields of this GeoStatsCommandDescriptor.
`include`	Gets the include of this GeoStatsCommandDescriptor.
`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.
`referenced_fields`	Gets the referenced_fields of this AbstractCommandDescriptor.
`region_field`	Gets the region_field of this GeoStatsCommandDescriptor.

Methods

`__init__`(**kwargs)	Initializes a new GeoStatsCommandDescriptor 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.

INCLUDE_CLIENT = 'CLIENT'¶: A constant which can be used with the include property of a GeoStatsCommandDescriptor. This constant has a value of “CLIENT”

INCLUDE_CLIENT_AND_SERVER = 'CLIENT_AND_SERVER'¶: A constant which can be used with the include property of a GeoStatsCommandDescriptor. This constant has a value of “CLIENT_AND_SERVER”

INCLUDE_CUSTOM = 'CUSTOM'¶: A constant which can be used with the include property of a GeoStatsCommandDescriptor. This constant has a value of “CUSTOM”

INCLUDE_SERVER = 'SERVER'¶: A constant which can be used with the include property of a GeoStatsCommandDescriptor. This constant has a value of “SERVER”

NAME_ADD_FIELDS = 'ADD_FIELDS'¶

NAME_ADD_INSIGHTS = 'ADD_INSIGHTS'¶

NAME_ANOMALY = 'ANOMALY'¶

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_CREATETABLE = 'CREATETABLE'¶

NAME_CREATE_VIEW = 'CREATE_VIEW'¶

NAME_DEDUP = 'DEDUP'¶

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_FREQUENT = 'FREQUENT'¶

NAME_GEO_STATS = 'GEO_STATS'¶

NAME_HEAD = 'HEAD'¶

NAME_HIGHLIGHT = 'HIGHLIGHT'¶

NAME_HIGHLIGHT_GROUPS = 'HIGHLIGHT_GROUPS'¶

NAME_HIGHLIGHT_ROWS = 'HIGHLIGHT_ROWS'¶

NAME_JSON_EXTRACT = 'JSON_EXTRACT'¶

NAME_LINK = 'LINK'¶

NAME_LINK_DETAILS = 'LINK_DETAILS'¶

NAME_LOOKUP = 'LOOKUP'¶

NAME_MACRO = 'MACRO'¶

NAME_MAP = 'MAP'¶

NAME_MODULE = 'MODULE'¶

NAME_MULTI_SEARCH = 'MULTI_SEARCH'¶

NAME_NLP = 'NLP'¶

NAME_OUTLIER = 'OUTLIER'¶

NAME_RARE = 'RARE'¶

NAME_REGEX = 'REGEX'¶

NAME_RENAME = 'RENAME'¶

NAME_SEARCH = 'SEARCH'¶

NAME_SEARCH_LOOKUP = 'SEARCH_LOOKUP'¶

NAME_SEQUENCE = 'SEQUENCE'¶

NAME_SORT = 'SORT'¶

NAME_STATS = 'STATS'¶

NAME_TAIL = 'TAIL'¶

NAME_TIME_CLUSTER = 'TIME_CLUSTER'¶

NAME_TIME_COMPARE = 'TIME_COMPARE'¶

NAME_TIME_STATS = 'TIME_STATS'¶

NAME_TOP = 'TOP'¶

NAME_UPDATETABLE = 'UPDATETABLE'¶

NAME_WHERE = 'WHERE'¶

NAME_XML_EXTRACT = 'XML_EXTRACT'¶

__init__(**kwargs)¶

Initializes a new GeoStatsCommandDescriptor object with values from keyword arguments. The default value of the name attribute of this class is GEO_STATS 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 GeoStatsCommandDescriptor. 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’.
display_query_string (str) – The value to assign to the display_query_string property of this GeoStatsCommandDescriptor.
internal_query_string (str) – The value to assign to the internal_query_string property of this GeoStatsCommandDescriptor.
category (str) – The value to assign to the category property of this GeoStatsCommandDescriptor.
referenced_fields (list[oci.log_analytics.models.AbstractField]) – The value to assign to the referenced_fields property of this GeoStatsCommandDescriptor.
declared_fields (list[oci.log_analytics.models.AbstractField]) – The value to assign to the declared_fields property of this GeoStatsCommandDescriptor.
is_hidden (bool) – The value to assign to the is_hidden property of this GeoStatsCommandDescriptor.
include (str) – The value to assign to the include property of this GeoStatsCommandDescriptor. Allowed values for this property are: “CLIENT”, “SERVER”, “CLIENT_AND_SERVER”, “CUSTOM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
city_field (oci.log_analytics.models.AbstractField) – The value to assign to the city_field property of this GeoStatsCommandDescriptor.
region_field (oci.log_analytics.models.AbstractField) – The value to assign to the region_field property of this GeoStatsCommandDescriptor.
country_field (oci.log_analytics.models.AbstractField) – The value to assign to the country_field property of this GeoStatsCommandDescriptor.
continent_field (oci.log_analytics.models.AbstractField) – The value to assign to the continent_field property of this GeoStatsCommandDescriptor.
coordinates_field (oci.log_analytics.models.AbstractField) – The value to assign to the coordinates_field property of this GeoStatsCommandDescriptor.
group_by_fields (list[oci.log_analytics.models.AbstractField]) – The value to assign to the group_by_fields property of this GeoStatsCommandDescriptor.
functions (list[oci.log_analytics.models.FunctionField]) – The value to assign to the functions property of this GeoStatsCommandDescriptor.

category¶

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

Returns:	The category of this AbstractCommandDescriptor.
Return type:	str

city_field¶

Gets the city_field of this GeoStatsCommandDescriptor. The city field to use. Only applicable when include = CUSTOM.

Returns:	The city_field of this GeoStatsCommandDescriptor.
Return type:	oci.log_analytics.models.AbstractField

continent_field¶

Gets the continent_field of this GeoStatsCommandDescriptor. The continent field to use. Only applicable when include = CUSTOM.

Returns:	The continent_field of this GeoStatsCommandDescriptor.
Return type:	oci.log_analytics.models.AbstractField

coordinates_field¶

Gets the coordinates_field of this GeoStatsCommandDescriptor. The coordinates field to use. Only applicable when include = CUSTOM.

Returns:	The coordinates_field of this GeoStatsCommandDescriptor.
Return type:	oci.log_analytics.models.AbstractField

country_field¶

Gets the country_field of this GeoStatsCommandDescriptor. The country field to use. Only applicable when include = CUSTOM.

Returns:	The country_field of this GeoStatsCommandDescriptor.
Return type:	oci.log_analytics.models.AbstractField

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]

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

functions¶

Gets the functions of this GeoStatsCommandDescriptor. Statistical functions specified in the query string. At least 1 is required for a GEOSTATS command.

Returns:	The functions of this GeoStatsCommandDescriptor.
Return type:	list[oci.log_analytics.models.FunctionField]

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.

group_by_fields¶

Gets the group_by_fields of this GeoStatsCommandDescriptor. Group by fields if specified in the query string. Required if include = CUSTOM.

Returns:	The group_by_fields of this GeoStatsCommandDescriptor.
Return type:	list[oci.log_analytics.models.AbstractField]

include¶

Gets the include of this GeoStatsCommandDescriptor. Indicates which coordinates to show. Either client, server, client and server or custom. If custom is specified at least one of coordinatesField, regionField or countryField is required. Defaults to client.

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

Returns:	The include of this GeoStatsCommandDescriptor.
Return type:	str

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

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

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

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]

region_field¶

Gets the region_field of this GeoStatsCommandDescriptor. The region field to use. Only applicable when include = CUSTOM.

Returns:	The region_field of this GeoStatsCommandDescriptor.
Return type:	oci.log_analytics.models.AbstractField