GI.NM.Objects.SettingOvsExternalIDs

OVS External IDs Settings

Exported types

newtype SettingOvsExternalIDs

Memory-managed wrapper type.

Constructors

SettingOvsExternalIDs (ManagedPtr SettingOvsExternalIDs)

Instances

Eq SettingOvsExternalIDs

Defined in GI.NM.Objects.SettingOvsExternalIDs

Methods

(==) :: SettingOvsExternalIDs -> SettingOvsExternalIDs -> Bool

(/=) :: SettingOvsExternalIDs -> SettingOvsExternalIDs -> Bool

GObject SettingOvsExternalIDs

Defined in GI.NM.Objects.SettingOvsExternalIDs

ManagedPtrNewtype SettingOvsExternalIDs

Defined in GI.NM.Objects.SettingOvsExternalIDs

Methods

toManagedPtr :: SettingOvsExternalIDs -> ManagedPtr SettingOvsExternalIDs

TypedObject SettingOvsExternalIDs

Defined in GI.NM.Objects.SettingOvsExternalIDs

Methods

glibType :: IO GType

HasParentTypes SettingOvsExternalIDs

Defined in GI.NM.Objects.SettingOvsExternalIDs

IsGValue (Maybe SettingOvsExternalIDs)

Convert SettingOvsExternalIDs to and from GValue. See toGValue and fromGValue.

Defined in GI.NM.Objects.SettingOvsExternalIDs

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SettingOvsExternalIDs -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SettingOvsExternalIDs)

type ParentTypes SettingOvsExternalIDs

Defined in GI.NM.Objects.SettingOvsExternalIDs

type ParentTypes SettingOvsExternalIDs = '[Setting, Object]

class (GObject o, IsDescendantOf SettingOvsExternalIDs o) => IsSettingOvsExternalIDs o

Type class for types which can be safely cast to SettingOvsExternalIDs, for instance with toSettingOvsExternalIDs.

Instances

(GObject o, IsDescendantOf SettingOvsExternalIDs o) => IsSettingOvsExternalIDs o

Defined in GI.NM.Objects.SettingOvsExternalIDs

toSettingOvsExternalIDs :: (MonadIO m, IsSettingOvsExternalIDs o) => o -> m SettingOvsExternalIDs

Cast to SettingOvsExternalIDs, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, compare, diff, duplicate, enumerateValues, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, optionClearByName, optionGet, optionGetAllNames, optionGetBoolean, optionGetUint32, optionSet, optionSetBoolean, optionSetUint32, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toString, unref, verify, verifySecrets, watchClosure.

Getters

getData, getDataKeys, getDbusPropertyType, getName, getProperty, getQdata, getSecretFlags.

Setters

setData, setDataFull, setProperty, setSecretFlags.

checkKey

settingOvsExternalIDsCheckKey

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

key: the key to check

-> m ()

(Can throw GError)

Checks whether key is a valid key for OVS' external-ids. This means, the key cannot be Nothing, not too large and valid ASCII. Also, only digits and numbers are allowed with a few special characters. They key must also not start with "NM.".

Since: 1.30

checkVal

settingOvsExternalIDsCheckVal

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

val: the value to check

-> m ()

(Can throw GError)

Checks whether val is a valid user data value. This means, value is not Nothing, not too large and valid UTF-8.

Since: 1.30

getData

settingOvsExternalIDsGetData

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsExternalIDs a)

=> a

setting: the SettingOvsExternalIDs instance

-> Text

key: the external-id to lookup

-> m Text

Returns: the value associated with key or Nothing if no such value exists.

No description available in the introspection data.

Since: 1.30

getDataKeys

settingOvsExternalIDsGetDataKeys

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsExternalIDs a)

=> a

setting: the SettingOvsExternalIDs

-> m [Text]

Returns: a Nothing-terminated array containing each key from the table.

No description available in the introspection data.

Since: 1.30

new

settingOvsExternalIDsNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingOvsExternalIDs

Returns: the new empty SettingOvsExternalIDs object

Creates a new SettingOvsExternalIDs object with default values.

Since: 1.30

setData

settingOvsExternalIDsSetData

Arguments

:: (HasCallStack, MonadIO m, IsSettingOvsExternalIDs a)

=> a

setting: the SettingOvsExternalIDs instance

-> Text

key: the key to set

-> Maybe Text

val: the value to set or Nothing to clear a key.

-> m ()

No description available in the introspection data.

Since: 1.30

Properties

data

A dictionary of key/value pairs with external-ids for OVS.

Since: 1.30

clearSettingOvsExternalIDsData :: (MonadIO m, IsSettingOvsExternalIDs o) => o -> m ()

Set the value of the “data” property to Nothing. When overloading is enabled, this is equivalent to

clear #data

constructSettingOvsExternalIDsData :: (IsSettingOvsExternalIDs o, MonadIO m) => Map Text Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “data” property. This is rarely needed directly, but it is used by new.

getSettingOvsExternalIDsData :: (MonadIO m, IsSettingOvsExternalIDs o) => o -> m (Maybe (Map Text Text))

Get the value of the “data” property. When overloading is enabled, this is equivalent to

get settingOvsExternalIDs #data

setSettingOvsExternalIDsData :: (MonadIO m, IsSettingOvsExternalIDs o) => o -> Map Text Text -> m ()

Set the value of the “data” property. When overloading is enabled, this is equivalent to

set settingOvsExternalIDs [ #data := value ]