CreateJobDefinitionDetails

class oci.data_catalog.models.CreateJobDefinitionDetails(**kwargs)

Bases: object

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.

Attributes

JOB_TYPE_EXPORT A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_EXPORT_GLOSSARY A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_HARVEST A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_IMMEDIATE A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_IMMEDIATE_EXECUTION A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_IMPORT A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_IMPORT_GLOSSARY A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_INTERNAL A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_PREVIEW A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_PROFILING A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_PURGE A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_SAMPLING A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_SCHEDULED A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_SCHEDULED_EXECUTION A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE A constant which can be used with the job_type property of a CreateJobDefinitionDetails.
connection_key Gets the connection_key of this CreateJobDefinitionDetails.
data_asset_key Gets the data_asset_key of this CreateJobDefinitionDetails.
description Gets the description of this CreateJobDefinitionDetails.
display_name [Required] Gets the display_name of this CreateJobDefinitionDetails.
is_incremental Gets the is_incremental of this CreateJobDefinitionDetails.
is_sample_data_extracted Gets the is_sample_data_extracted of this CreateJobDefinitionDetails.
job_type [Required] Gets the job_type of this CreateJobDefinitionDetails.
properties Gets the properties of this CreateJobDefinitionDetails.
sample_data_size_in_mbs Gets the sample_data_size_in_mbs of this CreateJobDefinitionDetails.

Methods

__init__(**kwargs) Initializes a new CreateJobDefinitionDetails object with values from keyword arguments.
JOB_TYPE_EXPORT = 'EXPORT'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “EXPORT”

JOB_TYPE_EXPORT_GLOSSARY = 'EXPORT_GLOSSARY'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “EXPORT_GLOSSARY”

JOB_TYPE_HARVEST = 'HARVEST'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “HARVEST”

JOB_TYPE_IMMEDIATE = 'IMMEDIATE'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “IMMEDIATE”

JOB_TYPE_IMMEDIATE_EXECUTION = 'IMMEDIATE_EXECUTION'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “IMMEDIATE_EXECUTION”

JOB_TYPE_IMPORT = 'IMPORT'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “IMPORT”

JOB_TYPE_IMPORT_GLOSSARY = 'IMPORT_GLOSSARY'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “IMPORT_GLOSSARY”

JOB_TYPE_INTERNAL = 'INTERNAL'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “INTERNAL”

JOB_TYPE_PREVIEW = 'PREVIEW'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “PREVIEW”

JOB_TYPE_PROFILING = 'PROFILING'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “PROFILING”

JOB_TYPE_PURGE = 'PURGE'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “PURGE”

JOB_TYPE_SAMPLING = 'SAMPLING'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “SAMPLING”

JOB_TYPE_SCHEDULED = 'SCHEDULED'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “SCHEDULED”

JOB_TYPE_SCHEDULED_EXECUTION = 'SCHEDULED_EXECUTION'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “SCHEDULED_EXECUTION”

JOB_TYPE_SCHEDULED_EXECUTION_INSTANCE = 'SCHEDULED_EXECUTION_INSTANCE'

A constant which can be used with the job_type property of a CreateJobDefinitionDetails. This constant has a value of “SCHEDULED_EXECUTION_INSTANCE”

__init__(**kwargs)

Initializes a new CreateJobDefinitionDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • display_name (str) – The value to assign to the display_name property of this CreateJobDefinitionDetails.
  • description (str) – The value to assign to the description property of this CreateJobDefinitionDetails.
  • job_type (str) – The value to assign to the job_type property of this CreateJobDefinitionDetails. Allowed values for this property are: “HARVEST”, “PROFILING”, “SAMPLING”, “PREVIEW”, “IMPORT”, “EXPORT”, “IMPORT_GLOSSARY”, “EXPORT_GLOSSARY”, “INTERNAL”, “PURGE”, “IMMEDIATE”, “SCHEDULED”, “IMMEDIATE_EXECUTION”, “SCHEDULED_EXECUTION”, “SCHEDULED_EXECUTION_INSTANCE”
  • is_incremental (bool) – The value to assign to the is_incremental property of this CreateJobDefinitionDetails.
  • data_asset_key (str) – The value to assign to the data_asset_key property of this CreateJobDefinitionDetails.
  • connection_key (str) – The value to assign to the connection_key property of this CreateJobDefinitionDetails.
  • is_sample_data_extracted (bool) – The value to assign to the is_sample_data_extracted property of this CreateJobDefinitionDetails.
  • sample_data_size_in_mbs (int) – The value to assign to the sample_data_size_in_mbs property of this CreateJobDefinitionDetails.
  • properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CreateJobDefinitionDetails.
connection_key

Gets the connection_key of this CreateJobDefinitionDetails. The key of the connection resource to be used for the job.

Returns:The connection_key of this CreateJobDefinitionDetails.
Return type:str
data_asset_key

Gets the data_asset_key of this CreateJobDefinitionDetails. The key of the data asset for which the job is defined.

Returns:The data_asset_key of this CreateJobDefinitionDetails.
Return type:str
description

Gets the description of this CreateJobDefinitionDetails. Detailed description of the job definition.

Returns:The description of this CreateJobDefinitionDetails.
Return type:str
display_name

[Required] Gets the display_name of this CreateJobDefinitionDetails. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:The display_name of this CreateJobDefinitionDetails.
Return type:str
is_incremental

Gets the is_incremental of this CreateJobDefinitionDetails. Specifies if the job definition is incremental or full.

Returns:The is_incremental of this CreateJobDefinitionDetails.
Return type:bool
is_sample_data_extracted

Gets the is_sample_data_extracted of this CreateJobDefinitionDetails. Specify if sample data to be extracted as part of this harvest.

Returns:The is_sample_data_extracted of this CreateJobDefinitionDetails.
Return type:bool
job_type

[Required] Gets the job_type of this CreateJobDefinitionDetails. Type of the job definition.

Allowed values for this property are: “HARVEST”, “PROFILING”, “SAMPLING”, “PREVIEW”, “IMPORT”, “EXPORT”, “IMPORT_GLOSSARY”, “EXPORT_GLOSSARY”, “INTERNAL”, “PURGE”, “IMMEDIATE”, “SCHEDULED”, “IMMEDIATE_EXECUTION”, “SCHEDULED_EXECUTION”, “SCHEDULED_EXECUTION_INSTANCE”

Returns:The job_type of this CreateJobDefinitionDetails.
Return type:str
properties

Gets the properties of this CreateJobDefinitionDetails. 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 properties of this CreateJobDefinitionDetails.
Return type:dict(str, dict(str, str))
sample_data_size_in_mbs

Gets the sample_data_size_in_mbs of this CreateJobDefinitionDetails. Specify the sample data size in MB, specified as number of rows, for this metadata harvest.

Returns:The sample_data_size_in_mbs of this CreateJobDefinitionDetails.
Return type:int