Class WorkRequest
Many of the API requests you use to create and configure WAAS policies do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest
objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request.
Inherited Members
Namespace: Oci.WaasService.Models
Assembly: OCI.DotNetSDK.Waas.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
Errors
Declaration
[JsonProperty(PropertyName = "errors")]
public List<WorkRequestError> Errors { get; set; }
Property Value
Type | Description |
---|---|
List<WorkRequestError> | The list of errors that occurred while fulfilling the work request. |
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
Logs
Declaration
[JsonProperty(PropertyName = "logs")]
public List<WorkRequestLogEntry> Logs { get; set; }
Property Value
Type | Description |
---|---|
List<WorkRequestLogEntry> | The list of log entries from the work request workflow. |
OperationType
Declaration
[Required(ErrorMessage = "OperationType is required.")]
[JsonProperty(PropertyName = "operationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public WorkRequestOperationTypes? OperationType { get; set; }
Property Value
Type | Description |
---|---|
WorkRequestOperationTypes? | A description of the operation requested by the work request. |
Remarks
Required
PercentComplete
Declaration
[JsonProperty(PropertyName = "percentComplete")]
public int? PercentComplete { get; set; }
Property Value
Type | Description |
---|---|
int? | The percentage of work completed by the work request. |
Resources
Declaration
[JsonProperty(PropertyName = "resources")]
public List<WorkRequestResource> Resources { get; set; }
Property Value
Type | Description |
---|---|
List<WorkRequestResource> | The resources being used to complete the work request operation. |
Status
Declaration
[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public WorkRequestStatusValues? Status { get; set; }
Property Value
Type | Description |
---|---|
WorkRequestStatusValues? | 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? | The date and time the work request was created, in the format defined by RFC3339. |
Remarks
Required
TimeFinished
Declaration
[Required(ErrorMessage = "TimeFinished is required.")]
[JsonProperty(PropertyName = "timeFinished")]
public DateTime? TimeFinished { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format. |
Remarks
Required
TimeStarted
Declaration
[Required(ErrorMessage = "TimeStarted is required.")]
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the work request moved from the |
Remarks
Required