TaskSummaryFromRestTask

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

Bases: TaskSummary

The information about the Generic REST task. The endpoint and cancelEndpoint properties are deprecated, use the properties executeRestCallConfig, cancelRestCallConfig and pollRestCallConfig for execute, cancel and polling of the calls.

Attributes:

API_CALL_MODE_ASYNC_GENERIC

A constant which can be used with the api_call_mode property of a TaskSummaryFromRestTask.

API_CALL_MODE_ASYNC_OCI_WORKREQUEST

A constant which can be used with the api_call_mode property of a TaskSummaryFromRestTask.

API_CALL_MODE_SYNCHRONOUS

A constant which can be used with the api_call_mode property of a TaskSummaryFromRestTask.

CANCEL_METHOD_TYPE_DELETE

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask.

CANCEL_METHOD_TYPE_GET

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask.

CANCEL_METHOD_TYPE_PATCH

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask.

CANCEL_METHOD_TYPE_POST

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask.

CANCEL_METHOD_TYPE_PUT

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask.

METHOD_TYPE_DELETE

A constant which can be used with the method_type property of a TaskSummaryFromRestTask.

METHOD_TYPE_GET

A constant which can be used with the method_type property of a TaskSummaryFromRestTask.

METHOD_TYPE_PATCH

A constant which can be used with the method_type property of a TaskSummaryFromRestTask.

METHOD_TYPE_POST

A constant which can be used with the method_type property of a TaskSummaryFromRestTask.

METHOD_TYPE_PUT

A constant which can be used with the method_type property of a TaskSummaryFromRestTask.

MODEL_TYPE_DATA_LOADER_TASK

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

MODEL_TYPE_INTEGRATION_TASK

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

MODEL_TYPE_OCI_DATAFLOW_TASK

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

MODEL_TYPE_PIPELINE_TASK

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

MODEL_TYPE_REST_TASK

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

MODEL_TYPE_SQL_TASK

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

api_call_mode

Gets the api_call_mode of this TaskSummaryFromRestTask.

auth_config

Gets the auth_config of this TaskSummaryFromRestTask.

auth_details

Gets the auth_details of this TaskSummaryFromRestTask.

cancel_endpoint

Gets the cancel_endpoint of this TaskSummaryFromRestTask.

cancel_method_type

Gets the cancel_method_type of this TaskSummaryFromRestTask.

cancel_rest_call_config

Gets the cancel_rest_call_config of this TaskSummaryFromRestTask.

config_provider_delegate

Gets the config_provider_delegate of this TaskSummary.

description

Gets the description of this TaskSummary.

endpoint

Gets the endpoint of this TaskSummaryFromRestTask.

execute_rest_call_config

Gets the execute_rest_call_config of this TaskSummaryFromRestTask.

headers

Gets the headers of this TaskSummaryFromRestTask.

identifier

Gets the identifier of this TaskSummary.

input_ports

Gets the input_ports of this TaskSummary.

is_concurrent_allowed

Gets the is_concurrent_allowed of this TaskSummary.

json_data

Gets the json_data of this TaskSummaryFromRestTask.

key

Gets the key of this TaskSummary.

key_map

Gets the key_map of this TaskSummary.

metadata

Gets the metadata of this TaskSummary.

method_type

Gets the method_type of this TaskSummaryFromRestTask.

model_type

Gets the model_type of this TaskSummary.

model_version

Gets the model_version of this TaskSummary.

name

Gets the name of this TaskSummary.

object_status

Gets the object_status of this TaskSummary.

object_version

Gets the object_version of this TaskSummary.

op_config_values

Gets the op_config_values of this TaskSummary.

output_ports

Gets the output_ports of this TaskSummary.

parameters

Gets the parameters of this TaskSummary.

parent_ref

Gets the parent_ref of this TaskSummary.

poll_rest_call_config

Gets the poll_rest_call_config of this TaskSummaryFromRestTask.

Methods:

__init__(**kwargs)

Initializes a new TaskSummaryFromRestTask 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.

API_CALL_MODE_ASYNC_GENERIC = 'ASYNC_GENERIC'

A constant which can be used with the api_call_mode property of a TaskSummaryFromRestTask. This constant has a value of “ASYNC_GENERIC”

API_CALL_MODE_ASYNC_OCI_WORKREQUEST = 'ASYNC_OCI_WORKREQUEST'

A constant which can be used with the api_call_mode property of a TaskSummaryFromRestTask. This constant has a value of “ASYNC_OCI_WORKREQUEST”

