UDisks.VDOVolume

g GObject.GInterface GObject.GInterface UDisks.VDOVolume UDisks.VDOVolume GObject.GInterface->UDisks.VDOVolume

Implementations:
 UDisks.VDOVolumeProxy, UDisks.VDOVolumeSkeleton

Methods

class interface_info ()
class override_properties (klass, property_id_begin)
  call_enable_compression (arg_enable, arg_options, cancellable, callback, *user_data)
  call_enable_compression_finish (res)
  call_enable_compression_sync (arg_enable, arg_options, cancellable)
  call_enable_deduplication (arg_enable, arg_options, cancellable, callback, *user_data)
  call_enable_deduplication_finish (res)
  call_enable_deduplication_sync (arg_enable, arg_options, cancellable)
  call_get_statistics (arg_options, cancellable, callback, *user_data)
  call_get_statistics_finish (res)
  call_get_statistics_sync (arg_options, cancellable)
  call_resize_logical (arg_size, arg_options, cancellable, callback, *user_data)
  call_resize_logical_finish (res)
  call_resize_logical_sync (arg_size, arg_options, cancellable)
  call_resize_physical (arg_size, arg_options, cancellable, callback, *user_data)
  call_resize_physical_finish (res)
  call_resize_physical_sync (arg_size, arg_options, cancellable)
  complete_enable_compression (invocation)
  complete_enable_deduplication (invocation)
  complete_get_statistics (invocation, stats)
  complete_resize_logical (invocation)
  complete_resize_physical (invocation)

Virtual Methods

  do_handle_enable_compression (invocation, arg_enable, arg_options)
  do_handle_enable_deduplication (invocation, arg_enable, arg_options)
  do_handle_get_statistics (invocation, arg_options)
  do_handle_resize_logical (invocation, arg_size, arg_options)
  do_handle_resize_physical (invocation, arg_size, arg_options)

Properties

Name Type Flags Short Description
compression bool r/w Compression
compression-state str r/w CompressionState
deduplication bool r/w Deduplication
index-state str r/w IndexState
operating-mode str r/w OperatingMode
used-size int r/w UsedSize
vdo-pool str r/w VDOPool

Signals

Name Short Description
handle-enable-compression Signal emitted when a remote caller is invoking the ‘EnableCompression() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableCompression]’ D-Bus method.
handle-enable-deduplication Signal emitted when a remote caller is invoking the ‘EnableDeduplication() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableDeduplication]’ D-Bus method.
handle-get-statistics Signal emitted when a remote caller is invoking the ‘GetStatistics() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.GetStatistics]’ D-Bus method.
handle-resize-logical Signal emitted when a remote caller is invoking the ‘ResizeLogical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizeLogical]’ D-Bus method.
handle-resize-physical Signal emitted when a remote caller is invoking the ‘ResizePhysical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizePhysical]’ D-Bus method.

Fields

None

Class Details

class UDisks.VDOVolume
Bases:GObject.GInterface
Structure:UDisks.VDOVolumeIface

Abstract interface type for the D-Bus interface ‘org.freedesktop.UDisks2.VDOVolume [gdbus-interface-org-freedesktop-UDisks2-VDOVolume.top_of_page]’.

New in version 2.9.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.VDOVolume [gdbus-interface-org-freedesktop-UDisks2-VDOVolume.top_of_page]’ D-Bus interface.

New in version 2.9.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.VDOVolume interface for a concrete class. The properties are overridden in the order they are defined.

New in version 2.9.0.

call_enable_compression(arg_enable, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the ‘EnableCompression() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableCompression]’ 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.VDOVolume.call_enable_compression_finish() to get the result of the operation.

See UDisks.VDOVolume.call_enable_compression_sync() for the synchronous, blocking version of this method.

New in version 2.9.0.

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

Finishes an operation started with UDisks.VDOVolume.call_enable_compression().

New in version 2.9.0.

call_enable_compression_sync(arg_enable, 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 ‘EnableCompression() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableCompression]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VDOVolume.call_enable_compression() for the asynchronous version of this method.

New in version 2.9.0.

call_enable_deduplication(arg_enable, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the ‘EnableDeduplication() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableDeduplication]’ 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.VDOVolume.call_enable_deduplication_finish() to get the result of the operation.

See UDisks.VDOVolume.call_enable_deduplication_sync() for the synchronous, blocking version of this method.

New in version 2.9.0.

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

Finishes an operation started with UDisks.VDOVolume.call_enable_deduplication().

New in version 2.9.0.

call_enable_deduplication_sync(arg_enable, 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 ‘EnableDeduplication() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableDeduplication]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VDOVolume.call_enable_deduplication() for the asynchronous version of this method.

New in version 2.9.0.

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

Asynchronously invokes the ‘GetStatistics() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.GetStatistics]’ 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.VDOVolume.call_get_statistics_finish() to get the result of the operation.

See UDisks.VDOVolume.call_get_statistics_sync() for the synchronous, blocking version of this method.

New in version 2.9.0.

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

Finishes an operation started with UDisks.VDOVolume.call_get_statistics().

New in version 2.9.0.

call_get_statistics_sync(arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

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

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

Return type:

(bool, out_stats: GLib.Variant)

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

See UDisks.VDOVolume.call_get_statistics() for the asynchronous version of this method.

New in version 2.9.0.

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

Asynchronously invokes the ‘ResizeLogical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizeLogical]’ 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.VDOVolume.call_resize_logical_finish() to get the result of the operation.

See UDisks.VDOVolume.call_resize_logical_sync() for the synchronous, blocking version of this method.

