UserDefinedFunctionSummary¶

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

Bases: object

The user defined function summary 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 UserDefinedFunctionSummary.
`description`	Gets the description of this UserDefinedFunctionSummary.
`expr`	Gets the expr of this UserDefinedFunctionSummary.
`identifier`	Gets the identifier of this UserDefinedFunctionSummary.
`key`	Gets the key of this UserDefinedFunctionSummary.
`key_map`	Gets the key_map of this UserDefinedFunctionSummary.
`metadata`	Gets the metadata of this UserDefinedFunctionSummary.
`model_type`	Gets the model_type of this UserDefinedFunctionSummary.
`model_version`	Gets the model_version of this UserDefinedFunctionSummary.
`name`	Gets the name of this UserDefinedFunctionSummary.
`object_status`	Gets the object_status of this UserDefinedFunctionSummary.
`object_version`	Gets the object_version of this UserDefinedFunctionSummary.
`parent_ref`	Gets the parent_ref of this UserDefinedFunctionSummary.
`signatures`	Gets the signatures of this UserDefinedFunctionSummary.

Methods

__init__(**kwargs) Initializes a new UserDefinedFunctionSummary 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 UserDefinedFunctionSummary. This constant has a value of “DIS_USER_DEFINED_FUNCTION”

__init__(**kwargs)¶

Initializes a new UserDefinedFunctionSummary 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 UserDefinedFunctionSummary.
model_type (str) – The value to assign to the model_type property of this UserDefinedFunctionSummary. 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 UserDefinedFunctionSummary.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this UserDefinedFunctionSummary.
name (str) – The value to assign to the name property of this UserDefinedFunctionSummary.
identifier (str) – The value to assign to the identifier property of this UserDefinedFunctionSummary.
object_version (int) – The value to assign to the object_version property of this UserDefinedFunctionSummary.
signatures (list[oci.data_integration.models.FunctionSignature]) – The value to assign to the signatures property of this UserDefinedFunctionSummary.
expr (oci.data_integration.models.Expression) – The value to assign to the expr property of this UserDefinedFunctionSummary.
description (str) – The value to assign to the description property of this UserDefinedFunctionSummary.
object_status (int) – The value to assign to the object_status property of this UserDefinedFunctionSummary.
metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this UserDefinedFunctionSummary.
key_map (dict(str, str)) – The value to assign to the key_map property of this UserDefinedFunctionSummary.

description¶

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

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

expr¶

Gets the expr of this UserDefinedFunctionSummary.

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

identifier¶

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

key¶

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

key_map¶

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

metadata¶

Gets the metadata of this UserDefinedFunctionSummary.

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

model_type¶

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

model_version¶

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

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

name¶

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

object_status¶

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

object_version¶

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

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

parent_ref¶

Gets the parent_ref of this UserDefinedFunctionSummary.

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

signatures¶

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

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