UDisks.VolumeGroup

g GObject.GInterface GObject.GInterface UDisks.VolumeGroup UDisks.VolumeGroup GObject.GInterface->UDisks.VolumeGroup

Implementations:
 UDisks.VolumeGroupProxy, UDisks.VolumeGroupSkeleton

Methods

class interface_info ()
class override_properties (klass, property_id_begin)
  call_add_device (arg_block, arg_options, cancellable, callback, *user_data)
  call_add_device_finish (res)
  call_add_device_sync (arg_block, arg_options, cancellable)
  call_create_plain_volume (arg_name, arg_size, arg_options, cancellable, callback, *user_data)
  call_create_plain_volume_finish (res)
  call_create_plain_volume_sync (arg_name, arg_size, arg_options, cancellable)
  call_create_thin_pool_volume (arg_name, arg_size, arg_options, cancellable, callback, *user_data)
  call_create_thin_pool_volume_finish (res)
  call_create_thin_pool_volume_sync (arg_name, arg_size, arg_options, cancellable)
  call_create_thin_volume (arg_name, arg_size, arg_pool, arg_options, cancellable, callback, *user_data)
  call_create_thin_volume_finish (res)
  call_create_thin_volume_sync (arg_name, arg_size, arg_pool, arg_options, cancellable)
  call_create_vdo_volume (arg_lv_name, arg_pool_name, arg_data_size, arg_virtual_size, arg_index_memory, arg_compression, arg_deduplication, arg_write_policy, arg_options, cancellable, callback, *user_data)
  call_create_vdo_volume_finish (res)
  call_create_vdo_volume_sync (arg_lv_name, arg_pool_name, arg_data_size, arg_virtual_size, arg_index_memory, arg_compression, arg_deduplication, arg_write_policy, arg_options, cancellable)
  call_delete (arg_wipe, arg_options, cancellable, callback, *user_data)
  call_delete_finish (res)
  call_delete_sync (arg_wipe, arg_options, cancellable)
  call_empty_device (arg_block, arg_options, cancellable, callback, *user_data)
  call_empty_device_finish (res)
  call_empty_device_sync (arg_block, arg_options, cancellable)
  call_poll (cancellable, callback, *user_data)
  call_poll_finish (res)
  call_poll_sync (cancellable)
  call_remove_device (arg_block, arg_wipe, arg_options, cancellable, callback, *user_data)
  call_remove_device_finish (res)
  call_remove_device_sync (arg_block, arg_wipe, arg_options, cancellable)
  call_rename (arg_new_name, arg_options, cancellable, callback, *user_data)
  call_rename_finish (res)
  call_rename_sync (arg_new_name, arg_options, cancellable)
  complete_add_device (invocation)
  complete_create_plain_volume (invocation, result)
  complete_create_thin_pool_volume (invocation, result)
  complete_create_thin_volume (invocation, result)
  complete_create_vdo_volume (invocation, result)
  complete_delete (invocation)
  complete_empty_device (invocation)
  complete_poll (invocation)
  complete_remove_device (invocation)
  complete_rename (invocation, result)

Virtual Methods

  do_handle_add_device (invocation, arg_block, arg_options)
  do_handle_create_plain_volume (invocation, arg_name, arg_size, arg_options)
  do_handle_create_thin_pool_volume (invocation, arg_name, arg_size, arg_options)
  do_handle_create_thin_volume (invocation, arg_name, arg_size, arg_pool, arg_options)
  do_handle_create_vdo_volume (invocation, arg_lv_name, arg_pool_name, arg_data_size, arg_virtual_size, arg_index_memory, arg_compression, arg_deduplication, arg_write_policy, arg_options)
  do_handle_delete (invocation, arg_wipe, arg_options)
  do_handle_empty_device (invocation, arg_block, arg_options)
  do_handle_poll (invocation)
  do_handle_remove_device (invocation, arg_block, arg_wipe, arg_options)
  do_handle_rename (invocation, arg_new_name, arg_options)

Properties

Name Type Flags Short Description
extent-size int r/w ExtentSize
free-size int r/w FreeSize
name str r/w Name
needs-polling bool r/w NeedsPolling
size int r/w Size
uuid str r/w UUID

Signals

