otcextensions.sdk.imsv2.v2.image

The Image Class

The Image class inherits from Resource.

class otcextensions.sdk.imsv2.v2.image.Image

The base resource

Parameters:

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

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

resources_key: str | None = 'images'

Plural form of key for resource.

resource_key: str | None = 'image'

Singular form of key for resource.

base_path: str = '/cloudimages'

The base part of the URI for this resource.

allow_create = True

Allow create operation for this resource.

allow_list = True

Allow list operation for this resource.

allow_commit = True

Allow update operation for this resource.

create_method: Literal['POST', 'PUT'] = 'POST'

Method for creating a resource (POST, PUT)

commit_method: Literal['POST', 'PATCH', 'PUT'] = 'PATCH'

Method for committing a resource. This must be PATCH if allow_patch is True.

name: str

The name of this resource.

create(session, prepend_key=False, base_path=None)

Create a remote resource based on this instance.

Parameters:

  • session – The session to use for making this request.

  • prepend_key – DEPRECATED Configure create_opts instead. Whether the resource_key should be prepended in a resource creation request. Default to True.

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

  • resource_request_key – DEPRECATED Configure create_opts instead. Overrides the usage of resource_key when prepending a key to the request body. Ignored if prepend_key is false.

  • resource_response_key – DEPRECATED Configure create_opts instead. Overrides the usage of resource_key when processing response bodies. Ignored if prepend_key is false.

  • microversion – API version to override the negotiated one.

  • params – Additional params to pass.

Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_create is not set to True.

last updated: UTC - commit: