Class WorkRequest
Many of the API requests you use to create and configure load balancing 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.LoadbalancerService.Models
Assembly: OCI.DotNetSDK.Loadbalancer.dll
Syntax
public class WorkRequest
Properties
CompartmentId
Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment containing the load balancer. |
ErrorDetails
Declaration
[Required(ErrorMessage = "ErrorDetails is required.")]
[JsonProperty(PropertyName = "errorDetails")]
public List<WorkRequestError> ErrorDetails { get; set; }
Property Value
Type | Description |
---|---|
List<WorkRequestError> |
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
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public WorkRequest.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
WorkRequest.LifecycleStateEnum? | The current state of the work request. |
Remarks
Required
LoadBalancerId
Declaration
[Required(ErrorMessage = "LoadBalancerId is required.")]
[JsonProperty(PropertyName = "loadBalancerId")]
public string LoadBalancerId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the load balancer with which the work request is associated. |
Remarks
Required
Message
Declaration
[Required(ErrorMessage = "Message is required.")]
[JsonProperty(PropertyName = "message")]
public string Message { get; set; }
Property Value
Type | Description |
---|---|
string | A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure.
Possible data elements include:
|
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
[JsonProperty(PropertyName = "timeFinished")]
public DateTime? TimeFinished { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the work request was completed, in the format defined by RFC3339.
|
Type
Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
public string Type { get; set; }
Property Value
Type | Description |
---|---|
string | The type of action the work request represents.
|
Remarks
Required