Name Short Description
handle-add-device Signal emitted when a remote caller is invoking the AddDevice() D-Bus method.
handle-create-plain-volume Signal emitted when a remote caller is invoking the CreatePlainVolume() D-Bus method.
handle-create-thin-pool-volume Signal emitted when a remote caller is invoking the CreateThinPoolVolume() D-Bus method.
handle-create-thin-volume Signal emitted when a remote caller is invoking the CreateThinVolume() D-Bus method.
handle-create-vdo-volume Signal emitted when a remote caller is invoking the ‘CreateVDOVolume() [gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateVDOVolume]’ D-Bus method.
handle-delete Signal emitted when a remote caller is invoking the Delete() D-Bus method.
handle-empty-device Signal emitted when a remote caller is invoking the EmptyDevice() D-Bus method.
handle-poll Signal emitted when a remote caller is invoking the Poll() D-Bus method.
handle-remove-device Signal emitted when a remote caller is invoking the RemoveDevice() D-Bus method.
handle-rename Signal emitted when a remote caller is invoking the Rename() D-Bus method.

Fields

None

Class Details

class UDisks.VolumeGroup
Bases:GObject.GInterface
Structure:UDisks.VolumeGroupIface

Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.VolumeGroup.

New in version 2.0.0.

classmethod interface_info()[source]
Returns:A Gio.DBusInterfaceInfo. Do not free.
Return type:Gio.DBusInterfaceInfo

Gets a machine-readable description of the org.freedesktop.UDisks2.VolumeGroup D-Bus interface.

New in version 2.0.0.

classmethod override_properties(klass, property_id_begin)[source]
Parameters:
Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the UDisks.VolumeGroup interface for a concrete class. The properties are overridden in the order they are defined.

New in version 2.0.0.

