Class Schedule


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20240430")
    public final class Schedule
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A Schedule describes the date and time when an operation will be or has been applied to a set of resources.

    You must specify either the resources directly or provide a set of resource filters to select the resources.

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, contact your administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
    Note: Objects should always be created or deserialized using the Schedule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Schedule.Builder, which maintain a set of all explicitly set fields called Schedule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the schedule
        Returns:
        the value
      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment in which the schedule is created
        Returns:
        the value
      • getDisplayName

        public String getDisplayName()
        This is a user-friendly name for the schedule.

        It does not have to be unique, and it’s changeable.

        Returns:
        the value
      • getDescription

        public String getDescription()
        This is the description of the schedule.
        Returns:
        the value
      • getAction

        public Schedule.Action getAction()
        This is the action that will be executed by the schedule.
        Returns:
        the value
      • getRecurrenceDetails

        public String getRecurrenceDetails()
        This is the frequency of recurrence of a schedule.

        The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.

        Returns:
        the value
      • getRecurrenceType

        public Schedule.RecurrenceType getRecurrenceType()
        Type of recurrence of a schedule
        Returns:
        the value
      • getResourceFilters

        public List<ResourceFilter> getResourceFilters()
        This is a list of resources filters.

        The schedule will be applied to resources matching all of them.

        Returns:
        the value
      • getResources

        public List<Resource> getResources()
        This is the list of resources to which the scheduled operation is applied.
        Returns:
        the value
      • getTimeStarts

        public Date getTimeStarts()
        This is the date and time the schedule starts, in the format defined by RFC 3339

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value
      • getTimeEnds

        public Date getTimeEnds()
        This is the date and time the schedule ends, in the format defined by RFC 3339

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value
      • getTimeCreated

        public Date getTimeCreated()
        This is the date and time the schedule was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value
      • getTimeUpdated

        public Date getTimeUpdated()
        This is the date and time the schedule was updated, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value
      • getTimeLastRun

        public Date getTimeLastRun()
        This is the date and time the schedule runs last time, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value
      • getTimeNextRun

        public Date getTimeNextRun()
        This is the date and time the schedule run the next time, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value
      • getLifecycleState

        public Schedule.LifecycleState getLifecycleState()
        This is the current state of a schedule.
        Returns:
        the value
      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        These are 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"}

        Returns:
        the value
      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        These are defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value
      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        These are system tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel