Class WorkRequestSummary

A summary of the status of a work request.

Inheritance

object

WorkRequestSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabasetoolsruntimeService.Models

Assembly: OCI.DotNetSDK.Databasetoolsruntime.dll

Syntax

public class WorkRequestSummary

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

CreatedByPrincipalDomainId

Declaration

[JsonProperty(PropertyName = "createdByPrincipalDomainId")]
public string CreatedByPrincipalDomainId { get; set; }

Property Value

Type	Description
string	Identity domain OCID for the user that submitted the asynchronous request.

CreatedByPrincipalId

Declaration

[JsonProperty(PropertyName = "createdByPrincipalId")]
public string CreatedByPrincipalId { get; set; }

Property Value

Type	Description
string	Principal id of the user or resource that submitted the asynchrounous request.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name for the operation. If provided for an asynchronous operation, this value will be propagated to the displayName property of the resulting Work Request, allowing for easier identification and tracking of the operation's progress and outcome. This name is purely for descriptive purposes and does not affect the functionality of the operation itself.

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?	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?	Percentage of the request completed.

Remarks

Required

Resources

Declaration

[JsonProperty(PropertyName = "resources")]
public List<WorkRequestResource> Resources { get; set; }

Property Value

Type	Description
List<WorkRequestResource>	The resources affected by this work request.

Status

Declaration

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

Property Value

Type	Description
OperationStatus?	The 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

[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. Format is defined by RFC3339.

TimeScheduled

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request is eligible to be launched, in the format defined by RFC3339.

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 format defined by RFC3339.

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request was last updated, in the format defined by RFC3339.