ActionParamValuesSummary¶

class oci.database.models.ActionParamValuesSummary(**kwargs)¶

Bases: object

Details of the action parameter and its possible values that is used in listParamsForActionType.

Attributes

`PARAMETER_TYPE_BOOLEAN`	A constant which can be used with the parameter_type property of a ActionParamValuesSummary.
`PARAMETER_TYPE_INTEGER`	A constant which can be used with the parameter_type property of a ActionParamValuesSummary.
`PARAMETER_TYPE_STRING`	A constant which can be used with the parameter_type property of a ActionParamValuesSummary.
`default_value`	Gets the default_value of this ActionParamValuesSummary.
`is_required`	[Required] Gets the is_required of this ActionParamValuesSummary.
`parameter_name`	[Required] Gets the parameter_name of this ActionParamValuesSummary.
`parameter_type`	[Required] Gets the parameter_type of this ActionParamValuesSummary.
`parameter_values`	[Required] Gets the parameter_values of this ActionParamValuesSummary.

Methods

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

PARAMETER_TYPE_BOOLEAN = 'BOOLEAN'¶: A constant which can be used with the parameter_type property of a ActionParamValuesSummary. This constant has a value of “BOOLEAN”

PARAMETER_TYPE_INTEGER = 'INTEGER'¶: A constant which can be used with the parameter_type property of a ActionParamValuesSummary. This constant has a value of “INTEGER”

PARAMETER_TYPE_STRING = 'STRING'¶: A constant which can be used with the parameter_type property of a ActionParamValuesSummary. This constant has a value of “STRING”

__init__(**kwargs)¶

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

Parameters:

parameter_name (str) – The value to assign to the parameter_name property of this ActionParamValuesSummary.
parameter_type (str) – The value to assign to the parameter_type property of this ActionParamValuesSummary. Allowed values for this property are: “BOOLEAN”, “STRING”, “INTEGER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
parameter_values (list[str]) – The value to assign to the parameter_values property of this ActionParamValuesSummary.
default_value (str) – The value to assign to the default_value property of this ActionParamValuesSummary.
is_required (bool) – The value to assign to the is_required property of this ActionParamValuesSummary.

default_value¶

Gets the default_value of this ActionParamValuesSummary. The default value for this parameter.

Returns:	The default_value of this ActionParamValuesSummary.
Return type:	str

is_required¶

[Required] Gets the is_required of this ActionParamValuesSummary. Whether this parameter is required or not for this action type.、

Returns:	The is_required of this ActionParamValuesSummary.
Return type:	bool

parameter_name¶

[Required] Gets the parameter_name of this ActionParamValuesSummary. The name of this parameter.

Returns:	The parameter_name of this ActionParamValuesSummary.
Return type:	str

parameter_type¶

[Required] Gets the parameter_type of this ActionParamValuesSummary. The type of the parameter.

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

Returns:	The parameter_type of this ActionParamValuesSummary.
Return type:	str

parameter_values¶

[Required] Gets the parameter_values of this ActionParamValuesSummary. Possible values for this parameter. In case of integer it’s min and max values.

Returns:	The parameter_values of this ActionParamValuesSummary.
Return type:	list[str]