ShapeField¶

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

Bases: oci.data_integration.models.typed_object.TypedObject

The shape field object.

Attributes

`MODEL_TYPE_CONDITIONAL_OUTPUT_PORT`	str(object=’’) -> str
`MODEL_TYPE_DECISION_OUTPUT_PORT`	str(object=’’) -> str
`MODEL_TYPE_DERIVED_FIELD`	str(object=’’) -> str
`MODEL_TYPE_DYNAMIC_INPUT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_DYNAMIC_PROXY_FIELD`	str(object=’’) -> str
`MODEL_TYPE_INPUT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_INPUT_PORT`	str(object=’’) -> str
`MODEL_TYPE_INPUT_PROXY_FIELD`	str(object=’’) -> str
`MODEL_TYPE_MACRO_FIELD`	str(object=’’) -> str
`MODEL_TYPE_MACRO_PIVOT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_MATERIALIZED_DYNAMIC_FIELD`	str(object=’’) -> str
`MODEL_TYPE_OUTPUT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_OUTPUT_PORT`	str(object=’’) -> str
`MODEL_TYPE_PARAMETER`	str(object=’’) -> str
`MODEL_TYPE_PIVOT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_PROXY_FIELD`	str(object=’’) -> str
`MODEL_TYPE_SHAPE`	str(object=’’) -> str
`MODEL_TYPE_SHAPE_FIELD`	str(object=’’) -> str
`config_values`	Gets the config_values of this TypedObject.
`description`	Gets the description of this TypedObject.
`key`	Gets the key of this TypedObject.
`labels`	Gets the labels of this ShapeField.
`model_type`	[Required] Gets the model_type of this TypedObject.
`model_version`	Gets the model_version of this TypedObject.
`name`	Gets the name of this TypedObject.
`native_shape_field`	Gets the native_shape_field of this ShapeField.
`object_status`	Gets the object_status of this TypedObject.
`parent_ref`	Gets the parent_ref of this TypedObject.
`type`	Gets the type of this ShapeField.

Methods

`__init__`(**kwargs)	Initializes a new ShapeField 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_CONDITIONAL_OUTPUT_PORT = 'CONDITIONAL_OUTPUT_PORT'¶

MODEL_TYPE_DECISION_OUTPUT_PORT = 'DECISION_OUTPUT_PORT'¶

MODEL_TYPE_DERIVED_FIELD = 'DERIVED_FIELD'¶

MODEL_TYPE_DYNAMIC_INPUT_FIELD = 'DYNAMIC_INPUT_FIELD'¶

MODEL_TYPE_DYNAMIC_PROXY_FIELD = 'DYNAMIC_PROXY_FIELD'¶

MODEL_TYPE_INPUT_FIELD = 'INPUT_FIELD'¶

MODEL_TYPE_INPUT_PORT = 'INPUT_PORT'¶

MODEL_TYPE_INPUT_PROXY_FIELD = 'INPUT_PROXY_FIELD'¶

MODEL_TYPE_MACRO_FIELD = 'MACRO_FIELD'¶

MODEL_TYPE_MACRO_PIVOT_FIELD = 'MACRO_PIVOT_FIELD'¶

MODEL_TYPE_MATERIALIZED_DYNAMIC_FIELD = 'MATERIALIZED_DYNAMIC_FIELD'¶

MODEL_TYPE_OUTPUT_FIELD = 'OUTPUT_FIELD'¶

MODEL_TYPE_OUTPUT_PORT = 'OUTPUT_PORT'¶

MODEL_TYPE_PARAMETER = 'PARAMETER'¶

MODEL_TYPE_PIVOT_FIELD = 'PIVOT_FIELD'¶

MODEL_TYPE_PROXY_FIELD = 'PROXY_FIELD'¶

MODEL_TYPE_SHAPE = 'SHAPE'¶

MODEL_TYPE_SHAPE_FIELD = 'SHAPE_FIELD'¶

__init__(**kwargs)¶

Initializes a new ShapeField object with values from keyword arguments. The default value of the model_type attribute of this class is SHAPE_FIELD 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 ShapeField. Allowed values for this property are: “SHAPE”, “INPUT_PORT”, “SHAPE_FIELD”, “INPUT_FIELD”, “DERIVED_FIELD”, “MACRO_FIELD”, “OUTPUT_FIELD”, “DYNAMIC_PROXY_FIELD”, “OUTPUT_PORT”, “DYNAMIC_INPUT_FIELD”, “PROXY_FIELD”, “PARAMETER”, “PIVOT_FIELD”, “MACRO_PIVOT_FIELD”, “CONDITIONAL_OUTPUT_PORT”, “INPUT_PROXY_FIELD”, “MATERIALIZED_DYNAMIC_FIELD”, “DECISION_OUTPUT_PORT”, ‘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 ShapeField.
model_version (str) – The value to assign to the model_version property of this ShapeField.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this ShapeField.
config_values (oci.data_integration.models.ConfigValues) – The value to assign to the config_values property of this ShapeField.
object_status (int) – The value to assign to the object_status property of this ShapeField.
name (str) – The value to assign to the name property of this ShapeField.
description (str) – The value to assign to the description property of this ShapeField.
type (object) – The value to assign to the type property of this ShapeField.
labels (list[str]) – The value to assign to the labels property of this ShapeField.
native_shape_field (oci.data_integration.models.NativeShapeField) – The value to assign to the native_shape_field property of this ShapeField.

config_values¶

Gets the config_values of this TypedObject.

Returns:	The config_values of this TypedObject.
Return type:	oci.data_integration.models.ConfigValues

description¶

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

Returns:	The description of this TypedObject.
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.

key¶

Gets the key of this TypedObject. The key of the object.

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

labels¶

Gets the labels of this ShapeField. Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content.

Returns:	The labels of this ShapeField.
Return type:	list[str]

model_type¶

[Required] Gets the model_type of this TypedObject. The type of the types object.

Allowed values for this property are: “SHAPE”, “INPUT_PORT”, “SHAPE_FIELD”, “INPUT_FIELD”, “DERIVED_FIELD”, “MACRO_FIELD”, “OUTPUT_FIELD”, “DYNAMIC_PROXY_FIELD”, “OUTPUT_PORT”, “DYNAMIC_INPUT_FIELD”, “PROXY_FIELD”, “PARAMETER”, “PIVOT_FIELD”, “MACRO_PIVOT_FIELD”, “CONDITIONAL_OUTPUT_PORT”, “INPUT_PROXY_FIELD”, “MATERIALIZED_DYNAMIC_FIELD”, “DECISION_OUTPUT_PORT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

model_version¶

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

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

name¶

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

native_shape_field¶

Gets the native_shape_field of this ShapeField.

Returns:	The native_shape_field of this ShapeField.
Return type:	oci.data_integration.models.NativeShapeField

object_status¶

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

parent_ref¶

Gets the parent_ref of this TypedObject.

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

type¶

Gets the type of this ShapeField. The reference to the type.

Returns:	The type of this ShapeField.
Return type:	object