otcextensions.sdk.dds.v3.recycle_policy

The RecyclePolicy Class

The RecyclePolicy class inherits from Resource.

class otcextensions.sdk.dds.v3.recycle_policy.RecyclePolicy

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.

base_path: str = 'instances/recycle-policy'

The base part of the URI for this resource.

resource_key: str | None = 'recycle_policy'

Singular form of key for resource.

requires_id = False

Do calls for this resource require an ID.

allow_fetch = True

Allow get operation for this resource.

allow_create = True

Allow create operation for this resource.

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

DEPRECATED: Use create_opts.method instead. Method for creating a resource.

fetch(session, requires_id=False, base_path=None, error_message=None, skip_cache=False, *, resource_response_key=None, microversion=None, **params)

Get a remote resource based on this instance.

Parameters:

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

  • requires_id – Whether resource ID should be part of the requested URI.

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

  • error_message – An error message to be returned if requested object does not exist.

  • skip_cache – A boolean indicating whether optional API cache should be skipped for this invocation.

  • resource_response_key – Overrides the usage of self.resource_key when processing the response body.

  • microversion – API version to override the negotiated one.

  • params – Additional parameters that can be consumed.

Returns:

This Resource instance.

Raises:

MethodNotSupported if Resource.allow_fetch is not set to True.

Raises:

NotFoundException if the resource was not found.

create(session, prepend_key=True, base_path=None, *, resource_request_key=None, resource_response_key=None, microversion=None, **params)

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: