Task

class oci.data_integration.models.Task(**kwargs)

Bases: object

The task type contains the audit summary information and the definition of the task.

Attributes:

MODEL_TYPE_DATA_LOADER_TASK

A constant which can be used with the model_type property of a Task.

MODEL_TYPE_INTEGRATION_TASK

A constant which can be used with the model_type property of a Task.

MODEL_TYPE_OCI_DATAFLOW_TASK

A constant which can be used with the model_type property of a Task.

MODEL_TYPE_PIPELINE_TASK

A constant which can be used with the model_type property of a Task.

MODEL_TYPE_REST_TASK

A constant which can be used with the model_type property of a Task.

MODEL_TYPE_SQL_TASK

A constant which can be used with the model_type property of a Task.

config_provider_delegate

Gets the config_provider_delegate of this Task.

description

Gets the description of this Task.

identifier

Gets the identifier of this Task.

input_ports

Gets the input_ports of this Task.

is_concurrent_allowed

Gets the is_concurrent_allowed of this Task.

key

Gets the key of this Task.

key_map

Gets the key_map of this Task.

metadata

Gets the metadata of this Task.

model_type

Gets the model_type of this Task.

model_version

Gets the model_version of this Task.

name

Gets the name of this Task.

object_status

Gets the object_status of this Task.

object_version

Gets the object_version of this Task.

op_config_values

Gets the op_config_values of this Task.

output_ports

Gets the output_ports of this Task.

parameters

Gets the parameters of this Task.

parent_ref

Gets the parent_ref of this Task.

registry_metadata

Gets the registry_metadata of this Task.

Methods:

__init__(**kwargs)

Initializes a new Task object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

MODEL_TYPE_DATA_LOADER_TASK = 'DATA_LOADER_TASK'

A constant which can be used with the model_type property of a Task. This constant has a value of “DATA_LOADER_TASK”

MODEL_TYPE_INTEGRATION_TASK = 'INTEGRATION_TASK'

A constant which can be used with the model_type property of a Task. This constant has a value of “INTEGRATION_TASK”

MODEL_TYPE_OCI_DATAFLOW_TASK = 'OCI_DATAFLOW_TASK'

A constant which can be used with the model_type property of a Task. This constant has a value of “OCI_DATAFLOW_TASK”

MODEL_TYPE_PIPELINE_TASK = 'PIPELINE_TASK'

A constant which can be used with the model_type property of a Task. This constant has a value of “PIPELINE_TASK”

MODEL_TYPE_REST_TASK = 'REST_TASK'

A constant which can be used with the model_type property of a Task. This constant has a value of “REST_TASK”

MODEL_TYPE_SQL_TASK = 'SQL_TASK'

A constant which can be used with the model_type property of a Task. This constant has a value of “SQL_TASK”

__init__(**kwargs)

Initializes a new Task object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • model_type (str) – The value to assign to the model_type property of this Task. Allowed values for this property are: “INTEGRATION_TASK”, “DATA_LOADER_TASK”, “PIPELINE_TASK”, “SQL_TASK”, “OCI_DATAFLOW_TASK”, “REST_TASK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • key (str) – The value to assign to the key property of this Task.

  • model_version (str) – The value to assign to the model_version property of this Task.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this Task.

  • name (str) – The value to assign to the name property of this Task.

  • description (str) – The value to assign to the description property of this Task.

  • object_version (int) – The value to assign to the object_version property of this Task.

  • object_status (int) – The value to assign to the object_status property of this Task.

  • identifier (str) – The value to assign to the identifier property of this Task.

  • input_ports (list[oci.data_integration.models.InputPort]) – The value to assign to the input_ports property of this Task.

  • output_ports (list[oci.data_integration.models.OutputPort]) – The value to assign to the output_ports property of this Task.

  • parameters (list[oci.data_integration.models.Parameter]) – The value to assign to the parameters property of this Task.

  • op_config_values (oci.data_integration.models.ConfigValues) – The value to assign to the op_config_values property of this Task.

  • config_provider_delegate (oci.data_integration.models.ConfigProvider) – The value to assign to the config_provider_delegate property of this Task.

  • is_concurrent_allowed (bool) – The value to assign to the is_concurrent_allowed property of this Task.

  • metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this Task.

  • key_map (dict(str, str)) – The value to assign to the key_map property of this Task.

  • registry_metadata (oci.data_integration.models.RegistryMetadata) – The value to assign to the registry_metadata property of this Task.

property config_provider_delegate

Gets the config_provider_delegate of this Task.

Returns

The config_provider_delegate of this Task.

Return type

oci.data_integration.models.ConfigProvider

property description

Gets the description of this Task. Detailed description for the object.

Returns

The description of this Task.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property identifier

Gets the identifier of this Task. 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 identifier of this Task.

Return type

str

property input_ports

Gets the input_ports of this Task. An array of input ports.

Returns

The input_ports of this Task.

Return type

list[oci.data_integration.models.InputPort]

property is_concurrent_allowed

Gets the is_concurrent_allowed of this Task. Whether the same task can be executed concurrently.

Returns

The is_concurrent_allowed of this Task.

Return type

bool

property key

Gets the key of this Task. Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create.

Returns

The key of this Task.

Return type

str

property key_map

Gets the key_map of this Task. A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns

The key_map of this Task.

Return type

dict(str, str)

property metadata

Gets the metadata of this Task.

Returns

The metadata of this Task.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

Gets the model_type of this Task. The type of the task.

Allowed values for this property are: “INTEGRATION_TASK”, “DATA_LOADER_TASK”, “PIPELINE_TASK”, “SQL_TASK”, “OCI_DATAFLOW_TASK”, “REST_TASK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this Task.

Return type

str

property model_version

Gets the model_version of this Task. The object’s model version.

Returns

The model_version of this Task.

Return type

str

property name

Gets the name of this Task. 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 name of this Task.

Return type

str

property object_status

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

Returns

The object_status of this Task.

Return type

int

property object_version

Gets the object_version of this Task. The version of the object that is used to track changes in the object instance.

Returns

The object_version of this Task.

Return type

int

property op_config_values

Gets the op_config_values of this Task.

Returns

The op_config_values of this Task.

Return type

oci.data_integration.models.ConfigValues

property output_ports

Gets the output_ports of this Task. An array of output ports.

Returns

The output_ports of this Task.

Return type

list[oci.data_integration.models.OutputPort]

property parameters

Gets the parameters of this Task. An array of parameters.

Returns

The parameters of this Task.

Return type

list[oci.data_integration.models.Parameter]

property parent_ref

Gets the parent_ref of this Task.

Returns

The parent_ref of this Task.

Return type

oci.data_integration.models.ParentReference

property registry_metadata

Gets the registry_metadata of this Task.

Returns

The registry_metadata of this Task.

Return type

oci.data_integration.models.RegistryMetadata