Schedule (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.usageapi.model.Schedule

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200107")
public final class Schedule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
The schedule.
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).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Schedule.Builder`
`static class`	`Schedule.LifecycleState` The schedule lifecycle state.
`static class`	`Schedule.OutputFileFormat` Specifies the supported output file format.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
`Schedule(String id, String name, String compartmentId, ResultLocation resultLocation, String description, Date timeNextRun, Schedule.OutputFileFormat outputFileFormat, String savedReportId, String scheduleRecurrences, Date timeScheduled, QueryProperties queryProperties, Date timeCreated, Schedule.LifecycleState lifecycleState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Schedule.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCompartmentId()` The customer tenancy.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDescription()` The description of the schedule.
`Map<String,String>`	`getFreeformTags()` Simple key-value pair that is applied without any predefined name, type or scope.
`String`	`getId()` The OCID representing a unique shedule.
`Schedule.LifecycleState`	`getLifecycleState()` The schedule lifecycle state.
`String`	`getName()` The unique name of the schedule created by the user.
`Schedule.OutputFileFormat`	`getOutputFileFormat()` Specifies the supported output file format.
`QueryProperties`	`getQueryProperties()`
`ResultLocation`	`getResultLocation()`
`String`	`getSavedReportId()` The saved report ID which can also be used to generate a query.
`String`	`getScheduleRecurrences()` Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10.
`Map<String,Map<String,Object>>`	`getSystemTags()` Usage of system tag keys.
`Date`	`getTimeCreated()` The date and time the schedule was created.
`Date`	`getTimeNextRun()` The date and time of the next job execution.
`Date`	`getTimeScheduled()` The date and time of the first time job execution.
`int`	`hashCode()`
`Schedule.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Schedule

@Deprecated
 @ConstructorProperties(value={"id","name","compartmentId","resultLocation","description","timeNextRun","outputFileFormat","savedReportId","scheduleRecurrences","timeScheduled","queryProperties","timeCreated","lifecycleState","freeformTags","definedTags","systemTags"})
public Schedule(String id,
                                                                                                                                                                                                                                                                                                          String name,
                                                                                                                                                                                                                                                                                                          String compartmentId,
                                                                                                                                                                                                                                                                                                          ResultLocation resultLocation,
                                                                                                                                                                                                                                                                                                          String description,
                                                                                                                                                                                                                                                                                                          Date timeNextRun,
                                                                                                                                                                                                                                                                                                          Schedule.OutputFileFormat outputFileFormat,
                                                                                                                                                                                                                                                                                                          String savedReportId,
                                                                                                                                                                                                                                                                                                          String scheduleRecurrences,
                                                                                                                                                                                                                                                                                                          Date timeScheduled,
                                                                                                                                                                                                                                                                                                          QueryProperties queryProperties,
                                                                                                                                                                                                                                                                                                          Date timeCreated,
                                                                                                                                                                                                                                                                                                          Schedule.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                          Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                          Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                          Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail
- builder
```
public static Schedule.Builder builder()
```
  Create a new builder.
- toBuilder
```
public Schedule.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID representing a unique shedule.
  
  Returns:
  
  the value
- getName
```
public String getName()
```
  The unique name of the schedule created by the user.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The customer tenancy.
  
  Returns:
  
  the value
- getResultLocation
```
public ResultLocation getResultLocation()
```
- getDescription
```
public String getDescription()
```
  The description of the schedule.
  
  Returns:
  
  the value
- getTimeNextRun
```
public Date getTimeNextRun()
```
  The date and time of the next job execution.
  
  Returns:
  
  the value
- getOutputFileFormat
```
public Schedule.OutputFileFormat getOutputFileFormat()
```
  Specifies the supported output file format.
  
  Returns:
  
  the value
- getSavedReportId
```
public String getSavedReportId()
```
  The saved report ID which can also be used to generate a query.
  
  Returns:
  
  the value
- getScheduleRecurrences
```
public String getScheduleRecurrences()
```
  Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
  
  Returns:
  
  the value
- getTimeScheduled
```
public Date getTimeScheduled()
```
  The date and time of the first time job execution.
  
  Returns:
  
  the value
- getQueryProperties
```
public QueryProperties getQueryProperties()
```
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the schedule was created.
  
  Returns:
  
  the value
- getLifecycleState
```
public Schedule.LifecycleState getLifecycleState()
```
  The schedule lifecycle state.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
  
  Returns:
  
  the value
- getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
  Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace": {"bar-key": "value"}}
  
  Returns:
  
  the value
- getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
  Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. 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

Class Schedule

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

Schedule

Method Detail

builder

toBuilder

getId

getName

getCompartmentId

getResultLocation

getDescription

getTimeNextRun

getOutputFileFormat

getSavedReportId

getScheduleRecurrences

getTimeScheduled

getQueryProperties

getTimeCreated

getLifecycleState

getFreeformTags

getDefinedTags

getSystemTags

toString

toString

equals

hashCode