Class WorkRequest

An asynchronous work request. See Work Requests.

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.JmsService.Models

Assembly: OCI.DotNetSDK.Jms.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. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources aren't in the same compartment, it's up to the service team to pick the primary resource whose compartment should be used.

Remarks

Required

CompletedTaskCount

Declaration

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

Property Value

Type	Description
int?	The number of tasks had been executed to a terminal state.

CreatedBy

Declaration

[JsonProperty(PropertyName = "createdBy")]
public Principal CreatedBy { get; set; }

Property Value

Type	Description
Principal

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?	The percentage complete of the operation tracked by this work request.

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 this 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 request was created (formatted according to RFC3339).

Remarks

Required

TimeFinished

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request reached a terminal state, either FAILED or SUCCEEDED (formatted according to RFC3339).

TimeLastUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request percentage was last updated. (formatted according to RFC3339).

TimeStarted

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request transitioned from ACCEPTED to IN_PROGRESS (formatted according to RFC3339).

TotalTaskCount

Declaration

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

Property Value

Type	Description
int?	The total number of tasks to be executed for this work request.