Class WorkRequest

The API operations used to create and configure Data Integration resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running asynchronous 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.DataintegrationService.Models

Assembly: OCI.DotNetSDK.Dataintegration.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 this 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 that are not in the same compartment, then the system picks a primary resource whose compartment should be used.

Remarks

Required

Id

Declaration

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

Property Value

Type	Description
string	The ID of the work request.

Remarks

Required

OperationType

Declaration

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

Property Value

Type	Description
WorkRequest.OperationTypeEnum?	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 completed percentage 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 affected by this work request.

Remarks

Required

Status

Declaration

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

Property Value

Type	Description
WorkRequest.StatusEnum?	The status of this 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 this work request was accepted, in the timestamp 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 reached a terminal state, either FAILED or SUCCEEDED, in the timestamp 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 transitioned from ACCEPTED to IN_PROGRESS, in the timestamp format defined by RFC 3339.