Class CreateScheduledJobDetails

Provides the information used to create a scheduled job.

Inheritance

object

CreateScheduledJobDetails

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 CreateScheduledJobDetails

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 scheduled job.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

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

Property Value

Type	Description
string	User-specified description of the scheduled job. Avoid entering confidential information.

DisplayName

Declaration

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

Property Value

Type	Description
string	User-friendly name for the scheduled job. Does not have to be unique and you can change the name later. Avoid entering confidential information.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IsManagedByAutonomousLinux

Declaration

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

Property Value

Type	Description
bool?	Indicates whether this scheduled job is managed by the Autonomous Linux service.

IsSubcompartmentIncluded

Declaration

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

Property Value

Type	Description
bool?	Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).

LifecycleStageIds

Declaration

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

Property Value

Type	Description
List<string>	The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceIds, or managedInstanceGroupIds, or managedCompartmentIds.

Locations

Declaration

[JsonProperty(PropertyName = "locations")]
public List<ManagedInstanceLocation> Locations { get; set; }

Property Value

Type	Description
List<ManagedInstanceLocation>	The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.

ManagedCompartmentIds

Declaration

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

Property Value

Type	Description
List<string>	The compartment OCIDs that this scheduled job operates on. To apply the job to all compartments in the tenancy, set this to the tenancy OCID (root compartment) and set isSubcompartmentIncluded to true. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceIds, or managedInstanceGroupIds, or lifecycleStageIds.

ManagedInstanceGroupIds

Declaration

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

Property Value

Type	Description
List<string>	The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceIds, or managedCompartmentIds, or lifecycleStageIds.

ManagedInstanceIds

Declaration

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

Property Value

Type	Description
List<string>	The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceGroupIds, or managedCompartmentIds, or lifecycleStageIds.

Operations

Declaration

[Required(ErrorMessage = "Operations is required.")]
[JsonProperty(PropertyName = "operations")]
public List<ScheduledJobOperation> Operations { get; set; }

Property Value

Type	Description
List<ScheduledJobOperation>	The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following: UPDATE_PACKAGES UPDATE_ALL UPDATE_SECURITY UPDATE_BUGFIX UPDATE_ENHANCEMENT UPDATE_OTHER UPDATE_KSPLICE_USERSPACE UPDATE_KSPLICE_KERNEL

Type

Description

List<ScheduledJobOperation>

The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following:

UPDATE_PACKAGES
UPDATE_ALL
UPDATE_SECURITY
UPDATE_BUGFIX
UPDATE_ENHANCEMENT
UPDATE_OTHER
UPDATE_KSPLICE_USERSPACE
UPDATE_KSPLICE_KERNEL

Remarks

Required

RecurringRule

Declaration

[JsonProperty(PropertyName = "recurringRule")]
public string RecurringRule { get; set; }

Property Value

Type	Description
string	The frequency schedule for a recurring scheduled job.

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 scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job 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 scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job 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.

ScheduleType

Declaration

[Required(ErrorMessage = "ScheduleType is required.")]
[JsonProperty(PropertyName = "scheduleType")]
[JsonConverter(typeof(StringEnumConverter))]
public ScheduleTypes? ScheduleType { get; set; }

Property Value

Type	Description
ScheduleTypes?	The type of scheduling frequency for the scheduled job.

Remarks

Required

TimeNextExecution

Declaration

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

Property Value

Type	Description
DateTime?	The desired time of the next execution of this scheduled job (in RFC 3339 format).

Remarks

Required

WorkRequestId

Declaration

[JsonProperty(PropertyName = "workRequestId")]
public string WorkRequestId { get; set; }

Property Value

Type	Description
string	The OCID for the work request that will be rerun.