API_CALL_MODE_SYNCHRONOUS = 'SYNCHRONOUS'

A constant which can be used with the api_call_mode property of a TaskSummaryFromRestTask. This constant has a value of “SYNCHRONOUS”

CANCEL_METHOD_TYPE_DELETE = 'DELETE'

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask. This constant has a value of “DELETE”

CANCEL_METHOD_TYPE_GET = 'GET'

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask. This constant has a value of “GET”

CANCEL_METHOD_TYPE_PATCH = 'PATCH'

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask. This constant has a value of “PATCH”

CANCEL_METHOD_TYPE_POST = 'POST'

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask. This constant has a value of “POST”

CANCEL_METHOD_TYPE_PUT = 'PUT'

A constant which can be used with the cancel_method_type property of a TaskSummaryFromRestTask. This constant has a value of “PUT”

METHOD_TYPE_DELETE = 'DELETE'

A constant which can be used with the method_type property of a TaskSummaryFromRestTask. This constant has a value of “DELETE”

METHOD_TYPE_GET = 'GET'

A constant which can be used with the method_type property of a TaskSummaryFromRestTask. This constant has a value of “GET”

METHOD_TYPE_PATCH = 'PATCH'

A constant which can be used with the method_type property of a TaskSummaryFromRestTask. This constant has a value of “PATCH”

METHOD_TYPE_POST = 'POST'

A constant which can be used with the method_type property of a TaskSummaryFromRestTask. This constant has a value of “POST”

METHOD_TYPE_PUT = 'PUT'

A constant which can be used with the method_type property of a TaskSummaryFromRestTask. This constant has a value of “PUT”

MODEL_TYPE_DATA_LOADER_TASK = 'DATA_LOADER_TASK'

A constant which can be used with the model_type property of a TaskSummary. 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 TaskSummary. 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 TaskSummary. 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 TaskSummary. 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 TaskSummary. 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 TaskSummary. This constant has a value of “SQL_TASK”

__init__(**kwargs)

Initializes a new TaskSummaryFromRestTask object with values from keyword arguments. The default value of the model_type attribute of this class is REST_TASK and it should not be changed. 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 TaskSummaryFromRestTask. 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 TaskSummaryFromRestTask.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • auth_details (oci.data_integration.models.AuthDetails) – The value to assign to the auth_details property of this TaskSummaryFromRestTask.

  • auth_config (oci.data_integration.models.AuthConfig) – The value to assign to the auth_config property of this TaskSummaryFromRestTask.

  • endpoint (oci.data_integration.models.Expression) – The value to assign to the endpoint property of this TaskSummaryFromRestTask.

  • method_type (str) – The value to assign to the method_type property of this TaskSummaryFromRestTask. Allowed values for this property are: “GET”, “POST”, “PATCH”, “DELETE”, “PUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • headers (object) – The value to assign to the headers property of this TaskSummaryFromRestTask.

  • json_data (str) – The value to assign to the json_data property of this TaskSummaryFromRestTask.

  • api_call_mode (str) – The value to assign to the api_call_mode property of this TaskSummaryFromRestTask. Allowed values for this property are: “SYNCHRONOUS”, “ASYNC_OCI_WORKREQUEST”, “ASYNC_GENERIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • cancel_endpoint (oci.data_integration.models.Expression) – The value to assign to the cancel_endpoint property of this TaskSummaryFromRestTask.

  • cancel_method_type (str) – The value to assign to the cancel_method_type property of this TaskSummaryFromRestTask. Allowed values for this property are: “GET”, “POST”, “PATCH”, “DELETE”, “PUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • execute_rest_call_config (oci.data_integration.models.ExecuteRestCallConfig) – The value to assign to the execute_rest_call_config property of this TaskSummaryFromRestTask.

  • cancel_rest_call_config (oci.data_integration.models.CancelRestCallConfig) – The value to assign to the cancel_rest_call_config property of this TaskSummaryFromRestTask.

  • poll_rest_call_config (oci.data_integration.models.PollRestCallConfig) – The value to assign to the poll_rest_call_config property of this TaskSummaryFromRestTask.

property api_call_mode

Gets the api_call_mode of this TaskSummaryFromRestTask. The REST invocation pattern to use. ASYNC_OCI_WORKREQUEST is being deprecated as well as cancelEndpoint/MethodType.

Allowed values for this property are: “SYNCHRONOUS”, “ASYNC_OCI_WORKREQUEST”, “ASYNC_GENERIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The api_call_mode of this TaskSummaryFromRestTask.

