ConfigurationPropertySchema¶

class oci.data_science.models.ConfigurationPropertySchema(**kwargs)¶

Bases: object

Schema for single configuration property

Attributes

`VALUE_TYPE_SECRET`	A constant which can be used with the value_type property of a ConfigurationPropertySchema.
`VALUE_TYPE_STRING`	A constant which can be used with the value_type property of a ConfigurationPropertySchema.
`VALUE_TYPE_VAULT_SECRET_ID`	A constant which can be used with the value_type property of a ConfigurationPropertySchema.
`default_value`	Gets the default_value of this ConfigurationPropertySchema.
`description`	[Required] Gets the description of this ConfigurationPropertySchema.
`is_mandatory`	Gets the is_mandatory of this ConfigurationPropertySchema.
`key_name`	[Required] Gets the key_name of this ConfigurationPropertySchema.
`sample_value`	[Required] Gets the sample_value of this ConfigurationPropertySchema.
`validation_regexp`	Gets the validation_regexp of this ConfigurationPropertySchema.
`value_type`	[Required] Gets the value_type of this ConfigurationPropertySchema.

Methods

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

VALUE_TYPE_SECRET = 'SECRET'¶: A constant which can be used with the value_type property of a ConfigurationPropertySchema. This constant has a value of “SECRET”

VALUE_TYPE_STRING = 'STRING'¶: A constant which can be used with the value_type property of a ConfigurationPropertySchema. This constant has a value of “STRING”

VALUE_TYPE_VAULT_SECRET_ID = 'VAULT_SECRET_ID'¶: A constant which can be used with the value_type property of a ConfigurationPropertySchema. This constant has a value of “VAULT_SECRET_ID”

__init__(**kwargs)¶

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

Parameters:

key_name (str) – The value to assign to the key_name property of this ConfigurationPropertySchema.
value_type (str) – The value to assign to the value_type property of this ConfigurationPropertySchema. Allowed values for this property are: “STRING”, “SECRET”, “VAULT_SECRET_ID”, ‘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 ConfigurationPropertySchema.
is_mandatory (bool) – The value to assign to the is_mandatory property of this ConfigurationPropertySchema.
default_value (str) – The value to assign to the default_value property of this ConfigurationPropertySchema.
validation_regexp (str) – The value to assign to the validation_regexp property of this ConfigurationPropertySchema.
sample_value (str) – The value to assign to the sample_value property of this ConfigurationPropertySchema.

default_value¶

Gets the default_value of this ConfigurationPropertySchema. The default value for the optional configuration property (it must not be specified for mandatory configuration properties)

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

description¶

[Required] Gets the description of this ConfigurationPropertySchema. Description of this configuration property

Returns:	The description of this ConfigurationPropertySchema.
Return type:	str

is_mandatory¶

Gets the is_mandatory of this ConfigurationPropertySchema. If the value is true this configuration property is mandatory and visa versa. If not specified configuration property is optional.

Returns:	The is_mandatory of this ConfigurationPropertySchema.
Return type:	bool

key_name¶

[Required] Gets the key_name of this ConfigurationPropertySchema. Name of key (parameter name)

Returns:	The key_name of this ConfigurationPropertySchema.
Return type:	str

sample_value¶

[Required] Gets the sample_value of this ConfigurationPropertySchema. Sample property value (it must match validationRegexp if it is specified)

Returns:	The sample_value of this ConfigurationPropertySchema.
Return type:	str

validation_regexp¶

Gets the validation_regexp of this ConfigurationPropertySchema. A regular expression will be used for the validation of property value.

Returns:	The validation_regexp of this ConfigurationPropertySchema.
Return type:	str

value_type¶

[Required] Gets the value_type of this ConfigurationPropertySchema. Type of value

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

Returns:	The value_type of this ConfigurationPropertySchema.
Return type:	str