Variable¶

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

Bases: object

Variable definitions in the pipeline.

Methods

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

Attributes

`config_values`	Gets the config_values of this Variable.
`default_value`	Gets the default_value of this Variable.
`description`	Gets the description of this Variable.
`identifier`	Gets the identifier of this Variable.
`key`	Gets the key of this Variable.
`model_type`	Gets the model_type of this Variable.
`model_version`	Gets the model_version of this Variable.
`name`	Gets the name of this Variable.
`object_status`	Gets the object_status of this Variable.
`object_version`	Gets the object_version of this Variable.
`parent_ref`	Gets the parent_ref of this Variable.
`root_object_default_value`	Gets the root_object_default_value of this Variable.
`type`	Gets the type of this Variable.

__init__(**kwargs)¶

Initializes a new Variable 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 Variable.
model_version (str) – The value to assign to the model_version property of this Variable.
model_type (str) – The value to assign to the model_type property of this Variable.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this Variable.
name (str) – The value to assign to the name property of this Variable.
description (str) – The value to assign to the description property of this Variable.
object_version (int) – The value to assign to the object_version property of this Variable.
object_status (int) – The value to assign to the object_status property of this Variable.
identifier (str) – The value to assign to the identifier property of this Variable.
type (oci.data_integration.models.BaseType) – The value to assign to the type property of this Variable.
config_values (oci.data_integration.models.ConfigValues) – The value to assign to the config_values property of this Variable.
default_value (object) – The value to assign to the default_value property of this Variable.
root_object_default_value (oci.data_integration.models.RootObject) – The value to assign to the root_object_default_value property of this Variable.

config_values¶

Gets the config_values of this Variable.

Returns:	The config_values of this Variable.
Return type:	oci.data_integration.models.ConfigValues

default_value¶

Gets the default_value of this Variable. A default value for the vairable.

Returns:	The default_value of this Variable.
Return type:	object

description¶

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

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

identifier¶

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

key¶

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

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

model_type¶

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

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

model_version¶

Gets the model_version of this Variable. This is a version number that is used by the service to upgrade objects if needed through releases of the service.

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

name¶

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

object_status¶

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

object_version¶

Gets the object_version of this Variable. This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.

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

parent_ref¶

Gets the parent_ref of this Variable.

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

root_object_default_value¶

Gets the root_object_default_value of this Variable.

Returns:	The root_object_default_value of this Variable.
Return type:	oci.data_integration.models.RootObject

type¶

Gets the type of this Variable.

Returns:	The type of this Variable.
Return type:	oci.data_integration.models.BaseType