Class WorkRequest

An object that defines a work request.

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.OsmanagementhubService.Models

Assembly: OCI.DotNetSDK.Osmanagementhub.dll

Syntax

public class WorkRequest

Properties

ChildrenId

Declaration

[JsonProperty(PropertyName = "childrenId")]
public List<string> ChildrenId { get; set; }

Property Value

Type	Description
List<string>	The list of OCIDs for the child work requests.

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 it affects. If the work request affects multiple resources the different compartments, the services selects the compartment of the primary resource.

Remarks

Required

ContentChecksum

Declaration

[JsonProperty(PropertyName = "contentChecksum")]
public string ContentChecksum { get; set; }

Property Value

Type	Description
string	The EventFingerprint associated with the content. This property is required when the work request type is IMPORT_CONTENT or REMOVE_CONTENT.

ContentLocation

Declaration

[JsonProperty(PropertyName = "contentLocation")]
public string ContentLocation { get; set; }

Property Value

Type	Description
string	The location of the bundle in the filesystem of the resource associated to this work request.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A short description about the work request.

DisplayName

Declaration

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

Property Value

Type	Description
string	A short display name for the work request.

EventId

Declaration

[JsonProperty(PropertyName = "eventId")]
public string EventId { get; set; }

Property Value

Type	Description
string	The event id of the content. This property is required when the work request type is IMPORT_CONTENT or REMOVE_CONTENT.

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

InitiatorId

Declaration

[JsonProperty(PropertyName = "initiatorId")]
public string InitiatorId { get; set; }

Property Value

Type	Description
string	The OCID of the resource that initiated the work request.

IsManagedByAutonomousLinux

Declaration

[JsonProperty(PropertyName = "isManagedByAutonomousLinux")]
public bool? IsManagedByAutonomousLinux { get; set; }

Property Value

Type	Description
bool?	Indicates whether this work request is managed by the Autonomous Linux service.

ManagementStation

Declaration

[JsonProperty(PropertyName = "managementStation")]
public WorkRequestManagementStationDetails ManagementStation { get; set; }

Property Value

Type	Description
WorkRequestManagementStationDetails

Message

Declaration

[JsonProperty(PropertyName = "message")]
public string Message { get; set; }

Property Value

Type	Description
string	A progress or error message, if there is any.

ModuleSpecs

Declaration

[JsonProperty(PropertyName = "moduleSpecs")]
public List<ModuleSpecDetails> ModuleSpecs { get; set; }

Property Value

Type	Description
List<ModuleSpecDetails>	The list of appstream modules being operated on.

OperationType

Declaration

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

Property Value

Type	Description
WorkRequestOperationType?	Type of the work request.

Remarks

Required

PackageNames

Declaration

[JsonProperty(PropertyName = "packageNames")]
public List<string> PackageNames { get; set; }

Property Value

Type	Description
List<string>	A list of package names to be installed, updated, or removed.

ParentId

Declaration

[JsonProperty(PropertyName = "parentId")]
public string ParentId { get; set; }

Property Value

Type	Description
string	The OCID of the parent work request, if there is any.

PercentComplete

Declaration

[Required(ErrorMessage = "PercentComplete is required.")]
[JsonProperty(PropertyName = "percentComplete")]
public float? PercentComplete { get; set; }

Property Value

Type	Description
float?	The percentage complete of the operation tracked by this work request.

Remarks

Required

RebootTimeoutInMins

Declaration

[JsonProperty(PropertyName = "rebootTimeoutInMins")]
public int? RebootTimeoutInMins { get; set; }

Property Value

Type	Description
int?	The number of minutes the service waits for the reboot to complete. If the managed instance doesn't reboot within the timeout, the service marks the reboot job as failed.

RerunOfId

Declaration

[JsonProperty(PropertyName = "rerunOfId")]
public string RerunOfId { get; set; }

Property Value

Type	Description
string	The OCID of the original work request that is being rerun.

Resources

Declaration

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

Property Value

Type	Description
List<WorkRequestResource>	The list of OCIDs for the resources affected by the work request.

Remarks

Required

RetryIntervals

Declaration

[JsonProperty(PropertyName = "retryIntervals")]
public List<int> RetryIntervals { get; set; }

Property Value

Type	Description
List<int>	The amount of time in minutes to wait until retrying the work request. If set, the service will automatically retry a failed work request after the interval. For example, An interval set to [2,5,10]. If the initial execution of the work request fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.

Type

Description

List<int>

The amount of time in minutes to wait until retrying the work request. If set, the service will automatically retry a failed work request after the interval. For example, An interval set to [2,5,10]. If the initial execution of the work request fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.

RetryOfId

Declaration

[JsonProperty(PropertyName = "retryOfId")]
public string RetryOfId { get; set; }

Property Value

Type	Description
string	The OCID of the original work request that is being retried.

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 the work request.

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the work request was created (in RFC 3339 format).

Remarks

Required

TimeFinished

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request completed (in RFC 3339 format).

TimeScheduled

Declaration

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

Property Value

Type	Description
DateTime?	The scheduled date and time to retry the work request (in RFC 3339 format).

TimeStarted

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request started (in RFC 3339 format).

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the work request started (in RFC 3339 format).

WindowsUpdateNames

Declaration

[JsonProperty(PropertyName = "windowsUpdateNames")]
public List<string> WindowsUpdateNames { get; set; }

Property Value

Type	Description
List<string>	The UUIDs of the target Windows update (only used when operation type is INSTALL_WINDOWS_UPDATES).