Parameter¶
- class oci.oda.models.Parameter(**kwargs)¶
Bases:
objectMetadata for a Parameter.
Attributes:
A constant which can be used with the lifecycle_state property of a Parameter.
A constant which can be used with the lifecycle_state property of a Parameter.
A constant which can be used with the lifecycle_state property of a Parameter.
A constant which can be used with the lifecycle_state property of a Parameter.
A constant which can be used with the lifecycle_state property of a Parameter.
A constant which can be used with the lifecycle_state property of a Parameter.
A constant which can be used with the lifecycle_state property of a Parameter.
A constant which can be used with the type property of a Parameter.
A constant which can be used with the type property of a Parameter.
A constant which can be used with the type property of a Parameter.
A constant which can be used with the type property of a Parameter.
A constant which can be used with the type property of a Parameter.
Gets the description of this Parameter.
[Required] Gets the display_name of this Parameter.
[Required] Gets the lifecycle_state of this Parameter.
[Required] Gets the name of this Parameter.
[Required] Gets the type of this Parameter.
[Required] Gets the value of this Parameter.
Methods:
__init__(**kwargs)Initializes a new Parameter object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Parameter. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Parameter. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Parameter. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Parameter. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Parameter. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Parameter. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Parameter. This constant has a value of “UPDATING”
- TYPE_BOOLEAN = 'BOOLEAN'¶
A constant which can be used with the type property of a Parameter. This constant has a value of “BOOLEAN”
- TYPE_FLOAT = 'FLOAT'¶
A constant which can be used with the type property of a Parameter. This constant has a value of “FLOAT”
- TYPE_INTEGER = 'INTEGER'¶
A constant which can be used with the type property of a Parameter. This constant has a value of “INTEGER”
- TYPE_SECURE = 'SECURE'¶
A constant which can be used with the type property of a Parameter. This constant has a value of “SECURE”
- TYPE_STRING = 'STRING'¶
A constant which can be used with the type property of a Parameter. This constant has a value of “STRING”
- __init__(**kwargs)¶
Initializes a new Parameter 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 Parameter.
display_name (str) – The value to assign to the display_name property of this Parameter.
description (str) – The value to assign to the description property of this Parameter.
type (str) – The value to assign to the type property of this Parameter. Allowed values for this property are: “STRING”, “INTEGER”, “FLOAT”, “BOOLEAN”, “SECURE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
value (str) – The value to assign to the value property of this Parameter.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Parameter. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property description¶
Gets the description of this Parameter. A description of the Parameter.
- Returns
The description of this Parameter.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this Parameter. The display name for the Parameter.
- Returns
The display_name of this Parameter.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Parameter. The Parameter’s current state.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this Parameter.
- Return type
str
- property name¶
[Required] Gets the name of this Parameter. The Parameter name. This must be unique within the parent resource.
- Returns
The name of this Parameter.
- Return type
str
- property type¶
[Required] Gets the type of this Parameter. The value type.
Allowed values for this property are: “STRING”, “INTEGER”, “FLOAT”, “BOOLEAN”, “SECURE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this Parameter.
- Return type
str
- property value¶
[Required] Gets the value of this Parameter. The current value. The value will be interpreted based on the type.
- Returns
The value of this Parameter.
- Return type
str