WriteOperationConfig

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

Bases: AbstractDataOperationConfig

The information about the write operation.

Attributes:

MODEL_TYPE_READ_OPERATION_CONFIG

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

MODEL_TYPE_WRITE_OPERATION_CONFIG

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

WRITE_MODE_APPEND

A constant which can be used with the write_mode property of a WriteOperationConfig.

WRITE_MODE_IGNORE

A constant which can be used with the write_mode property of a WriteOperationConfig.

WRITE_MODE_MERGE

A constant which can be used with the write_mode property of a WriteOperationConfig.

WRITE_MODE_OVERWRITE

A constant which can be used with the write_mode property of a WriteOperationConfig.

call_attribute

Gets the call_attribute of this AbstractDataOperationConfig.

data_format

Gets the data_format of this WriteOperationConfig.

derived_attributes

Gets the derived_attributes of this AbstractDataOperationConfig.

key

Gets the key of this WriteOperationConfig.

merge_key

Gets the merge_key of this WriteOperationConfig.

metadata_config_properties

Gets the metadata_config_properties of this AbstractDataOperationConfig.

model_type

[Required] Gets the model_type of this AbstractDataOperationConfig.

model_version

Gets the model_version of this WriteOperationConfig.

object_status

Gets the object_status of this WriteOperationConfig.

operations

Gets the operations of this WriteOperationConfig.

parent_ref

Gets the parent_ref of this WriteOperationConfig.

partition_config

Gets the partition_config of this WriteOperationConfig.

write_attribute

Gets the write_attribute of this WriteOperationConfig.

write_mode

Gets the write_mode of this WriteOperationConfig.

Methods:

__init__(**kwargs)

Initializes a new WriteOperationConfig 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_READ_OPERATION_CONFIG = 'READ_OPERATION_CONFIG'

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

MODEL_TYPE_WRITE_OPERATION_CONFIG = 'WRITE_OPERATION_CONFIG'

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

WRITE_MODE_APPEND = 'APPEND'

A constant which can be used with the write_mode property of a WriteOperationConfig. This constant has a value of “APPEND”

WRITE_MODE_IGNORE = 'IGNORE'

A constant which can be used with the write_mode property of a WriteOperationConfig. This constant has a value of “IGNORE”

WRITE_MODE_MERGE = 'MERGE'

A constant which can be used with the write_mode property of a WriteOperationConfig. This constant has a value of “MERGE”

WRITE_MODE_OVERWRITE = 'OVERWRITE'

A constant which can be used with the write_mode property of a WriteOperationConfig. This constant has a value of “OVERWRITE”

__init__(**kwargs)

Initializes a new WriteOperationConfig object with values from keyword arguments. The default value of the model_type attribute of this class is WRITE_OPERATION_CONFIG 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 WriteOperationConfig. Allowed values for this property are: “READ_OPERATION_CONFIG”, “WRITE_OPERATION_CONFIG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

  • call_attribute (oci.data_integration.models.BipCallAttribute) – The value to assign to the call_attribute property of this WriteOperationConfig.

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

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

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

  • operations (list[oci.data_integration.models.PushDownOperation]) – The value to assign to the operations property of this WriteOperationConfig.

  • data_format (oci.data_integration.models.DataFormat) – The value to assign to the data_format property of this WriteOperationConfig.

  • partition_config (oci.data_integration.models.PartitionConfig) – The value to assign to the partition_config property of this WriteOperationConfig.

  • write_attribute (oci.data_integration.models.AbstractWriteAttribute) – The value to assign to the write_attribute property of this WriteOperationConfig.

  • write_mode (str) – The value to assign to the write_mode property of this WriteOperationConfig. Allowed values for this property are: “OVERWRITE”, “APPEND”, “MERGE”, “IGNORE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • merge_key (oci.data_integration.models.UniqueKey) – The value to assign to the merge_key property of this WriteOperationConfig.

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

property call_attribute

Gets the call_attribute of this AbstractDataOperationConfig.

Returns

The call_attribute of this AbstractDataOperationConfig.

Return type

oci.data_integration.models.BipCallAttribute

property data_format

Gets the data_format of this WriteOperationConfig.

Returns

The data_format of this WriteOperationConfig.

Return type

oci.data_integration.models.DataFormat

property derived_attributes

Gets the derived_attributes of this AbstractDataOperationConfig. this map is used for passing BIP report parameter values.

Returns

The derived_attributes of this AbstractDataOperationConfig.

Return type

dict(str, 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 key

Gets the key of this WriteOperationConfig. The object key.

Returns

The key of this WriteOperationConfig.

Return type

str

property merge_key

Gets the merge_key of this WriteOperationConfig.

Returns

The merge_key of this WriteOperationConfig.

Return type

oci.data_integration.models.UniqueKey

property metadata_config_properties

Gets the metadata_config_properties of this AbstractDataOperationConfig. This map is used for passing extra metatdata configuration that is required by read / write operation.

Returns

The metadata_config_properties of this AbstractDataOperationConfig.

Return type

dict(str, str)

property model_type

[Required] Gets the model_type of this AbstractDataOperationConfig. The type of data operation.

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

Returns

The model_type of this AbstractDataOperationConfig.

Return type

str

property model_version

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

Returns

The model_version of this WriteOperationConfig.

Return type

str

property object_status

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

Return type

int

property operations

Gets the operations of this WriteOperationConfig. An array of operations.

Returns

The operations of this WriteOperationConfig.

Return type

list[oci.data_integration.models.PushDownOperation]

property parent_ref

Gets the parent_ref of this WriteOperationConfig.

Returns

The parent_ref of this WriteOperationConfig.

Return type

oci.data_integration.models.ParentReference

property partition_config

Gets the partition_config of this WriteOperationConfig.

Returns

The partition_config of this WriteOperationConfig.

Return type

oci.data_integration.models.PartitionConfig

property write_attribute

Gets the write_attribute of this WriteOperationConfig.

Returns

The write_attribute of this WriteOperationConfig.

Return type

oci.data_integration.models.AbstractWriteAttribute

property write_mode

Gets the write_mode of this WriteOperationConfig. The mode for the write operation.

Allowed values for this property are: “OVERWRITE”, “APPEND”, “MERGE”, “IGNORE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The write_mode of this WriteOperationConfig.

Return type

str