FieldMap

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

Bases: object

A field map is a way to map a source row shape to a target row shape that may be different.

Attributes:

MODEL_TYPE_COMPOSITE_FIELD_MAP

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

MODEL_TYPE_CONDITIONAL_COMPOSITE_FIELD_MAP

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

MODEL_TYPE_DIRECT_FIELD_MAP

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

MODEL_TYPE_DIRECT_NAMED_FIELD_MAP

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

MODEL_TYPE_NAMED_ENTITY_MAP

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

MODEL_TYPE_RULE_BASED_ENTITY_MAP

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

MODEL_TYPE_RULE_BASED_FIELD_MAP

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

description

Gets the description of this FieldMap.

model_type

[Required] Gets the model_type of this FieldMap.

Methods:

__init__(**kwargs)

Initializes a new FieldMap 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_COMPOSITE_FIELD_MAP = 'COMPOSITE_FIELD_MAP'

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

MODEL_TYPE_CONDITIONAL_COMPOSITE_FIELD_MAP = 'CONDITIONAL_COMPOSITE_FIELD_MAP'

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

MODEL_TYPE_DIRECT_FIELD_MAP = 'DIRECT_FIELD_MAP'

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

MODEL_TYPE_DIRECT_NAMED_FIELD_MAP = 'DIRECT_NAMED_FIELD_MAP'

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

MODEL_TYPE_NAMED_ENTITY_MAP = 'NAMED_ENTITY_MAP'

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

MODEL_TYPE_RULE_BASED_ENTITY_MAP = 'RULE_BASED_ENTITY_MAP'

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

MODEL_TYPE_RULE_BASED_FIELD_MAP = 'RULE_BASED_FIELD_MAP'

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

__init__(**kwargs)

Initializes a new FieldMap 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 FieldMap. Allowed values for this property are: “DIRECT_NAMED_FIELD_MAP”, “COMPOSITE_FIELD_MAP”, “DIRECT_FIELD_MAP”, “RULE_BASED_FIELD_MAP”, “CONDITIONAL_COMPOSITE_FIELD_MAP”, “NAMED_ENTITY_MAP”, “RULE_BASED_ENTITY_MAP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

property description

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

Returns

The description of this FieldMap.

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 model_type

[Required] Gets the model_type of this FieldMap. The model type for the field map.

Allowed values for this property are: “DIRECT_NAMED_FIELD_MAP”, “COMPOSITE_FIELD_MAP”, “DIRECT_FIELD_MAP”, “RULE_BASED_FIELD_MAP”, “CONDITIONAL_COMPOSITE_FIELD_MAP”, “NAMED_ENTITY_MAP”, “RULE_BASED_ENTITY_MAP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this FieldMap.

Return type

str