Return type

str

property auth_config

Gets the auth_config of this TaskSummaryFromRestTask.

Returns

The auth_config of this TaskSummaryFromRestTask.

Return type

oci.data_integration.models.AuthConfig

property auth_details

Gets the auth_details of this TaskSummaryFromRestTask.

Returns

The auth_details of this TaskSummaryFromRestTask.

Return type

oci.data_integration.models.AuthDetails

property cancel_endpoint

Gets the cancel_endpoint of this TaskSummaryFromRestTask.

Returns

The cancel_endpoint of this TaskSummaryFromRestTask.

Return type

oci.data_integration.models.Expression

property cancel_method_type

Gets the cancel_method_type of this TaskSummaryFromRestTask. The REST method to use for canceling the original request.

Allowed values for this property are: “GET”, “POST”, “PATCH”, “DELETE”, “PUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The cancel_method_type of this TaskSummaryFromRestTask.

Return type

str

property cancel_rest_call_config

Gets the cancel_rest_call_config of this TaskSummaryFromRestTask.

Returns

The cancel_rest_call_config of this TaskSummaryFromRestTask.

Return type

oci.data_integration.models.CancelRestCallConfig

property config_provider_delegate

Gets the config_provider_delegate of this TaskSummary.

Returns

The config_provider_delegate of this TaskSummary.

Return type

oci.data_integration.models.ConfigProvider

property description

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

Returns

The description of this TaskSummary.

Return type

str

property endpoint

Gets the endpoint of this TaskSummaryFromRestTask.

Returns

The endpoint of this TaskSummaryFromRestTask.

Return type

oci.data_integration.models.Expression

property execute_rest_call_config

Gets the execute_rest_call_config of this TaskSummaryFromRestTask.

Returns

The execute_rest_call_config of this TaskSummaryFromRestTask.

Return type

oci.data_integration.models.ExecuteRestCallConfig

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 headers

Gets the headers of this TaskSummaryFromRestTask. Headers for payload.

Returns

The headers of this TaskSummaryFromRestTask.

Return type

object

property identifier

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

Return type

str

property input_ports

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

Returns

The input_ports of this TaskSummary.

Return type

list[oci.data_integration.models.InputPort]

property is_concurrent_allowed

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

Returns

The is_concurrent_allowed of this TaskSummary.

Return type

bool

property json_data

Gets the json_data of this TaskSummaryFromRestTask. JSON data for payload body. This property is deprecated, use ExecuteRestCallConfig’s payload config param instead.

Returns

The json_data of this TaskSummaryFromRestTask.

Return type

str

property key

Gets the key of this TaskSummary. 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 TaskSummary.

Return type

str

property key_map

Gets the key_map of this TaskSummary. 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 TaskSummary.

Return type

dict(str, str)

property metadata

Gets the metadata of this TaskSummary.

Returns

The metadata of this TaskSummary.

Return type

oci.data_integration.models.ObjectMetadata

property method_type

Gets the method_type of this TaskSummaryFromRestTask. The REST method to use. This property is deprecated, use ExecuteRestCallConfig’s methodType property instead.

Allowed values for this property are: “GET”, “POST”, “PATCH”, “DELETE”, “PUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The method_type of this TaskSummaryFromRestTask.

Return type

str

property model_type

Gets the model_type of this TaskSummary. The type of 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 TaskSummary.

Return type

str

property model_version

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

Returns

The model_version of this TaskSummary.

Return type

str

property name

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

Return type

str

property object_status

Gets the object_status of this TaskSummary. 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 TaskSummary.

Return type

int

property object_version

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

Returns

The object_version of this TaskSummary.

Return type

int

property op_config_values

Gets the op_config_values of this TaskSummary.

Returns

The op_config_values of this TaskSummary.

Return type

oci.data_integration.models.ConfigValues

property output_ports

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

Returns

The output_ports of this TaskSummary.

Return type

list[oci.data_integration.models.OutputPort]

property parameters

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

Returns

The parameters of this TaskSummary.

Return type

list[oci.data_integration.models.Parameter]

property parent_ref

Gets the parent_ref of this TaskSummary.

Returns

The parent_ref of this TaskSummary.

Return type

oci.data_integration.models.ParentReference

property poll_rest_call_config

Gets the poll_rest_call_config of this TaskSummaryFromRestTask.

Returns

The poll_rest_call_config of this TaskSummaryFromRestTask.

Return type

oci.data_integration.models.PollRestCallConfig