openstack.accelerator.v2.accelerator_request

The AcceleratorRequest Class

The AcceleratorRequest class inherits from Resource.

class openstack.accelerator.v2.accelerator_request.AcceleratorRequest(_synchronized=False, connection=None, **attrs)

The base resource

Parameters:

  • _synchronized (bool) – This is not intended to be used directly. See new() and existing().

  • 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 = 'arq'

Singular form of key for resource.

resources_key = 'arqs'

Plural form of key for resource.

base_path = '/accelerator_requests'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

allow_patch = True

Allow patch operation for binding.

attach_handle_info

The device address associated with this ARQ (if any)

attach_handle_type

The type of attach handle (e.g. PCI, mdev…)

device_profile_name

The name of the device profile

device_profile_group_id

The id of the device profile group

device_rp_uuid

The UUID of the bound device RP (if any)

hostname

The host name to which ARQ is bound. (if any)

instance_uuid

The UUID of the instance associated with this ARQ (if any)

state

The state of the ARQ

uuid

The UUID of the ARQ

patch(session, patch=None, prepend_key=True, has_body=True, retry_on_conflict=None, base_path=None, *, microversion=None)

Patch the remote resource.

Allows modifying the resource by providing a list of JSON patches to apply to it. The patches can use both the original (server-side) and SDK field names.

Parameters:

  • session (Adapter) – The session to use for making this request.

  • patch – Additional JSON patch as a list or one patch item. If provided, it is applied on top of any changes to the current resource.

  • prepend_key – A boolean indicating whether the resource_key should be prepended in a resource update request. Default to True.

  • retry_on_conflict (bool) – Whether to enable retries on HTTP CONFLICT (409). Value of None leaves the Adapter defaults.

  • base_path (str) – Base part of the URI for modifying resources, if different from base_path.

  • microversion (str) – API version to override the negotiated one.

Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_patch is not set to True.

create(session, prepend_key=False, *args, **kwargs)

Create a remote resource based on this instance.

Parameters:

  • session (Adapter) – The session to use for making this request.

  • prepend_key – A boolean indicating whether the resource_key should be prepended in a resource creation request. Default to True.

  • base_path (str) – Base part of the URI for creating resources, if different from base_path.

  • resource_request_key (str) – Overrides the usage of self.resource_key when prepending a key to the request body. Ignored if prepend_key is false.

  • resource_response_key (str) – Overrides the usage of self.resource_key when processing response bodies. Ignored if prepend_key is false.

  • microversion (str) – API version to override the negotiated one.

  • params (dict) – Additional params to pass.

Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_create is not set to True.