OrchestrationVariable

class oci.marketplace.models.OrchestrationVariable(**kwargs)

Bases: object

The model of a variable for an orchestration resource.

Attributes

DATA_TYPE_INTEGER A constant which can be used with the data_type property of a OrchestrationVariable.
DATA_TYPE_STRING A constant which can be used with the data_type property of a OrchestrationVariable.
data_type Gets the data_type of this OrchestrationVariable.
default_value Gets the default_value of this OrchestrationVariable.
description Gets the description of this OrchestrationVariable.
hint_message Gets the hint_message of this OrchestrationVariable.
is_mandatory Gets the is_mandatory of this OrchestrationVariable.
name Gets the name of this OrchestrationVariable.

Methods

__init__(**kwargs) Initializes a new OrchestrationVariable object with values from keyword arguments.
DATA_TYPE_INTEGER = 'INTEGER'

A constant which can be used with the data_type property of a OrchestrationVariable. This constant has a value of “INTEGER”

DATA_TYPE_STRING = 'STRING'

A constant which can be used with the data_type property of a OrchestrationVariable. This constant has a value of “STRING”

__init__(**kwargs)

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

Parameters:
  • name (str) – The value to assign to the name property of this OrchestrationVariable.
  • default_value (str) – The value to assign to the default_value property of this OrchestrationVariable.
  • description (str) – The value to assign to the description property of this OrchestrationVariable.
  • data_type (str) – The value to assign to the data_type property of this OrchestrationVariable. Allowed values for this property are: “STRING”, “INTEGER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • is_mandatory (bool) – The value to assign to the is_mandatory property of this OrchestrationVariable.
  • hint_message (str) – The value to assign to the hint_message property of this OrchestrationVariable.
data_type

Gets the data_type of this OrchestrationVariable. The data type of the variable.

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

Returns:The data_type of this OrchestrationVariable.
Return type:str
default_value

Gets the default_value of this OrchestrationVariable. The variable’s default value.

Returns:The default_value of this OrchestrationVariable.
Return type:str
description

Gets the description of this OrchestrationVariable. A description of the variable.

Returns:The description of this OrchestrationVariable.
Return type:str
hint_message

Gets the hint_message of this OrchestrationVariable. A brief textual description that helps to explain the variable.

Returns:The hint_message of this OrchestrationVariable.
Return type:str
is_mandatory

Gets the is_mandatory of this OrchestrationVariable. Whether the variable is mandatory.

Returns:The is_mandatory of this OrchestrationVariable.
Return type:bool
name

Gets the name of this OrchestrationVariable. The name of the variable.

Returns:The name of this OrchestrationVariable.
Return type:str