java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.datacatalog.model.JobDefinition

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class JobDefinition
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Representation of a job definition resource.
Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.
Note: Objects should always be created or deserialized using the JobDefinition.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 JobDefinition.Builder, which maintain a set of all explicitly set fields called JobDefinition.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 JobDefinition.Builder

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
JobDefinition(String key, String displayName, String catalogId, JobType jobType, Boolean isIncremental, String dataAssetKey, String glossaryKey, String description, String connectionKey, String internalVersion, LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, String createdById, String updatedById, String uri, Boolean isSampleDataExtracted, Integer sampleDataSizeInMBs, Date timeLatestExecutionStarted, Date timeLatestExecutionEnded, JobExecutionState jobExecutionState, JobScheduleType scheduleType, Map<String,Map<String,String>> properties)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JobDefinition.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCatalogId()`	The data catalog’s OCID.
`String`	`getConnectionKey()`	The key of the default connection resource to be used for harvest, sampling, profiling jobs.
`String`	`getCreatedById()`	OCID of the user who created this job definition.
`String`	`getDataAssetKey()`	The key of the data asset for which the job is defined.
`String`	`getDescription()`	Detailed description of the job definition.
`String`	`getDisplayName()`	A user-friendly display name.
`String`	`getGlossaryKey()`	Unique key of the glossary to which this job applies.
`String`	`getInternalVersion()`	Version of the job definition object.
`Boolean`	`getIsIncremental()`	Specifies if the job definition is incremental or full.
`Boolean`	`getIsSampleDataExtracted()`	Specify if sample data to be extracted as part of this harvest.
`JobExecutionState`	`getJobExecutionState()`	Status of the latest job execution, such as running, paused, or completed.
`JobType`	`getJobType()`	Type of the job definition.
`String`	`getKey()`	Unique key of the job definition resource that is immutable.
`LifecycleState`	`getLifecycleState()`	Lifecycle state of the job definition.
`Map<String,Map<String,String>>`	`getProperties()`	A map of maps that contains the properties which are specific to the job type.
`Integer`	`getSampleDataSizeInMBs()`	Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
`JobScheduleType`	`getScheduleType()`	Type of job schedule for the latest job executed.
`Date`	`getTimeCreated()`	The date and time the job definition was created, in the format defined by RFC3339.
`Date`	`getTimeLatestExecutionEnded()`	Time that the latest job execution ended or null if it hasn’t yet completed.
`Date`	`getTimeLatestExecutionStarted()`	Time that the latest job execution started.
`Date`	`getTimeUpdated()`	The last time that any change was made to the data asset.
`String`	`getUpdatedById()`	OCID of the user who updated this job definition.
`String`	`getUri()`	URI to the job definition instance in the API.
`int`	`hashCode()`
`JobDefinition.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
  - JobDefinition
```
@Deprecated
@ConstructorProperties({"key","displayName","catalogId","jobType","isIncremental","dataAssetKey","glossaryKey","description","connectionKey","internalVersion","lifecycleState","timeCreated","timeUpdated","createdById","updatedById","uri","isSampleDataExtracted","sampleDataSizeInMBs","timeLatestExecutionStarted","timeLatestExecutionEnded","jobExecutionState","scheduleType","properties"})
public JobDefinition(String key,
                     String displayName,
                     String catalogId,
                     JobType jobType,
                     Boolean isIncremental,
                     String dataAssetKey,
                     String glossaryKey,
                     String description,
                     String connectionKey,
                     String internalVersion,
                     LifecycleState lifecycleState,
                     Date timeCreated,
                     Date timeUpdated,
                     String createdById,
                     String updatedById,
                     String uri,
                     Boolean isSampleDataExtracted,
                     Integer sampleDataSizeInMBs,
                     Date timeLatestExecutionStarted,
                     Date timeLatestExecutionEnded,
                     JobExecutionState jobExecutionState,
                     JobScheduleType scheduleType,
                     Map<String,Map<String,String>> properties)
```
    Deprecated.
- Method Detail
  - builder
```
public static JobDefinition.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public JobDefinition.Builder toBuilder()
```
  - getKey
```
public String getKey()
```
    Unique key of the job definition resource that is immutable.
    
    Returns:
    
    the value
  - getDisplayName
