NamedCredentialFieldDefinition¶
-
class
oci.management_agent.models.
NamedCredentialFieldDefinition
(**kwargs)¶ Bases:
object
A named credential field metadata definition
Attributes
VALUE_CATEGORY_ADB_IDENTIFIER
A constant which can be used with the value_category property of a NamedCredentialFieldDefinition. VALUE_CATEGORY_ALLOWED_VALUE
A constant which can be used with the value_category property of a NamedCredentialFieldDefinition. VALUE_CATEGORY_CLEAR_TEXT
A constant which can be used with the value_category property of a NamedCredentialFieldDefinition. VALUE_CATEGORY_SECRET_IDENTIFIER
A constant which can be used with the value_category property of a NamedCredentialFieldDefinition. allowed_values
Gets the allowed_values of this NamedCredentialFieldDefinition. default_value
Gets the default_value of this NamedCredentialFieldDefinition. display_name
[Required] Gets the display_name of this NamedCredentialFieldDefinition. is_required
Gets the is_required of this NamedCredentialFieldDefinition. name
[Required] Gets the name of this NamedCredentialFieldDefinition. regex
Gets the regex of this NamedCredentialFieldDefinition. value_category
[Required] Gets the value_category of this NamedCredentialFieldDefinition. Methods
__init__
(**kwargs)Initializes a new NamedCredentialFieldDefinition object with values from keyword arguments. -
VALUE_CATEGORY_ADB_IDENTIFIER
= 'ADB_IDENTIFIER'¶ A constant which can be used with the value_category property of a NamedCredentialFieldDefinition. This constant has a value of “ADB_IDENTIFIER”
-
VALUE_CATEGORY_ALLOWED_VALUE
= 'ALLOWED_VALUE'¶ A constant which can be used with the value_category property of a NamedCredentialFieldDefinition. This constant has a value of “ALLOWED_VALUE”
-
VALUE_CATEGORY_CLEAR_TEXT
= 'CLEAR_TEXT'¶ A constant which can be used with the value_category property of a NamedCredentialFieldDefinition. This constant has a value of “CLEAR_TEXT”
-
VALUE_CATEGORY_SECRET_IDENTIFIER
= 'SECRET_IDENTIFIER'¶ A constant which can be used with the value_category property of a NamedCredentialFieldDefinition. This constant has a value of “SECRET_IDENTIFIER”
-
__init__
(**kwargs)¶ Initializes a new NamedCredentialFieldDefinition 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 NamedCredentialFieldDefinition.
- display_name (str) – The value to assign to the display_name property of this NamedCredentialFieldDefinition.
- default_value (str) – The value to assign to the default_value property of this NamedCredentialFieldDefinition.
- regex (str) – The value to assign to the regex property of this NamedCredentialFieldDefinition.
- allowed_values (list[str]) – The value to assign to the allowed_values property of this NamedCredentialFieldDefinition.
- value_category (list[str]) – The value to assign to the value_category property of this NamedCredentialFieldDefinition. Allowed values for items in this list are: “CLEAR_TEXT”, “SECRET_IDENTIFIER”, “ADB_IDENTIFIER”, “ALLOWED_VALUE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- is_required (bool) – The value to assign to the is_required property of this NamedCredentialFieldDefinition.
-
allowed_values
¶ Gets the allowed_values of this NamedCredentialFieldDefinition. List of values which can be applied to the value when valueCategory is ALLOWED_VALUES
Returns: The allowed_values of this NamedCredentialFieldDefinition. Return type: list[str]
-
default_value
¶ Gets the default_value of this NamedCredentialFieldDefinition. The default value which will be used if no value is set. If defaultValue is empty, then no default will be set.
Returns: The default_value of this NamedCredentialFieldDefinition. Return type: str
-
display_name
¶ [Required] Gets the display_name of this NamedCredentialFieldDefinition. The field display name
Returns: The display_name of this NamedCredentialFieldDefinition. Return type: str
-
is_required
¶ Gets the is_required of this NamedCredentialFieldDefinition. Set to true if the field must be defined
Returns: The is_required of this NamedCredentialFieldDefinition. Return type: bool
-
name
¶ [Required] Gets the name of this NamedCredentialFieldDefinition. The field name
Returns: The name of this NamedCredentialFieldDefinition. Return type: str
-
regex
¶ Gets the regex of this NamedCredentialFieldDefinition. Optional regular expression definition which will be applied to the value when valueCategory is CLEAR_TEXT
Returns: The regex of this NamedCredentialFieldDefinition. Return type: str
-
value_category
¶ [Required] Gets the value_category of this NamedCredentialFieldDefinition. List of value categories of field allowed for this property
Allowed values for items in this list are: “CLEAR_TEXT”, “SECRET_IDENTIFIER”, “ADB_IDENTIFIER”, “ALLOWED_VALUE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The value_category of this NamedCredentialFieldDefinition. Return type: list[str]
-