Skip to main content

aip_sdk.WorkspaceScope

aip_sdk.WorkspaceScope

How request() resolves workspace_id for one call.

Pair this with a WorkspaceTarget on a WorkspaceRequest to say both how the workspace is resolved and where the resolved value is sent. iter_bytes/get_bytes stream directly rather than going through request() and carry no workspace declaration.

Attributes

  • WRITE_REQUIRED: Raises NoWorkspaceSelectedError rather than resolving to nothing. Also the mode for a read whose route requires exactly one workspace.
  • READ_DEFAULT: Defaults to the session's configured workspace; pass all_workspaces=True to read across every workspace you can access.
  • NONE: No workspace semantics apply — the request passes through unchanged. The default for get/post/patch/put/delete.

aip_sdk.WorkspaceScope.NONE​

aip_sdk.WorkspaceScope.NONE = 'none'

No docstring is defined in the source.

aip_sdk.WorkspaceScope.READ_DEFAULT​

aip_sdk.WorkspaceScope.READ_DEFAULT = 'read_default'

No docstring is defined in the source.

aip_sdk.WorkspaceScope.WRITE_REQUIRED​

aip_sdk.WorkspaceScope.WRITE_REQUIRED = 'write_required'

No docstring is defined in the source.