```
public String getDisplayName()
```
    A user-friendly display name.
    Does not have to be unique, and it’s changeable. Avoid entering confidential information.
    
    Returns:
    
    the value
  - getCatalogId
```
public String getCatalogId()
```
    The data catalog’s OCID.
    
    Returns:
    
    the value
  - getJobType
```
public JobType getJobType()
```
    Type of the job definition.
    
    Returns:
    
    the value
  - getIsIncremental
```
public Boolean getIsIncremental()
```
    Specifies if the job definition is incremental or full.
    
    Returns:
    
    the value
  - getDataAssetKey
```
public String getDataAssetKey()
```
    The key of the data asset for which the job is defined.
    
    Returns:
    
    the value
  - getGlossaryKey
```
public String getGlossaryKey()
```
    Unique key of the glossary to which this job applies.
    
    Returns:
    
    the value
  - getDescription
```
public String getDescription()
```
    Detailed description of the job definition.
    
    Returns:
    
    the value
  - getConnectionKey
```
public String getConnectionKey()
```
    The key of the default connection resource to be used for harvest, sampling, profiling jobs.
    This may be overridden in each job instance.
    
    Returns:
    
    the value
  - getInternalVersion
```
public String getInternalVersion()
```
    Version of the job definition object.
    Used internally but can be visible to users.
    
    Returns:
    
    the value
  - getLifecycleState
```
public LifecycleState getLifecycleState()
```
    Lifecycle state of the job definition.
    
    Returns:
    
    the value
  - getTimeCreated
```
public Date getTimeCreated()
```
    The date and time the job definition was created, in the format defined by RFC3339.
    Example: 2019-03-25T21:10:29.600Z
    
    Returns:
    
    the value
  - getTimeUpdated
```
public Date getTimeUpdated()
```
    The last time that any change was made to the data asset.
    An RFC3339 formatted datetime string.
    
    Returns:
    
    the value
  - getCreatedById
```
public String getCreatedById()
```
    OCID of the user who created this job definition.
    
    Returns:
    
    the value
  - getUpdatedById
```
public String getUpdatedById()
```
    OCID of the user who updated this job definition.
    
    Returns:
    
    the value
  - getUri
```
public String getUri()
```
    URI to the job definition instance in the API.
    
    Returns:
    
    the value
  - getIsSampleDataExtracted
```
public Boolean getIsSampleDataExtracted()
```
    Specify if sample data to be extracted as part of this harvest.
    
    Returns:
    
    the value
  - getSampleDataSizeInMBs
```
public Integer getSampleDataSizeInMBs()
```
    Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
    
    Returns:
    
    the value
  - getTimeLatestExecutionStarted
```
public Date getTimeLatestExecutionStarted()
```
    Time that the latest job execution started.
    An RFC3339 formatted datetime string.
    
    Returns:
    
    the value
  - getTimeLatestExecutionEnded
```
public Date getTimeLatestExecutionEnded()
```
    Time that the latest job execution ended or null if it hasn’t yet completed.
    An RFC3339 formatted datetime string.
    
    Returns:
    
    the value
  - getJobExecutionState
```
public JobExecutionState getJobExecutionState()
```
    Status of the latest job execution, such as running, paused, or completed.
    
    Returns:
    
    the value
  - getScheduleType
```
public JobScheduleType getScheduleType()
```
    Type of job schedule for the latest job executed.
    
    Returns:
    
    the value
  - getProperties
```
public Map<String,Map<String,String>> getProperties()
```
    A map of maps that contains the properties which are specific to the job type.
    Each job type definition may define it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job definitions have required properties within the “default” category. Example: {“properties”: { “default”: { “host”: “host1”, “port”: “1521”, “database”: “orcl”}}}
    
    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 JobDefinition

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

JobDefinition

Method Detail

builder

toBuilder

getKey

getDisplayName

getCatalogId

getJobType

getIsIncremental

getDataAssetKey

getGlossaryKey

getDescription

getConnectionKey

getInternalVersion

getLifecycleState

getTimeCreated

getTimeUpdated

getCreatedById

getUpdatedById

getUri

getIsSampleDataExtracted

getSampleDataSizeInMBs

getTimeLatestExecutionStarted

getTimeLatestExecutionEnded

getJobExecutionState

getScheduleType

getProperties

toString

toString

equals

hashCode