call_add_device(arg_block, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the AddDevice() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_add_device_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_add_device_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_add_device_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_add_device().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.VolumeGroup.call_add_device().

New in version 2.0.0.

call_add_device_sync(arg_block, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the AddDevice() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_add_device() for the asynchronous version of this method.

New in version 2.0.0.

call_create_plain_volume(arg_name, arg_size, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the CreatePlainVolume() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_create_plain_volume_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_create_plain_volume_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_create_plain_volume_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_create_plain_volume().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
out_result:Return location for return parameter or None to ignore.
Return type:(bool, out_result: str)

Finishes an operation started with UDisks.VolumeGroup.call_create_plain_volume().

New in version 2.0.0.

call_create_plain_volume_sync(arg_name, arg_size, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_result:Return location for return parameter or None to ignore.

Return type:

(bool, out_result: str)

Synchronously invokes the CreatePlainVolume() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_create_plain_volume() for the asynchronous version of this method.

New in version 2.0.0.

call_create_thin_pool_volume(arg_name, arg_size, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the CreateThinPoolVolume() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_create_thin_pool_volume_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_create_thin_pool_volume_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_create_thin_pool_volume_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_create_thin_pool_volume().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
out_result:Return location for return parameter or None to ignore.
Return type:(bool, out_result: str)

Finishes an operation started with UDisks.VolumeGroup.call_create_thin_pool_volume().

New in version 2.0.0.

call_create_thin_pool_volume_sync(arg_name, arg_size, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_result:Return location for return parameter or None to ignore.

Return type:

(bool, out_result: str)

Synchronously invokes the CreateThinPoolVolume() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_create_thin_pool_volume() for the asynchronous version of this method.

New in version 2.0.0.

call_create_thin_volume(arg_name, arg_size, arg_pool, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the CreateThinVolume() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_create_thin_volume_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_create_thin_volume_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_create_thin_volume_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_create_thin_volume().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
out_result:Return location for return parameter or None to ignore.
Return type:(bool, out_result: str)

Finishes an operation started with UDisks.VolumeGroup.call_create_thin_volume().

New in version 2.0.0.

call_create_thin_volume_sync(arg_name, arg_size, arg_pool, arg_options, cancellable)[source]
Parameters:
  • arg_name (str) – Argument to pass with the method invocation.
  • arg_size (int) – Argument to pass with the method invocation.
  • arg_pool (str) – Argument to pass with the method invocation.
  • arg_options (GLib.Variant) – Argument to pass with the method invocation.
  • cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_result:Return location for return parameter or None to ignore.

Return type:

(bool, out_result: str)

Synchronously invokes the CreateThinVolume() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_create_thin_volume() for the asynchronous version of this method.

New in version 2.0.0.

call_create_vdo_volume(arg_lv_name, arg_pool_name, arg_data_size, arg_virtual_size, arg_index_memory, arg_compression, arg_deduplication, arg_write_policy, arg_options, cancellable, callback, *user_data)[source]
Parameters:
  • arg_lv_name (str) – Argument to pass with the method invocation.
  • arg_pool_name (str) – Argument to pass with the method invocation.
  • arg_data_size (int) – Argument to pass with the method invocation.
  • arg_virtual_size (int) – Argument to pass with the method invocation.
  • arg_index_memory (int) – Argument to pass with the method invocation.
  • arg_compression (bool) – Argument to pass with the method invocation.
  • arg_deduplication (bool) – Argument to pass with the method invocation.
  • arg_write_policy (str) – Argument to pass with the method invocation.
  • arg_options (GLib.Variant) – Argument to pass with the method invocation.
  • cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
  • callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
  • user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘CreateVDOVolume() [gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateVDOVolume]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_create_vdo_volume_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_create_vdo_volume_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_create_vdo_volume_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_create_vdo_volume().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
out_result:Return location for return parameter or None to ignore.
Return type:(bool, out_result: str)

Finishes an operation started with UDisks.VolumeGroup.call_create_vdo_volume().

New in version 2.0.0.

call_create_vdo_volume_sync(arg_lv_name, arg_pool_name, arg_data_size, arg_virtual_size, arg_index_memory, arg_compression, arg_deduplication, arg_write_policy, arg_options, cancellable)[source]
Parameters:
  • arg_lv_name (str) – Argument to pass with the method invocation.
  • arg_pool_name (str) – Argument to pass with the method invocation.
  • arg_data_size (int) – Argument to pass with the method invocation.
  • arg_virtual_size (int) – Argument to pass with the method invocation.
  • arg_index_memory (int) – Argument to pass with the method invocation.
  • arg_compression (bool) – Argument to pass with the method invocation.
  • arg_deduplication (bool) – Argument to pass with the method invocation.
  • arg_write_policy (str) – Argument to pass with the method invocation.
  • arg_options (GLib.Variant) – Argument to pass with the method invocation.
  • cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_result:Return location for return parameter or None to ignore.

Return type:

(bool, out_result: str)

Synchronously invokes the ‘CreateVDOVolume() [gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateVDOVolume]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_create_vdo_volume() for the asynchronous version of this method.

New in version 2.0.0.

call_delete(arg_wipe, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Delete() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_delete_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_delete_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_delete_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_delete().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.VolumeGroup.call_delete().

New in version 2.0.0.

call_delete_sync(arg_wipe, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the Delete() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_delete() for the asynchronous version of this method.

New in version 2.0.0.

call_empty_device(arg_block, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the EmptyDevice() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_empty_device_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_empty_device_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_empty_device_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_empty_device().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.VolumeGroup.call_empty_device().

New in version 2.0.0.

call_empty_device_sync(arg_block, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the EmptyDevice() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_empty_device() for the asynchronous version of this method.

New in version 2.0.0.

call_poll(cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Poll() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_poll_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_poll_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_poll_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_poll().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.VolumeGroup.call_poll().

New in version 2.0.0.

call_poll_sync(cancellable)[source]
Parameters:cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Synchronously invokes the Poll() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_poll() for the asynchronous version of this method.

New in version 2.0.0.

call_remove_device(arg_block, arg_wipe, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the RemoveDevice() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_remove_device_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_remove_device_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_remove_device_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_remove_device().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.VolumeGroup.call_remove_device().

New in version 2.0.0.

call_remove_device_sync(arg_block, arg_wipe, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the RemoveDevice() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_remove_device() for the asynchronous version of this method.

New in version 2.0.0.

call_rename(arg_new_name, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Rename() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.VolumeGroup.call_rename_finish() to get the result of the operation.

See UDisks.VolumeGroup.call_rename_sync() for the synchronous, blocking version of this method.

New in version 2.0.0.

call_rename_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.VolumeGroup.call_rename().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
out_result:Return location for return parameter or None to ignore.
Return type:(bool, out_result: str)

Finishes an operation started with UDisks.VolumeGroup.call_rename().

New in version 2.0.0.

call_rename_sync(arg_new_name, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_result:Return location for return parameter or None to ignore.

Return type:

(bool, out_result: str)

Synchronously invokes the Rename() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VolumeGroup.call_rename() for the asynchronous version of this method.

New in version 2.0.0.

complete_add_device(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the AddDevice() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_create_plain_volume(invocation, result)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the CreatePlainVolume() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_create_thin_pool_volume(invocation, result)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the CreateThinPoolVolume() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_create_thin_volume(invocation, result)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the CreateThinVolume() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_create_vdo_volume(invocation, result)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the ‘CreateVDOVolume() [gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateVDOVolume]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_delete(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the Delete() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_empty_device(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the EmptyDevice() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_poll(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the Poll() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_remove_device(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the RemoveDevice() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

complete_rename(invocation, result)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the Rename() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.0.0.

do_handle_add_device(invocation, arg_block, arg_options) virtual
Parameters:
Return type:

bool

do_handle_create_plain_volume(invocation, arg_name, arg_size, arg_options) virtual
Parameters:
Return type:

bool

do_handle_create_thin_pool_volume(invocation, arg_name, arg_size, arg_options) virtual
Parameters:
Return type:

bool

do_handle_create_thin_volume(invocation, arg_name, arg_size, arg_pool, arg_options) virtual
Parameters:
Return type:

bool

do_handle_create_vdo_volume(invocation, arg_lv_name, arg_pool_name, arg_data_size, arg_virtual_size, arg_index_memory, arg_compression, arg_deduplication, arg_write_policy, arg_options) virtual
Parameters:
Return type:

bool

do_handle_delete(invocation, arg_wipe, arg_options) virtual
Parameters:
Return type:

bool

do_handle_empty_device(invocation, arg_block, arg_options) virtual
Parameters:
Return type:

bool

do_handle_poll(invocation) virtual
Parameters:invocation (Gio.DBusMethodInvocation) –
Return type:bool
do_handle_remove_device(invocation, arg_block, arg_wipe, arg_options) virtual
Parameters:
Return type:

bool

do_handle_rename(invocation, arg_new_name, arg_options) virtual
Parameters:
Return type:

bool

Signal Details

UDisks.VolumeGroup.signals.handle_add_device(volume_group, invocation, arg_block, arg_options)
Signal Name:

handle-add-device

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the AddDevice() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_add_device() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_create_plain_volume(volume_group, invocation, arg_name, arg_size, arg_options)
Signal Name:

handle-create-plain-volume

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the CreatePlainVolume() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_create_plain_volume() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_create_thin_pool_volume(volume_group, invocation, arg_name, arg_size, arg_options)
Signal Name:

handle-create-thin-pool-volume

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the CreateThinPoolVolume() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_create_thin_pool_volume() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_create_thin_volume(volume_group, invocation, arg_name, arg_size, arg_pool, arg_options)
Signal Name:

handle-create-thin-volume

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the CreateThinVolume() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_create_thin_volume() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_create_vdo_volume(volume_group, invocation, arg_lv_name, arg_pool_name, arg_data_size, arg_virtual_size, arg_index_memory, arg_compression, arg_deduplication, arg_write_policy, arg_options)
Signal Name:

handle-create-vdo-volume

Flags:

RUN_LAST

Parameters:
  • volume_group (UDisks.VolumeGroup) – The object which received the signal
  • invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
  • arg_lv_name (str) – Argument passed by remote caller.
  • arg_pool_name (str) – Argument passed by remote caller.
  • arg_data_size (int) – Argument passed by remote caller.
  • arg_virtual_size (int) – Argument passed by remote caller.
  • arg_index_memory (int) – Argument passed by remote caller.
  • arg_compression (bool) – Argument passed by remote caller.
  • arg_deduplication (bool) – Argument passed by remote caller.
  • arg_write_policy (str) – Argument passed by remote caller.
  • arg_options (GLib.Variant) – Argument passed by remote caller.
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘CreateVDOVolume() [gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateVDOVolume]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_create_vdo_volume() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_delete(volume_group, invocation, arg_wipe, arg_options)
Signal Name:

handle-delete

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Delete() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_delete() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_empty_device(volume_group, invocation, arg_block, arg_options)
Signal Name:

handle-empty-device

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the EmptyDevice() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_empty_device() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_poll(volume_group, invocation)
Signal Name:

handle-poll

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Poll() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_poll() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_remove_device(volume_group, invocation, arg_block, arg_wipe, arg_options)
Signal Name:

handle-remove-device

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the RemoveDevice() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_remove_device() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

UDisks.VolumeGroup.signals.handle_rename(volume_group, invocation, arg_new_name, arg_options)
Signal Name:

handle-rename

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Rename() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.VolumeGroup.complete_rename() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.0.0.

Property Details

UDisks.VolumeGroup.props.extent_size
Name:extent-size
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “ExtentSize”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

New in version 2.0.0.

UDisks.VolumeGroup.props.free_size
Name:free-size
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “FreeSize”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

New in version 2.0.0.

UDisks.VolumeGroup.props.name
Name:name
Type:str
Default Value:None
Flags:READABLE, WRITABLE

Represents the D-Bus property “Name”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

New in version 2.0.0.

UDisks.VolumeGroup.props.needs_polling
Name:needs-polling
Type:bool
Default Value:False
Flags:READABLE, WRITABLE

Represents the D-Bus property “NeedsPolling”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

New in version 2.0.0.

UDisks.VolumeGroup.props.size
Name:size
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “Size”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

New in version 2.0.0.

UDisks.VolumeGroup.props.uuid
Name:uuid
Type:str
Default Value:None
Flags:READABLE, WRITABLE

Represents the D-Bus property “UUID”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

New in version 2.0.0.