Class WorkRequest

An asynchronous work request helps monitor long-running operations. When you initiate a long-running operation, the service creates a work request. This work request acts as an activity log, allowing you to track each step of the operation\u2019s progress. Each work request has an OCID, enabling programmatic interaction and automation.

Inheritance

object

WorkRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IotService.Models

Assembly: OCI.DotNetSDK.Iot.dll

Syntax

public class WorkRequest

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID of the compartment that contains the work request.

Remarks

Required

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the work request.

Remarks

Required

OperationType

Declaration

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

Property Value

Type	Description
OperationType?	The asynchronous operation tracked by this work request.

Remarks

Required

PercentComplete

Declaration

[Required(ErrorMessage = "PercentComplete is required.")]
[JsonProperty(PropertyName = "percentComplete")]
public float? PercentComplete { get; set; }

Property Value

Type	Description
float?	Shows the progress of the operation tracked by the work request as a percentage of the total work to be completed.

Remarks

Required

Resources

Declaration

[Required(ErrorMessage = "Resources is required.")]
[JsonProperty(PropertyName = "resources")]
public List<WorkRequestResource> Resources { get; set; }

Property Value

Type	Description
List<WorkRequestResource>	The resources that are affected by the work request.

Remarks

Required

Status

Declaration

[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OperationStatus? Status { get; set; }

Property Value

Type	Description
OperationStatus?	The status of the work request.

Remarks

Required

TimeAccepted

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request was created, in the format defined by RFC 3339.

Remarks

Required

TimeFinished

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request was finished, in the format defined by RFC 3339.

TimeStarted

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request was started, in the format defined by RFC 3339.

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request was updated, in the format defined by RFC 3339.