aip_sdk.WorkspaceRequest
aip_sdk.WorkspaceRequest(*, scope: WorkspaceScope, target: WorkspaceTarget, workspace_id: str | None = None, project_id: str | None = None, all_workspaces: bool = False, field: str = 'workspace_id')
One call's unresolved workspace declaration: what to resolve, and where it goes.
Pass to request() (or a sugar method) as workspace=. To use the resolved value
in your own code as well, resolve it first with client.resolve_workspace() and pass
the resulting ResolvedWorkspace instead.
Attributes
scopeWorkspaceScope: How the workspace is resolved. No default — every call site states it.targetWorkspaceTarget: Where the resolved value is written. No default, for the same reason.workspace_idstr | None: An explicit workspace for this call, if given.project_idstr | None: The project this call is scoped to, if any.all_workspacesbool:READ_DEFAULT's opt-out, to read across every workspace the caller can access.fieldstr: The parameter, body key, or path placeholder to write.
aip_sdk.WorkspaceRequest.all_workspaces
aip_sdk.WorkspaceRequest.all_workspaces: bool = False
No docstring is defined in the source.
aip_sdk.WorkspaceRequest.field
aip_sdk.WorkspaceRequest.field: str = 'workspace_id'
No docstring is defined in the source.
aip_sdk.WorkspaceRequest.project_id
aip_sdk.WorkspaceRequest.project_id: str | None = None
No docstring is defined in the source.
aip_sdk.WorkspaceRequest.scope
aip_sdk.WorkspaceRequest.scope: WorkspaceScope
No docstring is defined in the source.
aip_sdk.WorkspaceRequest.target
aip_sdk.WorkspaceRequest.target: WorkspaceTarget
No docstring is defined in the source.
aip_sdk.WorkspaceRequest.workspace_id
aip_sdk.WorkspaceRequest.workspace_id: str | None = None
No docstring is defined in the source.