Class ExportDetails

Input arguments for running a query synchronosly and streaming the results as soon as they become available.

Inheritance

object

ExportDetails

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 ExportDetails

Properties

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 retrieved from data source is determined by the specific query used and the maxTotalCount input field. If the export results can be streamed, the maximum will be 1,000,000. If the results cannot be streamed, the maximum limit is 500 for queries that include the link command and 10,000 for the queries that do not include the link command. Queries that include certain commands such as head, tail or stats cannot be streamed and are subject to a maximum of 10,000 results. Queries that include the sort command cannot be streamed unless the sort fields are restricted to id and/or time. The maximum number of results retrieved is the lesser of the maxTotalCount input provided and the applicable limit described above.

OutputFormat

Declaration

[JsonProperty(PropertyName = "outputFormat")]
[JsonConverter(typeof(StringEnumConverter))]
public ExportDetails.OutputFormatEnum? OutputFormat { get; set; }

Property Value

Type	Description
ExportDetails.OutputFormatEnum?	Specifies the format for the returned results.

QueryString

Declaration

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

Property Value

Type	Description
string	Query to perform.

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.

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

ShouldLocalize

Declaration

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

Property Value

Type	Description
bool?	Localize results, including header columns, List-Of-Values and timestamp values.

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.

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