ConfigDetails¶
- class oci.functions.models.ConfigDetails(**kwargs)¶
Bases:
objectDetails about the required and optional Function configurations needed for proper performance of the PBF.
Methods:
__init__(**kwargs)Initializes a new ConfigDetails object with values from keyword arguments.
Attributes:
[Required] Gets the description of this ConfigDetails.
Gets the is_optional of this ConfigDetails.
[Required] Gets the key of this ConfigDetails.
- __init__(**kwargs)¶
Initializes a new ConfigDetails 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 ConfigDetails.
description (str) – The value to assign to the description property of this ConfigDetails.
is_optional (bool) – The value to assign to the is_optional property of this ConfigDetails.
- property description¶
[Required] Gets the description of this ConfigDetails. Details about why this config is required and what it will be used for.
- Returns
The description of this ConfigDetails.
- Return type
str
- property is_optional¶
Gets the is_optional of this ConfigDetails. Is this a required config or an optional one. Requests with required config params missing will be rejected.
- Returns
The is_optional of this ConfigDetails.
- Return type
bool
- property key¶
[Required] Gets the key of this ConfigDetails. The key name of the config param.
- Returns
The key of this ConfigDetails.
- Return type
str