ParameterDefinition¶

class oci.oda.models.ParameterDefinition(**kwargs)¶

Bases: object

A parameter to a resource.

Attributes

`DIRECTION_INPUT`	A constant which can be used with the direction property of a ParameterDefinition.
`DIRECTION_OUTPUT`	A constant which can be used with the direction property of a ParameterDefinition.
`TYPE_BOOLEAN`	A constant which can be used with the type property of a ParameterDefinition.
`TYPE_NUMBER`	A constant which can be used with the type property of a ParameterDefinition.
`TYPE_STRING`	A constant which can be used with the type property of a ParameterDefinition.
`TYPE_URI`	A constant which can be used with the type property of a ParameterDefinition.
`TYPE_URL`	A constant which can be used with the type property of a ParameterDefinition.
`default_value`	Gets the default_value of this ParameterDefinition.
`description`	Gets the description of this ParameterDefinition.
`direction`	Gets the direction of this ParameterDefinition.
`is_required`	Gets the is_required of this ParameterDefinition.
`is_sensitive`	Gets the is_sensitive of this ParameterDefinition.
`max_length`	Gets the max_length of this ParameterDefinition.
`min_length`	Gets the min_length of this ParameterDefinition.
`name`	[Required] Gets the name of this ParameterDefinition.
`pattern`	Gets the pattern of this ParameterDefinition.
`resource_type_metadata`	Gets the resource_type_metadata of this ParameterDefinition.
`type`	[Required] Gets the type of this ParameterDefinition.
`ui_placement_hint`	Gets the ui_placement_hint of this ParameterDefinition.

Methods

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

DIRECTION_INPUT = 'INPUT'¶: A constant which can be used with the direction property of a ParameterDefinition. This constant has a value of “INPUT”

DIRECTION_OUTPUT = 'OUTPUT'¶: A constant which can be used with the direction property of a ParameterDefinition. This constant has a value of “OUTPUT”

TYPE_BOOLEAN = 'BOOLEAN'¶: A constant which can be used with the type property of a ParameterDefinition. This constant has a value of “BOOLEAN”

TYPE_NUMBER = 'NUMBER'¶: A constant which can be used with the type property of a ParameterDefinition. This constant has a value of “NUMBER”

TYPE_STRING = 'STRING'¶: A constant which can be used with the type property of a ParameterDefinition. This constant has a value of “STRING”

TYPE_URI = 'URI'¶: A constant which can be used with the type property of a ParameterDefinition. This constant has a value of “URI”

TYPE_URL = 'URL'¶: A constant which can be used with the type property of a ParameterDefinition. This constant has a value of “URL”

__init__(**kwargs)¶

Initializes a new ParameterDefinition 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 ParameterDefinition.
type (str) – The value to assign to the type property of this ParameterDefinition. Allowed values for this property are: “STRING”, “URI”, “URL”, “NUMBER”, “BOOLEAN”, ‘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 ParameterDefinition.
is_required (bool) – The value to assign to the is_required property of this ParameterDefinition.
is_sensitive (bool) – The value to assign to the is_sensitive property of this ParameterDefinition.
default_value (str) – The value to assign to the default_value property of this ParameterDefinition.
min_length (int) – The value to assign to the min_length property of this ParameterDefinition.
max_length (int) – The value to assign to the max_length property of this ParameterDefinition.
pattern (str) – The value to assign to the pattern property of this ParameterDefinition.
direction (str) – The value to assign to the direction property of this ParameterDefinition. Allowed values for this property are: “INPUT”, “OUTPUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ui_placement_hint (str) – The value to assign to the ui_placement_hint property of this ParameterDefinition.
resource_type_metadata (object) – The value to assign to the resource_type_metadata property of this ParameterDefinition.

default_value¶

Gets the default_value of this ParameterDefinition. Default value for the parameter.

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

description¶

Gets the description of this ParameterDefinition. Description of the parameter.

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

direction¶

Gets the direction of this ParameterDefinition. Is this parameter an input parameter, output parameter, or both?

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

Returns:	The direction of this ParameterDefinition.
Return type:	str

is_required¶

Gets the is_required of this ParameterDefinition. Is this parameter required. Ignored for parameters with direction = OUTPUT.

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

is_sensitive¶

Gets the is_sensitive of this ParameterDefinition. Is the data for this parameter sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.)

Returns:	The is_sensitive of this ParameterDefinition.
Return type:	bool

max_length¶

Gets the max_length of this ParameterDefinition. Used for character string types such as STRING to constrain the length of the value

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

min_length¶

Gets the min_length of this ParameterDefinition. Used for character string types such as STRING to constrain the length of the value

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

name¶

[Required] Gets the name of this ParameterDefinition. The name of the parameter

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

pattern¶

Gets the pattern of this ParameterDefinition. Regular expression used to validate the value of a string type such as STRING

Returns:	The pattern of this ParameterDefinition.
Return type:	str

resource_type_metadata¶

Gets the resource_type_metadata of this ParameterDefinition. Any configuration needed to help the resource type process this parameter (e.g. link to manifest, etc.).

Returns:	The resource_type_metadata of this ParameterDefinition.
Return type:	object

type¶

[Required] Gets the type of this ParameterDefinition. Enumerated parameter type.

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

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

ui_placement_hint¶

Gets the ui_placement_hint of this ParameterDefinition. A forward-slash-delimited ‘path’ in an imaginary hierarchy, at which this parameter’s UI widgets should be placed

Returns:	The ui_placement_hint of this ParameterDefinition.
Return type:	str