Class 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.

Inheritance

object

QueryDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LoganalyticsService.Models

Assembly: OCI.DotNetSDK.Loganalytics.dll

Syntax

public class QueryDetails

Properties

AsyncMode

Declaration

[JsonProperty(PropertyName = "asyncMode")]
[JsonConverter(typeof(StringEnumConverter))]
public JobMode? AsyncMode { get; set; }

Property Value

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

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Remarks

Required

CompartmentIdInSubtree

Declaration

[JsonProperty(PropertyName = "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }

Property Value

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

MaxTotalCount

Declaration

[JsonProperty(PropertyName = "maxTotalCount")]
public int? MaxTotalCount { get; set; }

Property Value

Type	Description
int?	Maximum number of results to count. Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).

QueryString

Declaration

[Required(ErrorMessage = "QueryString is required.")]
[JsonProperty(PropertyName = "queryString")]
public string QueryString { get; set; }

Property Value

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

Remarks

Required

QueryTimeoutInSeconds

Declaration

[JsonProperty(PropertyName = "queryTimeoutInSeconds")]
public int? QueryTimeoutInSeconds { get; set; }

Property Value

Type	Description
int?	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.

SavedSearchId

Declaration

[JsonProperty(PropertyName = "savedSearchId")]
public string SavedSearchId { get; set; }

Property Value

Type	Description
string	Saved search OCID for this query if known.

ScopeFilters

Declaration

[JsonProperty(PropertyName = "scopeFilters")]
public List<ScopeFilter> ScopeFilters { get; set; }

Property Value

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

ShouldIncludeColumns

Declaration

[JsonProperty(PropertyName = "shouldIncludeColumns")]
public bool? ShouldIncludeColumns { get; set; }

Property Value

Type	Description
bool?	Include columns in response

ShouldIncludeFields

Declaration

[JsonProperty(PropertyName = "shouldIncludeFields")]
public bool? ShouldIncludeFields { get; set; }

Property Value

Type	Description
bool?	Include fields in response

ShouldIncludeTotalCount

Declaration

[JsonProperty(PropertyName = "shouldIncludeTotalCount")]
public bool? ShouldIncludeTotalCount { get; set; }

Property Value

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

ShouldRunAsync

Declaration

[JsonProperty(PropertyName = "shouldRunAsync")]
public bool? ShouldRunAsync { get; set; }

Property Value

Type	Description
bool?	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.

ShouldUseAcceleration

Declaration

[JsonProperty(PropertyName = "shouldUseAcceleration")]
public bool? ShouldUseAcceleration { get; set; }

Property Value

Type	Description
bool?	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

Declaration

[Required(ErrorMessage = "SubSystem is required.")]
[JsonProperty(PropertyName = "subSystem")]
[JsonConverter(typeof(StringEnumConverter))]
public SubSystemName? SubSystem { get; set; }

Property Value

Type	Description
SubSystemName?	Default subsystem to qualify fields with in the queryString if not specified.

Remarks

Required

TimeFilter

Declaration

[JsonProperty(PropertyName = "timeFilter")]
public TimeRange TimeFilter { get; set; }

Property Value

Type	Description
TimeRange