Class WorkRequest
The API operations that create and configure GoldenGate 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.
Inherited Members
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class WorkRequestProperties
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 are not in the same compartment, it is up to the service team to pick the 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 OperationType? OperationType { get; set; }Property Value
| Type | Description |
|---|---|
| OperationType? | The work request's operation type. |
Remarks
Required
PercentComplete
Declaration
[Required(ErrorMessage = "PercentComplete is required.")]
[JsonProperty(PropertyName = "percentComplete")]
public float? PercentComplete { get; set; }Property Value
| Type | Description |
|---|---|
| float? | Percentage of the request 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 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? | Status of current 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. The format is defined by
RFC3339, such as |
Remarks
Required
TimeFinished
Declaration
[JsonProperty(PropertyName = "timeFinished")]
public DateTime? TimeFinished { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | The date and time the request was finished. The format is defined by
RFC3339, such as |
TimeStarted
Declaration
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | The date and time the request was started. The format is defined by
RFC3339, such as |