UserDefinedFunction¶

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

Bases: object

The user defined function type contains the audit summary information and the definition of the user defined function.

Attributes

`MODEL_TYPE_DIS_USER_DEFINED_FUNCTION`	A constant which can be used with the model_type property of a UserDefinedFunction.
`description`	Gets the description of this UserDefinedFunction.
`expr`	Gets the expr of this UserDefinedFunction.
`identifier`	Gets the identifier of this UserDefinedFunction.
`key`	Gets the key of this UserDefinedFunction.
`key_map`	Gets the key_map of this UserDefinedFunction.
`metadata`	Gets the metadata of this UserDefinedFunction.
`model_type`	Gets the model_type of this UserDefinedFunction.
`model_version`	Gets the model_version of this UserDefinedFunction.
`name`	Gets the name of this UserDefinedFunction.
`object_status`	Gets the object_status of this UserDefinedFunction.
`object_version`	Gets the object_version of this UserDefinedFunction.
`parent_ref`	Gets the parent_ref of this UserDefinedFunction.
`signatures`	Gets the signatures of this UserDefinedFunction.

Methods

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

MODEL_TYPE_DIS_USER_DEFINED_FUNCTION = 'DIS_USER_DEFINED_FUNCTION'¶: A constant which can be used with the model_type property of a UserDefinedFunction. This constant has a value of “DIS_USER_DEFINED_FUNCTION”

__init__(**kwargs)¶

Initializes a new UserDefinedFunction 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 UserDefinedFunction.
model_type (str) – The value to assign to the model_type property of this UserDefinedFunction. Allowed values for this property are: “DIS_USER_DEFINED_FUNCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
model_version (str) – The value to assign to the model_version property of this UserDefinedFunction.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this UserDefinedFunction.
name (str) – The value to assign to the name property of this UserDefinedFunction.
identifier (str) – The value to assign to the identifier property of this UserDefinedFunction.
object_version (int) – The value to assign to the object_version property of this UserDefinedFunction.
signatures (list[oci.data_integration.models.FunctionSignature]) – The value to assign to the signatures property of this UserDefinedFunction.
expr (oci.data_integration.models.Expression) – The value to assign to the expr property of this UserDefinedFunction.
description (str) – The value to assign to the description property of this UserDefinedFunction.
object_status (int) – The value to assign to the object_status property of this UserDefinedFunction.
metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this UserDefinedFunction.
key_map (dict(str, str)) – The value to assign to the key_map property of this UserDefinedFunction.

description¶

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

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

expr¶

Gets the expr of this UserDefinedFunction.

Returns:	The expr of this UserDefinedFunction.
Return type:	oci.data_integration.models.Expression

identifier¶

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

key¶

Gets the key of this UserDefinedFunction. Generated key that can be used in API calls to identify user defined function. On scenarios where reference to the user defined function is needed, a value can be passed in create.

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

key_map¶

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

metadata¶

Gets the metadata of this UserDefinedFunction.

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

model_type¶

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

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

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

model_version¶

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

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

name¶

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

object_status¶

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

object_version¶

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

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

parent_ref¶

Gets the parent_ref of this UserDefinedFunction.

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

signatures¶

Gets the signatures of this UserDefinedFunction. An array of function signature.

Returns:	The signatures of this UserDefinedFunction.
Return type:	list[oci.data_integration.models.FunctionSignature]