UserDefinedProperty¶

class oci.database_migration.models.UserDefinedProperty(**kwargs)¶

Bases: object

User Defined Property

Attributes

`TYPE_PASSWORD`	A constant which can be used with the type property of a UserDefinedProperty.
`TYPE_RADIO`	A constant which can be used with the type property of a UserDefinedProperty.
`TYPE_TEXT`	A constant which can be used with the type property of a UserDefinedProperty.
`default_value`	Gets the default_value of this UserDefinedProperty.
`description`	Gets the description of this UserDefinedProperty.
`display_name`	[Required] Gets the display_name of this UserDefinedProperty.
`is_required`	Gets the is_required of this UserDefinedProperty.
`max_length`	Gets the max_length of this UserDefinedProperty.
`min_length`	Gets the min_length of this UserDefinedProperty.
`name`	[Required] Gets the name of this UserDefinedProperty.
`options`	Gets the options of this UserDefinedProperty.
`type`	[Required] Gets the type of this UserDefinedProperty.
`value`	Gets the value of this UserDefinedProperty.

Methods

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

TYPE_PASSWORD = 'PASSWORD'¶: A constant which can be used with the type property of a UserDefinedProperty. This constant has a value of “PASSWORD”

TYPE_RADIO = 'RADIO'¶: A constant which can be used with the type property of a UserDefinedProperty. This constant has a value of “RADIO”

TYPE_TEXT = 'TEXT'¶: A constant which can be used with the type property of a UserDefinedProperty. This constant has a value of “TEXT”

__init__(**kwargs)¶

Initializes a new UserDefinedProperty 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 UserDefinedProperty.
display_name (str) – The value to assign to the display_name property of this UserDefinedProperty.
description (str) – The value to assign to the description property of this UserDefinedProperty.
type (str) – The value to assign to the type property of this UserDefinedProperty. Allowed values for this property are: “TEXT”, “PASSWORD”, “RADIO”, ‘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 UserDefinedProperty.
min_length (int) – The value to assign to the min_length property of this UserDefinedProperty.
max_length (int) – The value to assign to the max_length property of this UserDefinedProperty.
default_value (str) – The value to assign to the default_value property of this UserDefinedProperty.
value (str) – The value to assign to the value property of this UserDefinedProperty.
options (list[oci.database_migration.models.UserDefinedPropertyOption]) – The value to assign to the options property of this UserDefinedProperty.

default_value¶

Gets the default_value of this UserDefinedProperty. The default value of the property.

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

description¶

Gets the description of this UserDefinedProperty. A user-friendly description. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

display_name¶

[Required] Gets the display_name of this UserDefinedProperty. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this UserDefinedProperty.
Return type:	str

is_required¶

Gets the is_required of this UserDefinedProperty. True if the property is required, false otherwise

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

max_length¶

Gets the max_length of this UserDefinedProperty. Maximum length of the text

Returns:	The max_length of this UserDefinedProperty.
Return type:	int

min_length¶

Gets the min_length of this UserDefinedProperty. Minimum length of the text

Returns:	The min_length of this UserDefinedProperty.
Return type:	int

name¶

[Required] Gets the name of this UserDefinedProperty. The property name.

Returns:	The name of this UserDefinedProperty.
Return type:	str

options¶

Gets the options of this UserDefinedProperty. User defined property options.

Returns:	The options of this UserDefinedProperty.
Return type:	list[oci.database_migration.models.UserDefinedPropertyOption]

type¶

[Required] Gets the type of this UserDefinedProperty. The type of the user defined property.

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

Returns:	The type of this UserDefinedProperty.
Return type:	str

value¶

Gets the value of this UserDefinedProperty. The value of the property.

Returns:	The value of this UserDefinedProperty.
Return type:	str