Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace QueryDetails

Input arguments for running a log anlaytics query. If the request is set to run in asynchronous mode then shouldIncludeColumns and shouldIncludeFields can be overwritten when retrieving the results.

Properties

Optional asyncMode

asyncMode: model.JobMode

Execution mode for the query if running asynchronously i.e (shouldRunAsync is set to true).

compartmentId

compartmentId: string

Optional compartmentIdInSubtree

compartmentIdInSubtree: undefined | false | true

Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.

Optional maxTotalCount

maxTotalCount: undefined | number

Maximum number of results to count. Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

queryString

queryString: string

Query to perform. Must conform to logging analytic querylanguage syntax. Syntax errors will be returned if present.

Optional queryTimeoutInSeconds

queryTimeoutInSeconds: undefined | number

Amount of time, in seconds, allowed for a query to execute. If this time expires before the query is complete, any partial results will be returned. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional savedSearchId

savedSearchId: undefined | string

Saved search OCID for this query if known.

Optional scopeFilters

scopeFilters: Array<ScopeFilter>

List of filters to be applied when the query executes. More than one filter per field is not permitted.

Optional shouldIncludeColumns

shouldIncludeColumns: undefined | false | true

Include columns in response

Optional shouldIncludeFields

shouldIncludeFields: undefined | false | true

Include fields in response

Optional shouldIncludeTotalCount

shouldIncludeTotalCount: undefined | false | true

Include the total number of results from the query. Note, this value will always be equal to or less than maxTotalCount.

Optional shouldRunAsync

shouldRunAsync: undefined | false | true

Option to run the query asynchronously. This will lead to a LogAnalyticsQueryJobWorkRequest being submitted and the {workRequestId} will be returned to use for fetching the results.

Optional shouldUseAcceleration

shouldUseAcceleration: undefined | false | true

Controls if query should ignore pre-calculated results if available and only use raw data. If set and no acceleration data is found it will fallback to raw data.

subSystem

subSystem: SubSystemName

Default subsystem to qualify fields with in the queryString if not specified.

Optional timeFilter

timeFilter: model.TimeRange

Functions

getDeserializedJsonObj

getJsonObj