DataFlowSummary¶

class oci.data_integration.models.DataFlowSummary(**kwargs)¶

Bases: object

The data flow summary type contains the audit summary information and the definition of the data flow.

Methods

__init__(**kwargs) Initializes a new DataFlowSummary object with values from keyword arguments.

Attributes

`description`	Gets the description of this DataFlowSummary.
`flow_config_values`	Gets the flow_config_values of this DataFlowSummary.
`identifier`	Gets the identifier of this DataFlowSummary.
`key`	Gets the key of this DataFlowSummary.
`key_map`	Gets the key_map of this DataFlowSummary.
`metadata`	Gets the metadata of this DataFlowSummary.
`model_type`	Gets the model_type of this DataFlowSummary.
`model_version`	Gets the model_version of this DataFlowSummary.
`name`	Gets the name of this DataFlowSummary.
`nodes`	Gets the nodes of this DataFlowSummary.
`object_status`	Gets the object_status of this DataFlowSummary.
`object_version`	Gets the object_version of this DataFlowSummary.
`parameters`	Gets the parameters of this DataFlowSummary.
`parent_ref`	Gets the parent_ref of this DataFlowSummary.
`target_field_map_summary`	Gets the target_field_map_summary of this DataFlowSummary.
`typed_object_map`	Gets the typed_object_map of this DataFlowSummary.

__init__(**kwargs)¶

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

Parameters:

key (str) – The value to assign to the key property of this DataFlowSummary.
model_type (str) – The value to assign to the model_type property of this DataFlowSummary.
model_version (str) – The value to assign to the model_version property of this DataFlowSummary.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this DataFlowSummary.
name (str) – The value to assign to the name property of this DataFlowSummary.
identifier (str) – The value to assign to the identifier property of this DataFlowSummary.
object_version (int) – The value to assign to the object_version property of this DataFlowSummary.
nodes (list[oci.data_integration.models.FlowNode]) – The value to assign to the nodes property of this DataFlowSummary.
parameters (list[oci.data_integration.models.Parameter]) – The value to assign to the parameters property of this DataFlowSummary.
description (str) – The value to assign to the description property of this DataFlowSummary.
flow_config_values (oci.data_integration.models.ConfigValues) – The value to assign to the flow_config_values property of this DataFlowSummary.
object_status (int) – The value to assign to the object_status property of this DataFlowSummary.
metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this DataFlowSummary.
key_map (dict(str, str)) – The value to assign to the key_map property of this DataFlowSummary.
typed_object_map (dict(str, TypedObjectWrapper)) – The value to assign to the typed_object_map property of this DataFlowSummary.
target_field_map_summary (dict(str, FieldMapWrapper)) – The value to assign to the target_field_map_summary property of this DataFlowSummary.

description¶

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

Returns:	The description of this DataFlowSummary.
Return type:	str

flow_config_values¶

Gets the flow_config_values of this DataFlowSummary.

Returns:	The flow_config_values of this DataFlowSummary.
Return type:	oci.data_integration.models.ConfigValues

identifier¶

Gets the identifier of this DataFlowSummary. 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 DataFlowSummary.
Return type:	str

key¶

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

Returns:	The key of this DataFlowSummary.
Return type:	str

key_map¶

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

metadata¶

Gets the metadata of this DataFlowSummary.

Returns:	The metadata of this DataFlowSummary.
Return type:	oci.data_integration.models.ObjectMetadata

model_type¶

Gets the model_type of this DataFlowSummary. The type of the object.

Returns:	The model_type of this DataFlowSummary.
Return type:	str

model_version¶

Gets the model_version of this DataFlowSummary. The model version of an object.

Returns:	The model_version of this DataFlowSummary.
Return type:	str

name¶

Gets the name of this DataFlowSummary. 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 DataFlowSummary.
Return type:	str

nodes¶

Gets the nodes of this DataFlowSummary. An array of nodes.

Returns:	The nodes of this DataFlowSummary.
Return type:	list[oci.data_integration.models.FlowNode]

object_status¶

Gets the object_status of this DataFlowSummary. 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 DataFlowSummary.
Return type:	int

object_version¶

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

Returns:	The object_version of this DataFlowSummary.
Return type:	int

parameters¶

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

Returns:	The parameters of this DataFlowSummary.
Return type:	list[oci.data_integration.models.Parameter]

parent_ref¶

Gets the parent_ref of this DataFlowSummary.

Returns:	The parent_ref of this DataFlowSummary.
Return type:	oci.data_integration.models.ParentReference

target_field_map_summary¶

Gets the target_field_map_summary of this DataFlowSummary. A hash map that maps TypedObject keys to a field map that maps to the typed object as a target, for java sdk.

Returns:	The target_field_map_summary of this DataFlowSummary.
Return type:	dict(str, FieldMapWrapper)

typed_object_map¶

Gets the typed_object_map of this DataFlowSummary. A hash map that maps TypedObject keys to the object itself, for java sdk.

Returns:	The typed_object_map of this DataFlowSummary.
Return type:	dict(str, TypedObjectWrapper)