OciFunction

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

Bases: object

The information about the OCI Function.

Attributes:

MODEL_TYPE_OCI_FUNCTION

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

PAYLOAD_FORMAT_AVRO

A constant which can be used with the payload_format property of a OciFunction.

PAYLOAD_FORMAT_JSON

A constant which can be used with the payload_format property of a OciFunction.

PAYLOAD_FORMAT_JSONBYTES

A constant which can be used with the payload_format property of a OciFunction.

fn_config_def

Gets the fn_config_def of this OciFunction.

fn_config_definition

Gets the fn_config_definition of this OciFunction.

function_id

Gets the function_id of this OciFunction.

input_shape

Gets the input_shape of this OciFunction.

key

Gets the key of this OciFunction.

model_type

Gets the model_type of this OciFunction.

model_version

Gets the model_version of this OciFunction.

object_version

Gets the object_version of this OciFunction.

output_shape

Gets the output_shape of this OciFunction.

parent_ref

Gets the parent_ref of this OciFunction.

payload_format

Gets the payload_format of this OciFunction.

region_id

Gets the region_id of this OciFunction.

Methods:

__init__(**kwargs)

Initializes a new OciFunction object with values from keyword arguments.

MODEL_TYPE_OCI_FUNCTION = 'OCI_FUNCTION'

A constant which can be used with the model_type property of a OciFunction. This constant has a value of “OCI_FUNCTION”

PAYLOAD_FORMAT_AVRO = 'AVRO'

A constant which can be used with the payload_format property of a OciFunction. This constant has a value of “AVRO”

PAYLOAD_FORMAT_JSON = 'JSON'

A constant which can be used with the payload_format property of a OciFunction. This constant has a value of “JSON”

PAYLOAD_FORMAT_JSONBYTES = 'JSONBYTES'

A constant which can be used with the payload_format property of a OciFunction. This constant has a value of “JSONBYTES”

__init__(**kwargs)

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

Parameters
  • function_id (str) – The value to assign to the function_id property of this OciFunction.

  • region_id (str) – The value to assign to the region_id property of this OciFunction.

  • fn_config_definition (oci.data_integration.models.ConfigDefinition) – The value to assign to the fn_config_definition property of this OciFunction.

  • input_shape (oci.data_integration.models.Shape) – The value to assign to the input_shape property of this OciFunction.

  • output_shape (oci.data_integration.models.Shape) – The value to assign to the output_shape property of this OciFunction.

  • model_type (str) – The value to assign to the model_type property of this OciFunction. Allowed values for this property are: “OCI_FUNCTION”, ‘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 OciFunction.

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

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

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

  • payload_format (str) – The value to assign to the payload_format property of this OciFunction. Allowed values for this property are: “JSON”, “AVRO”, “JSONBYTES”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • fn_config_def (oci.data_integration.models.FunctionConfigurationDefinition) – The value to assign to the fn_config_def property of this OciFunction.

property fn_config_def

Gets the fn_config_def of this OciFunction.

Returns

The fn_config_def of this OciFunction.

Return type

oci.data_integration.models.FunctionConfigurationDefinition

property fn_config_definition

Gets the fn_config_definition of this OciFunction.

Returns

The fn_config_definition of this OciFunction.

Return type

oci.data_integration.models.ConfigDefinition

property function_id

Gets the function_id of this OciFunction. Ocid of the OCI Function.

Returns

The function_id of this OciFunction.

Return type

str

property input_shape

Gets the input_shape of this OciFunction.

Returns

The input_shape of this OciFunction.

Return type

oci.data_integration.models.Shape

property key

Gets the key of this OciFunction. The key identifying the OCI Function operator object, use this to identiy this instance within the dataflow.

Returns

The key of this OciFunction.

Return type

str

property model_type

Gets the model_type of this OciFunction. The type of the OCI Function object.

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

Returns

The model_type of this OciFunction.

Return type

str

property model_version

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

Returns

The model_version of this OciFunction.

Return type

str

property object_version

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

Returns

The object_version of this OciFunction.

Return type

int

property output_shape

Gets the output_shape of this OciFunction.

Returns

The output_shape of this OciFunction.

Return type

oci.data_integration.models.Shape

property parent_ref

Gets the parent_ref of this OciFunction.

Returns

The parent_ref of this OciFunction.

Return type

oci.data_integration.models.ParentReference

property payload_format

Gets the payload_format of this OciFunction. The OCI Function payload format.

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

Returns

The payload_format of this OciFunction.

Return type

str

property region_id

Gets the region_id of this OciFunction. Region where the OCI Function is deployed.

Returns

The region_id of this OciFunction.

Return type

str