New in version 2.9.0.

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

Finishes an operation started with UDisks.VDOVolume.call_resize_logical().

New in version 2.9.0.

call_resize_logical_sync(arg_size, 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 ‘ResizeLogical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizeLogical]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VDOVolume.call_resize_logical() for the asynchronous version of this method.

New in version 2.9.0.

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

Asynchronously invokes the ‘ResizePhysical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizePhysical]’ 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.VDOVolume.call_resize_physical_finish() to get the result of the operation.

See UDisks.VDOVolume.call_resize_physical_sync() for the synchronous, blocking version of this method.

New in version 2.9.0.

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

Finishes an operation started with UDisks.VDOVolume.call_resize_physical().

New in version 2.9.0.

call_resize_physical_sync(arg_size, 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 ‘ResizePhysical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizePhysical]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.VDOVolume.call_resize_physical() for the asynchronous version of this method.

New in version 2.9.0.

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

Helper function used in service implementations to finish handling invocations of the ‘EnableCompression() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableCompression]’ 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.9.0.

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

Helper function used in service implementations to finish handling invocations of the ‘EnableDeduplication() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableDeduplication]’ 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.9.0.

complete_get_statistics(invocation, stats)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the ‘GetStatistics() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.GetStatistics]’ 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.9.0.

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

Helper function used in service implementations to finish handling invocations of the ‘ResizeLogical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizeLogical]’ 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.9.0.

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

Helper function used in service implementations to finish handling invocations of the ‘ResizePhysical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizePhysical]’ 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.9.0.

do_handle_enable_compression(invocation, arg_enable, arg_options) virtual
Parameters:
Return type:

bool

do_handle_enable_deduplication(invocation, arg_enable, arg_options) virtual
Parameters:
Return type:

bool

do_handle_get_statistics(invocation, arg_options) virtual
Parameters:
Return type:

bool

do_handle_resize_logical(invocation, arg_size, arg_options) virtual
Parameters:
Return type:

bool

do_handle_resize_physical(invocation, arg_size, arg_options) virtual
Parameters:
Return type:

bool

Signal Details

UDisks.VDOVolume.signals.handle_enable_compression(v_d_o_volume, invocation, arg_enable, arg_options)
Signal Name:

handle-enable-compression

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 ‘EnableCompression() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableCompression]’ 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.VDOVolume.complete_enable_compression() 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.9.0.

UDisks.VDOVolume.signals.handle_enable_deduplication(v_d_o_volume, invocation, arg_enable, arg_options)
Signal Name:

handle-enable-deduplication

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 ‘EnableDeduplication() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableDeduplication]’ 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.VDOVolume.complete_enable_deduplication() 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.9.0.

UDisks.VDOVolume.signals.handle_get_statistics(v_d_o_volume, invocation, arg_options)
Signal Name:

handle-get-statistics

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 ‘GetStatistics() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.GetStatistics]’ 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.VDOVolume.complete_get_statistics() 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.9.0.

UDisks.VDOVolume.signals.handle_resize_logical(v_d_o_volume, invocation, arg_size, arg_options)
Signal Name:

handle-resize-logical

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 ‘ResizeLogical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizeLogical]’ 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.VDOVolume.complete_resize_logical() 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.9.0.

UDisks.VDOVolume.signals.handle_resize_physical(v_d_o_volume, invocation, arg_size, arg_options)
Signal Name:

handle-resize-physical

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 ‘ResizePhysical() [gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizePhysical]’ 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.VDOVolume.complete_resize_physical() 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.9.0.

Property Details

UDisks.VDOVolume.props.compression
Name:compression
Type:bool
Default Value:False
Flags:READABLE, WRITABLE

Represents the D-Bus property ‘“Compression” [gdbus-property-org-freedesktop-UDisks2-VDOVolume.Compression]’.

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.9.0.

UDisks.VDOVolume.props.compression_state
Name:compression-state
Type:str
Default Value:None
Flags:READABLE, WRITABLE

Represents the D-Bus property ‘“CompressionState” [gdbus-property-org-freedesktop-UDisks2-VDOVolume.CompressionState]’.

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.9.0.

UDisks.VDOVolume.props.deduplication
Name:deduplication
Type:bool
Default Value:False
Flags:READABLE, WRITABLE

Represents the D-Bus property ‘“Deduplication” [gdbus-property-org-freedesktop-UDisks2-VDOVolume.Deduplication]’.

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.9.0.

UDisks.VDOVolume.props.index_state
Name:index-state
Type:str
Default Value:None
Flags:READABLE, WRITABLE

Represents the D-Bus property ‘“IndexState” [gdbus-property-org-freedesktop-UDisks2-VDOVolume.IndexState]’.

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.9.0.

UDisks.VDOVolume.props.operating_mode
Name:operating-mode
Type:str
Default Value:None
Flags:READABLE, WRITABLE

Represents the D-Bus property ‘“OperatingMode” [gdbus-property-org-freedesktop-UDisks2-VDOVolume.OperatingMode]’.

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.9.0.

UDisks.VDOVolume.props.used_size
Name:used-size
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property ‘“UsedSize” [gdbus-property-org-freedesktop-UDisks2-VDOVolume.UsedSize]’.

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.9.0.

UDisks.VDOVolume.props.vdo_pool
Name:vdo-pool
Type:str
Default Value:None
Flags:READABLE, WRITABLE

Represents the D-Bus property ‘“VDOPool” [gdbus-property-org-freedesktop-UDisks2-VDOVolume.VDOPool]’.

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.9.0.