Libosinfo.InstallConfigParam¶

Subclasses:: None

Methods¶

Inherited:: Libosinfo.Entity (15), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (name)
	`get_name` ()
	`get_policy` ()
	`get_value_map` ()
	`is_optional` ()
	`is_required` ()
	`set_value_map` (datamap)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: Libosinfo.Entity (1)

Name	Type	Flags	Short Description
`name`	`str`	r/w/co	Parameter name
`policy`	`Libosinfo.InstallConfigParamPolicy`	r	Parameter policy
`value-map`	`Libosinfo.Datamap`	r/w	Parameter Value Mapping

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Libosinfo.Entity`	r

Class Details¶

class Libosinfo.InstallConfigParam(**kwargs)¶

Bases:: Libosinfo.Entity
Abstract:: No
Structure:: Libosinfo.InstallConfigParamClass

classmethod new(name)¶

Parameters:: name (str) – the configuration parameter name
Returns:: the new configuration parameter
Return type:: Libosinfo.InstallConfigParam

Construct a new configuration parameter for an Libosinfo.InstallScript.

New in version 0.2.0.

get_name()¶

Returns:: the name of the configuration parameter
Return type:: str

New in version 0.2.0.

get_policy()¶

Returns:: the policy of the configuration parameter
Return type:: Libosinfo.InstallConfigParamPolicy

New in version 0.2.0.

get_value_map()¶

Returns:: The data map used to transform values set for this parameter to OS-specific values, or None.
Return type:: Libosinfo.Datamap

New in version 0.2.8.

is_optional()¶

Returns:: True if the config_param is optional. False otherwise.
Return type:: bool

New in version 0.2.1.

is_required()¶

Returns:: True if the config_param is required. False otherwise.
Return type:: bool

New in version 0.2.1.

set_value_map(datamap)¶

Parameters:: datamap (Libosinfo.Datamap) – a Libosinfo.Datamap to transform values this parameter is set to, or None to disable transformations for this parameter

After a call to Libosinfo.InstallConfigParam.set_value_map(), datamap will be used to transform values set for this parameter to OS-specific values. A None datamap will disable transformations.

New in version 0.2.8.

Property Details¶

Libosinfo.InstallConfigParam.props.name¶

Name:: name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The name of the configuration parameter.

Libosinfo.InstallConfigParam.props.policy¶

Name:: policy
Type:: Libosinfo.InstallConfigParamPolicy
Default Value:: Libosinfo.InstallConfigParamPolicy.OPTIONAL
Flags:: READABLE

The policy of the configuration parameter.

Libosinfo.InstallConfigParam.props.value_map¶

Name:: value-map
Type:: Libosinfo.Datamap
Default Value:: None
Flags:: READABLE, WRITABLE

The mapping between generic values and OS-specific values for this configuration parameter