openstack.block_storage.v3.type¶
The Type Class¶
The Type
class inherits from Resource
.
- class openstack.block_storage.v3.type.Type(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- resource_key = 'volume_type'¶
Singular form of key for resource.
- resources_key = 'volume_types'¶
Plural form of key for resource.
- base_path = '/types'¶
The base part of the URI for this resource.
- allow_fetch = True¶
Allow get operation for this resource.
- allow_create = True¶
Allow create operation for this resource.
- allow_delete = True¶
Allow delete operation for this resource.
- allow_list = True¶
Allow list operation for this resource.
- allow_commit = True¶
Allow update operation for this resource.
- description¶
Description of the type.
- extra_specs¶
A dict of extra specifications. “capabilities” is a usual key.
- is_public¶
a private volume-type. Type: bool
- set_extra_specs(session, **extra_specs)¶
Update extra specs.
This call will replace only the extra_specs with the same keys given here. Other keys will not be modified.
- Parameters:
session – The session to use for making this request.
extra_specs (kwargs) – Key/value extra_specs pairs to be update on this volume type. All keys and values.
- Returns:
The updated extra specs.
- delete_extra_specs(session, keys)¶
Delete extra specs.
Note
This method will do a HTTP DELETE request for every key in keys.
- Parameters:
session – The session to use for this request.
keys (list) – The keys to delete.
- Returns:
None
- get_private_access(session)¶
List projects with private access to the volume type.
- Parameters:
session – The session to use for making this request.
- Returns:
The volume type access response.
- add_private_access(session, project_id)¶
Add project access from the volume type.
- Parameters:
session – The session to use for making this request.
project_id – The project to add access for.
- remove_private_access(session, project_id)¶
Remove project access from the volume type.
- Parameters:
session – The session to use for making this request.
project_id – The project to remove access for.
The TypeEncryption Class¶
The TypeEncryption
class inherits from
Resource
.
- class openstack.block_storage.v3.type.TypeEncryption(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- resource_key = 'encryption'¶
Singular form of key for resource.
- resources_key = 'encryption'¶
Plural form of key for resource.
- base_path = '/types/%(volume_type_id)s/encryption'¶
The base part of the URI for this resource.
- allow_fetch = True¶
Allow get operation for this resource.
- allow_create = True¶
Allow create operation for this resource.
- allow_delete = True¶
Allow delete operation for this resource.
- allow_list = False¶
Allow list operation for this resource.
- allow_commit = True¶
Allow update operation for this resource.
- cipher¶
The encryption algorithm or mode.
- control_location¶
Notional service where encryption is performed.
- created_at¶
The date and time when the resource was created.
- deleted¶
The resource is deleted or not.
- deleted_at¶
The date and time when the resource was deleted.
- encryption_id¶
A ID representing this type.
- key_size¶
The Size of encryption key.
- provider¶
The class that provides encryption support.
- updated_at¶
The date and time when the resource was updated.
- volume_type_id¶
The ID of the Volume Type.