UserDefinedFunctionDetails

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

Bases: object

The information about a user defined function.

Attributes:

MODEL_TYPE_DIS_USER_DEFINED_FUNCTION

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

description

Gets the description of this UserDefinedFunctionDetails.

expr

Gets the expr of this UserDefinedFunctionDetails.

identifier

Gets the identifier of this UserDefinedFunctionDetails.

key

[Required] Gets the key of this UserDefinedFunctionDetails.

model_type

[Required] Gets the model_type of this UserDefinedFunctionDetails.

model_version

Gets the model_version of this UserDefinedFunctionDetails.

name

Gets the name of this UserDefinedFunctionDetails.

object_status

Gets the object_status of this UserDefinedFunctionDetails.

object_version

[Required] Gets the object_version of this UserDefinedFunctionDetails.

parent_ref

Gets the parent_ref of this UserDefinedFunctionDetails.

registry_metadata

Gets the registry_metadata of this UserDefinedFunctionDetails.

signatures

Gets the signatures of this UserDefinedFunctionDetails.

Methods:

__init__(**kwargs)

Initializes a new UserDefinedFunctionDetails 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 UserDefinedFunctionDetails. This constant has a value of “DIS_USER_DEFINED_FUNCTION”

__init__(**kwargs)

Initializes a new UserDefinedFunctionDetails 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 UserDefinedFunctionDetails.

  • model_type (str) – The value to assign to the model_type property of this UserDefinedFunctionDetails. Allowed values for this property are: “DIS_USER_DEFINED_FUNCTION”

  • model_version (str) – The value to assign to the model_version property of this UserDefinedFunctionDetails.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this UserDefinedFunctionDetails.

  • name (str) – The value to assign to the name property of this UserDefinedFunctionDetails.

  • identifier (str) – The value to assign to the identifier property of this UserDefinedFunctionDetails.

  • object_version (int) – The value to assign to the object_version property of this UserDefinedFunctionDetails.

  • signatures (list[oci.data_integration.models.FunctionSignature]) – The value to assign to the signatures property of this UserDefinedFunctionDetails.

  • expr (oci.data_integration.models.Expression) – The value to assign to the expr property of this UserDefinedFunctionDetails.

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

  • object_status (int) – The value to assign to the object_status property of this UserDefinedFunctionDetails.

  • registry_metadata (oci.data_integration.models.RegistryMetadata) – The value to assign to the registry_metadata property of this UserDefinedFunctionDetails.

property description

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

Returns

The description of this UserDefinedFunctionDetails.

Return type

str

property expr

Gets the expr of this UserDefinedFunctionDetails.

Returns

The expr of this UserDefinedFunctionDetails.

Return type

oci.data_integration.models.Expression

property identifier

Gets the identifier of this UserDefinedFunctionDetails. 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 UserDefinedFunctionDetails.

Return type

str

property key

[Required] Gets the key of this UserDefinedFunctionDetails. 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 UserDefinedFunctionDetails.

Return type

str

property model_type

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

Allowed values for this property are: “DIS_USER_DEFINED_FUNCTION”

Returns

The model_type of this UserDefinedFunctionDetails.

Return type

str

property model_version

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

Returns

The model_version of this UserDefinedFunctionDetails.

Return type

str

property name

Gets the name of this UserDefinedFunctionDetails. 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 UserDefinedFunctionDetails.

Return type

str

property object_status

Gets the object_status of this UserDefinedFunctionDetails. 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 UserDefinedFunctionDetails.

Return type

int

property object_version

[Required] Gets the object_version of this UserDefinedFunctionDetails. The version of the object that is used to track changes in the object instance.

Returns

The object_version of this UserDefinedFunctionDetails.

Return type

int

property parent_ref

Gets the parent_ref of this UserDefinedFunctionDetails.

Returns

The parent_ref of this UserDefinedFunctionDetails.

Return type

oci.data_integration.models.ParentReference

property registry_metadata

Gets the registry_metadata of this UserDefinedFunctionDetails.

Returns

The registry_metadata of this UserDefinedFunctionDetails.

Return type

oci.data_integration.models.RegistryMetadata

property signatures

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

Returns

The signatures of this UserDefinedFunctionDetails.

Return type

list[oci.data_integration.models.FunctionSignature]