Class WorkRequest

The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.

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

Assembly: OCI.DotNetSDK.Optimizer.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?	An enum-like description of the type of work the work request is doing.

Remarks

Required

PercentComplete

Declaration

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

Property Value

Type	Description
float?	How much progress the operation has made.

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 this work request affects.

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 current 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?	Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeFinished

Declaration

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

Property Value

Type	Description
DateTime?	Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeStarted

Declaration

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

Property Value

Type	Description
DateTime?	Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z