StrategyParameter¶
- class oci.optimizer.models.StrategyParameter(**kwargs)¶
Bases:
objectThe metadata associated with the strategy parameter.
Attributes:
A constant which can be used with the type property of a StrategyParameter.
A constant which can be used with the type property of a StrategyParameter.
A constant which can be used with the type property of a StrategyParameter.
A constant which can be used with the type property of a StrategyParameter.
Gets the default_value of this StrategyParameter.
[Required] Gets the description of this StrategyParameter.
[Required] Gets the is_required of this StrategyParameter.
[Required] Gets the name of this StrategyParameter.
Gets the possible_values of this StrategyParameter.
[Required] Gets the type of this StrategyParameter.
Methods:
__init__(**kwargs)Initializes a new StrategyParameter object with values from keyword arguments.
- TYPE_BOOLEAN = 'BOOLEAN'¶
A constant which can be used with the type property of a StrategyParameter. This constant has a value of “BOOLEAN”
- TYPE_DATETIME = 'DATETIME'¶
A constant which can be used with the type property of a StrategyParameter. This constant has a value of “DATETIME”
- TYPE_NUMBER = 'NUMBER'¶
A constant which can be used with the type property of a StrategyParameter. This constant has a value of “NUMBER”
- TYPE_STRING = 'STRING'¶
A constant which can be used with the type property of a StrategyParameter. This constant has a value of “STRING”
- __init__(**kwargs)¶
Initializes a new StrategyParameter 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 StrategyParameter.
type (str) – The value to assign to the type property of this StrategyParameter. Allowed values for this property are: “STRING”, “BOOLEAN”, “NUMBER”, “DATETIME”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
description (str) – The value to assign to the description property of this StrategyParameter.
is_required (bool) – The value to assign to the is_required property of this StrategyParameter.
default_value (object) – The value to assign to the default_value property of this StrategyParameter.
possible_values (list[object]) – The value to assign to the possible_values property of this StrategyParameter.
- property default_value¶
Gets the default_value of this StrategyParameter. A default value used for the strategy parameter.
- Returns
The default_value of this StrategyParameter.
- Return type
object
- property description¶
[Required] Gets the description of this StrategyParameter. Text describing the strategy parameter.
- Returns
The description of this StrategyParameter.
- Return type
str
- property is_required¶
[Required] Gets the is_required of this StrategyParameter. Whether this parameter is required.
- Returns
The is_required of this StrategyParameter.
- Return type
bool
- property name¶
[Required] Gets the name of this StrategyParameter. The name of the strategy parameter.
- Returns
The name of this StrategyParameter.
- Return type
str
- property possible_values¶
Gets the possible_values of this StrategyParameter. The list of possible values used for these strategy parameters.
- Returns
The possible_values of this StrategyParameter.
- Return type
list[object]
- property type¶
[Required] Gets the type of this StrategyParameter. The type of strategy parameter.
Allowed values for this property are: “STRING”, “BOOLEAN”, “NUMBER”, “DATETIME”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this StrategyParameter.
- Return type
str