Package com.oracle.bmc.dataintegration.model

Class TaskSchedule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.dataintegration.model.TaskSchedule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200430")
public final class TaskSchedule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A model that holds Schedule and other information required for scheduling a task.
Note: Objects should always be created or deserialized using the TaskSchedule.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 TaskSchedule.Builder, which maintain a set of all explicitly set fields called TaskSchedule.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	Description
static class	TaskSchedule.AuthMode	The authorization mode for the task.
static class	TaskSchedule.Builder
static class	TaskSchedule.ExpectedDurationUnit	The expected duration unit of the task execution.
static class	TaskSchedule.RetryDelayUnit	The unit for the retry delay.

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

Description

TaskSchedule(String key, String modelVersion, String modelType, ParentReference parentRef, String name, String description, Integer objectVersion, Integer objectStatus, String identifier, Schedule scheduleRef, ConfigProvider configProviderDelegate, Boolean isEnabled, Integer retryAttempts, TaskSchedule.RetryDelayUnit retryDelayUnit, Double retryDelay, Long startTimeMillis, Long endTimeMillis, Boolean isConcurrentAllowed, Boolean isBackfillEnabled, TaskSchedule.AuthMode authMode, Double expectedDuration, TaskSchedule.ExpectedDurationUnit expectedDurationUnit, LastRunDetails lastRunDetails, ObjectMetadata metadata)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static TaskSchedule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
TaskSchedule.AuthMode	getAuthMode()	The authorization mode for the task.
ConfigProvider	getConfigProviderDelegate()
String	getDescription()	Detailed description for the object.
Long	getEndTimeMillis()	The end time in milliseconds.
Double	getExpectedDuration()	The expected duration of the task execution.
TaskSchedule.ExpectedDurationUnit	getExpectedDurationUnit()	The expected duration unit of the task execution.
String	getIdentifier()	Value can only contain upper case letters, underscore, and numbers.
Boolean	getIsBackfillEnabled()	Whether the backfill is enabled
Boolean	getIsConcurrentAllowed()	Whether the same task can be executed concurrently.
Boolean	getIsEnabled()	Whether the schedule is enabled.
String	getKey()	Generated key that can be used in API calls to identify taskSchedule.
LastRunDetails	getLastRunDetails()
ObjectMetadata	getMetadata()
String	getModelType()	The type of the object.
String	getModelVersion()	This is a version number that is used by the service to upgrade objects if needed through releases of the service.
String	getName()	Free form text without any restriction on permitted characters.
Integer	getObjectStatus()	The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Integer	getObjectVersion()	This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.
ParentReference	getParentRef()
Integer	getRetryAttempts()	The number of retry attempts.
Double	getRetryDelay()	The retry delay, the unit for measurement is in the property retry delay unit.
TaskSchedule.RetryDelayUnit	getRetryDelayUnit()	The unit for the retry delay.
Schedule	getScheduleRef()
Long	getStartTimeMillis()	The start time in milliseconds.
int	hashCode()
TaskSchedule.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

TaskSchedule

@Deprecated
@ConstructorProperties({"key","modelVersion","modelType","parentRef","name","description","objectVersion","objectStatus","identifier","scheduleRef","configProviderDelegate","isEnabled","retryAttempts","retryDelayUnit","retryDelay","startTimeMillis","endTimeMillis","isConcurrentAllowed","isBackfillEnabled","authMode","expectedDuration","expectedDurationUnit","lastRunDetails","metadata"})
public TaskSchedule(String key,
                    String modelVersion,
                    String modelType,
                    ParentReference parentRef,
                    String name,
                    String description,
                    Integer objectVersion,
                    Integer objectStatus,
                    String identifier,
                    Schedule scheduleRef,
                    ConfigProvider configProviderDelegate,
                    Boolean isEnabled,
                    Integer retryAttempts,
                    TaskSchedule.RetryDelayUnit retryDelayUnit,
                    Double retryDelay,
                    Long startTimeMillis,
                    Long endTimeMillis,
                    Boolean isConcurrentAllowed,
                    Boolean isBackfillEnabled,
                    TaskSchedule.AuthMode authMode,
                    Double expectedDuration,
                    TaskSchedule.ExpectedDurationUnit expectedDurationUnit,
                    LastRunDetails lastRunDetails,
                    ObjectMetadata metadata)

Deprecated.

Method Detail

builder

public static TaskSchedule.Builder builder()

Create a new builder.

toBuilder

public TaskSchedule.Builder toBuilder()

getKey

public String getKey()

Generated key that can be used in API calls to identify taskSchedule.

On scenarios where reference to the taskSchedule is needed, a value can be passed in create.

Returns:

the value

getModelVersion

public String getModelVersion()

This is a version number that is used by the service to upgrade objects if needed through releases of the service.

Returns:

the value

getModelType

public String getModelType()

The type of the object.

Returns:

the value

getParentRef

public ParentReference getParentRef()

getName

public String getName()

Free form text without any restriction on permitted characters.

Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:

the value

getDescription

public String getDescription()

Detailed description for the object.

Returns:

the value

getObjectVersion

public Integer getObjectVersion()

This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.

Returns:

the value

getObjectStatus

public Integer getObjectStatus()

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:

the value

getIdentifier

public String getIdentifier()

Value can only contain upper case letters, underscore, and numbers.

It should begin with upper case letter or underscore. The value can be modified.

Returns:

the value

getScheduleRef

public Schedule getScheduleRef()

getConfigProviderDelegate

public ConfigProvider getConfigProviderDelegate()

getIsEnabled

public Boolean getIsEnabled()

Whether the schedule is enabled.

Returns:

the value

getRetryAttempts

public Integer getRetryAttempts()

The number of retry attempts.

Returns:

the value

getRetryDelayUnit

public TaskSchedule.RetryDelayUnit getRetryDelayUnit()

The unit for the retry delay.

Returns:

the value

getRetryDelay

public Double getRetryDelay()

The retry delay, the unit for measurement is in the property retry delay unit.

Returns:

the value

getStartTimeMillis

public Long getStartTimeMillis()

The start time in milliseconds.

Returns:

the value

getEndTimeMillis

public Long getEndTimeMillis()

The end time in milliseconds.

Returns:

the value

getIsConcurrentAllowed

public Boolean getIsConcurrentAllowed()

Whether the same task can be executed concurrently.

Returns:

the value

getIsBackfillEnabled

public Boolean getIsBackfillEnabled()

Whether the backfill is enabled

Returns:

the value

getAuthMode

public TaskSchedule.AuthMode getAuthMode()

The authorization mode for the task.

Returns:

the value

getExpectedDuration

public Double getExpectedDuration()

The expected duration of the task execution.

Returns:

the value

getExpectedDurationUnit

public TaskSchedule.ExpectedDurationUnit getExpectedDurationUnit()

The expected duration unit of the task execution.

Returns:

the value

getLastRunDetails

public LastRunDetails getLastRunDetails()

getMetadata

public ObjectMetadata getMetadata()

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