ScopeReference¶

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

Bases: object

The ScopeReference class is a base class for any model object that wraps a scope reference to a TypedObject.

Attributes:

`REFERENCE_TYPE_BOUND_ENTITY_SHAPE`	A constant which can be used with the reference_type property of a ScopeReference.
`REFERENCE_TYPE_BOUND_ENTITY_SHAPE_FIELD`	A constant which can be used with the reference_type property of a ScopeReference.
`REFERENCE_TYPE_DIRECT_REF`	A constant which can be used with the reference_type property of a ScopeReference.
`REFERENCE_TYPE_OCI_FUNCTION_INPUT_SHAPE`	A constant which can be used with the reference_type property of a ScopeReference.
`REFERENCE_TYPE_OCI_FUNCTION_OUTPUT_SHAPE`	A constant which can be used with the reference_type property of a ScopeReference.
`ref_object_name`	Gets the ref_object_name of this ScopeReference.
`reference_object`	[Required] Gets the reference_object of this ScopeReference.
`reference_type`	Gets the reference_type of this ScopeReference.

Methods:

__init__(**kwargs)

Initializes a new ScopeReference object with values from keyword arguments.

REFERENCE_TYPE_BOUND_ENTITY_SHAPE = 'BOUND_ENTITY_SHAPE'¶: A constant which can be used with the reference_type property of a ScopeReference. This constant has a value of “BOUND_ENTITY_SHAPE”

REFERENCE_TYPE_BOUND_ENTITY_SHAPE_FIELD = 'BOUND_ENTITY_SHAPE_FIELD'¶: A constant which can be used with the reference_type property of a ScopeReference. This constant has a value of “BOUND_ENTITY_SHAPE_FIELD”

REFERENCE_TYPE_DIRECT_REF = 'DIRECT_REF'¶: A constant which can be used with the reference_type property of a ScopeReference. This constant has a value of “DIRECT_REF”

REFERENCE_TYPE_OCI_FUNCTION_INPUT_SHAPE = 'OCI_FUNCTION_INPUT_SHAPE'¶: A constant which can be used with the reference_type property of a ScopeReference. This constant has a value of “OCI_FUNCTION_INPUT_SHAPE”

REFERENCE_TYPE_OCI_FUNCTION_OUTPUT_SHAPE = 'OCI_FUNCTION_OUTPUT_SHAPE'¶: A constant which can be used with the reference_type property of a ScopeReference. This constant has a value of “OCI_FUNCTION_OUTPUT_SHAPE”

__init__(**kwargs)¶

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

Parameters

reference_object (str) – The value to assign to the reference_object property of this ScopeReference.
reference_type (str) – The value to assign to the reference_type property of this ScopeReference. Allowed values for this property are: “DIRECT_REF”, “BOUND_ENTITY_SHAPE”, “BOUND_ENTITY_SHAPE_FIELD”, “OCI_FUNCTION_INPUT_SHAPE”, “OCI_FUNCTION_OUTPUT_SHAPE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ref_object_name (str) – The value to assign to the ref_object_name property of this ScopeReference.

property ref_object_name¶

Gets the ref_object_name of this ScopeReference. The referenced object name for this reference. Set to the field name if the referenceType is BOUND_ENTITY_SHAPE_FIELD, else set to null.

Returns: The ref_object_name of this ScopeReference.
Return type: str

property reference_object¶

[Required] Gets the reference_object of this ScopeReference. A key or shallow reference to an object. For direct reference, it points to the actual scope object. For BOUND_ENTITY_SHAPE or BOUND_ENTITY_SHAPE_FIELD, it points to the source or target operator. For OCI_FUNCTION_INPUT_SHAPE or OCI_FUNCTION_OUTPUT_SHAPE, it points to the OCI Function object.

Returns: The reference_object of this ScopeReference.
Return type: str

property reference_type¶

Gets the reference_type of this ScopeReference. The reference type for this reference. Set to null for a direct reference, for indirect references set to a type of association such as “BOUND_ENTITY_SHAPE”. Current known reference type values are “BOUND_ENTITY_SHAPE”, “BOUND_ENTITY_SHAPE_FIELD”, “OCI_FUNCTION_INPUT_SHAPE”, “OCI_FUNCTION_OUTPUT_SHAPE”

Allowed values for this property are: “DIRECT_REF”, “BOUND_ENTITY_SHAPE”, “BOUND_ENTITY_SHAPE_FIELD”, “OCI_FUNCTION_INPUT_SHAPE”, “OCI_FUNCTION_OUTPUT_SHAPE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The reference_type of this ScopeReference.
Return type: str