Class QueryWorkRequest

Job details outlining parameters specified when job was submitted.

Inheritance

object

QueryWorkRequest

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 QueryWorkRequest

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

DisplayQueryString

Declaration

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

Property Value

Type	Description
string	Display version of the user speciified queryString.

Remarks

Required

Id

Declaration

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

Property Value

Type	Description
string	Unique OCID identifier to reference this query job work Request with.

Remarks

Required

InternalQueryString

Declaration

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

Property Value

Type	Description
string	Internal version of the user specified queryString.

Remarks

Required

Mode

Declaration

[Required(ErrorMessage = "Mode is required.")]
[JsonProperty(PropertyName = "mode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public JobMode? Mode { get; set; }

Property Value

Type	Description
JobMode?	Current execution mode for the job.

Remarks

Required

OperationType

Declaration

[JsonProperty(PropertyName = "operationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public QueryOperationType? OperationType { get; set; }

Property Value

Type	Description
QueryOperationType?	Asynchronous action name.

PercentComplete

Declaration

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

Property Value

Type	Description
int?	Percentage progress completion of the query.

ScopeFilters

Declaration

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

Property Value

Type	Description
List<ScopeFilter>	List of filters applied when the query executed.

Status

Declaration

[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public WorkRequestStatus? Status { get; set; }

Property Value

Type	Description
WorkRequestStatus?	Work request status.

SubSystem

Declaration

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

Property Value

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

Remarks

Required

TimeAccepted

Declaration

[JsonProperty(PropertyName = "timeAccepted")]
public DateTime? TimeAccepted { get; set; }

Property Value

Type	Description
DateTime?	When the work request was accepted. Should match timeStarted in all cases.

TimeBackgroundAt

Declaration

[JsonProperty(PropertyName = "timeBackgroundAt")]
public DateTime? TimeBackgroundAt { get; set; }

Property Value

Type	Description
DateTime?	When the job was put in to the background.

TimeExpires

Declaration

[JsonProperty(PropertyName = "timeExpires")]
public DateTime? TimeExpires { get; set; }

Property Value

Type	Description
DateTime?	When the job will expire.

TimeFilter

Declaration

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

Property Value

Type	Description
TimeRange

TimeFinished

Declaration

[JsonProperty(PropertyName = "timeFinished")]
public DateTime? TimeFinished { get; set; }

Property Value

Type	Description
DateTime?	When the job finished execution.

TimeStarted

Declaration

[Required(ErrorMessage = "TimeStarted is required.")]
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }

Property Value

Type	Description
DateTime?	When the job was started.

Remarks

Required