Package com.oracle.bmc.osmanagementhub.model

Class ScheduledJob.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public ScheduledJob.Builder displayName​(String displayName)
        User-friendly name for the scheduled job.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • compartmentId

        public ScheduledJob.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the scheduled job.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • description

        public ScheduledJob.Builder description​(String description)
        User-specified description for the scheduled job.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • scheduleType

        public ScheduledJob.Builder scheduleType​(ScheduleTypes scheduleType)
        The type of scheduling frequency for the job.
        Parameters:
        scheduleType - the value to set
        Returns:
        this builder

      • locations

        public ScheduledJob.Builder locations​(List<ManagedInstanceLocation> locations)
        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.

        Parameters:
        locations - the value to set
        Returns:
        this builder

      • timeNextExecution

        public ScheduledJob.Builder timeNextExecution​(Date timeNextExecution)
        The time of the next execution of this scheduled job (in RFC 3339 format).
        Parameters:
        timeNextExecution - the value to set
        Returns:
        this builder

      • timeLastExecution

        public ScheduledJob.Builder timeLastExecution​(Date timeLastExecution)
        The time of the last execution of this scheduled job (in RFC 3339 format).
        Parameters:
        timeLastExecution - the value to set
        Returns:
        this builder

      • recurringRule

        public ScheduledJob.Builder recurringRule​(String recurringRule)
        The frequency schedule for a recurring scheduled job.
        Parameters:
        recurringRule - the value to set
        Returns:
        this builder

      • managedInstanceIds

        public ScheduledJob.Builder managedInstanceIds​(List<String> managedInstanceIds)
        The managed instance OCIDs that this scheduled job operates on.

        A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.

        Parameters:
        managedInstanceIds - the value to set
        Returns:
        this builder

      • managedInstanceGroupIds

        public ScheduledJob.Builder managedInstanceGroupIds​(List<String> managedInstanceGroupIds)
        The managed instance group OCIDs that this scheduled job operates on.

        A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.

        Parameters:
        managedInstanceGroupIds - the value to set
        Returns:
        this builder

      • managedCompartmentIds

        public ScheduledJob.Builder managedCompartmentIds​(List<String> managedCompartmentIds)
        The compartment OCIDs that this scheduled job operates on.

        A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.

        Parameters:
        managedCompartmentIds - the value to set
        Returns:
        this builder

      • lifecycleStageIds

        public ScheduledJob.Builder lifecycleStageIds​(List<String> lifecycleStageIds)
        The lifecycle stage OCIDs that this scheduled job operates on.

        A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.

        Parameters:
        lifecycleStageIds - the value to set
        Returns:
        this builder

      • isSubcompartmentIncluded

        public ScheduledJob.Builder isSubcompartmentIncluded​(Boolean isSubcompartmentIncluded)
        Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).
        Parameters:
        isSubcompartmentIncluded - the value to set
        Returns:
        this builder

      • operations

        public ScheduledJob.Builder operations​(List<ScheduledJobOperation> operations)
        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

        Parameters:
        operations - the value to set
        Returns:
        this builder

      • workRequestIds

        public ScheduledJob.Builder workRequestIds​(List<String> workRequestIds)
        The list of work request OCIDs associated with this scheduled job.
        Parameters:
        workRequestIds - the value to set
        Returns:
        this builder

      • timeCreated

        public ScheduledJob.Builder timeCreated​(Date timeCreated)
        The time this scheduled job was created (in RFC 3339 format).
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public ScheduledJob.Builder timeUpdated​(Date timeUpdated)
        The time this scheduled job was updated (in RFC 3339 format).
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • isManagedByAutonomousLinux

        public ScheduledJob.Builder isManagedByAutonomousLinux​(Boolean isManagedByAutonomousLinux)
        Indicates whether this scheduled job is managed by the Autonomous Linux service.
        Parameters:
        isManagedByAutonomousLinux - the value to set
        Returns:
        this builder

      • freeformTags

        public ScheduledJob.Builder freeformTags​(Map<String,​String> freeformTags)
        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”}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public ScheduledJob.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public ScheduledJob.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder

      • isRestricted

        public ScheduledJob.Builder isRestricted​(Boolean isRestricted)
        Indicates if the schedule job has restricted update and deletion capabilities.

        For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.

        Parameters:
        isRestricted - the value to set
        Returns:
        this builder

      • retryIntervals

        public ScheduledJob.Builder retryIntervals​(List<Integer> retryIntervals)
        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.

        Parameters:
        retryIntervals - the value to set
        Returns:
        this builder

      • workRequestId

        public ScheduledJob.Builder workRequestId​(String workRequestId)
        The OCID for the work request that will be rerun.
        Parameters:
        workRequestId - the value to set
        Returns:
        this builder