openstack.placement.v1.resource_provider_inventory

The ResourceProviderInventory Class

The ResourceProviderInventory class inherits from Resource.

class openstack.placement.v1.resource_provider_inventory.ResourceProviderInventory(_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 = None

Singular form of key for resource.

resources_key = None

Plural form of key for resource.

base_path = '/resource_providers/%(resource_provider_id)s/inventories'

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_commit = True

Allow update operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

resource_provider_id

The UUID of a resource provider.

resource_class

The name of the resource class.

resource_provider_generation

A consistent view marker that assists with the management of concurrent resource provider updates.

allocation_ratio

It is used in determining whether consumption of the resource of the provider can exceed physical constraints.

max_unit

A maximum amount any single allocation against an inventory can have.

min_unit

A minimum amount any single allocation against an inventory can have.

reserved

The amount of the resource a provider has reserved for its own use.

step_size

A representation of the divisible amount of the resource that may be requested. For example, step_size = 5 means that only values divisible by 5 (5, 10, 15, etc.) can be requested.

total

The actual amount of the resource that the provider can accommodate.

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

Commit the state of the instance to the remote resource.

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

  • kwargs (dict) – Parameters that will be passed to _prepare_request()

Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_commit is not set to True.

classmethod list(session, paginated=True, base_path=None, allow_unknown_params=False, *, microversion=None, **params)

This method is a generator which yields resource objects.

A re-implementation of list() that handles placement’s single, unpaginated list implementation.

Refer to list() for full documentation including parameter, exception and return type documentation.