otcextensions.sdk.dds.v3.job

The Job Class

The Job class inherits from Resource.

class otcextensions.sdk.dds.v3.job.Job

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 = '/jobs'

The base part of the URI for this resource.

allow_fetch = True

Allow get operation for this resource.

id: str

The ID of this resource.

name: str

The name of this resource.

fetch(session, requires_id=True, base_path=None, error_message=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.

last updated: UTC - commit: