Service to manage TSB workspaces.
The Workspaces service provides methods to manage the workspaces for a given tenant.
Workspaces are the main containers for the different configuration resources available in TSB,
and provide infrastructure isolation constraints.
Request to create an API.
| Field | Description | Validation Rule |
|---|
parent | string
REQUIRED
Parent resource where the API will be created. | string = {
min_len: 1
}
|
name | string
REQUIRED
The short name for the resource to be created. | string = {
min_len: 1
max_len: 63
pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}
|
api | tetrateio.api.tsb.v2.API
REQUIRED
Details of the API to be created. | message = {
required: true
}
|
Request to create a Workspace.
| Field | Description | Validation Rule |
|---|
parent | string
REQUIRED
Parent resource where the Workspace will be created. | string = {
min_len: 1
}
|
name | string
REQUIRED
The short name for the resource to be created. | string = {
min_len: 1
max_len: 63
pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}
|
workspace | tetrateio.api.tsb.v2.Workspace
REQUIRED
Details of the Workspace to be created. | message = {
required: true
}
|
Request to create a Workspace Settings.
| Field | Description | Validation Rule |
|---|
parent | string
REQUIRED
Parent resource where the Workspace Settings will be created. | string = {
min_len: 1
}
|
name | string
REQUIRED
The short name for the resource to be created. | string = {
min_len: 1
max_len: 63
pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}
|
settings | tetrateio.api.tsb.v2.WorkspaceSetting
REQUIRED
Details of the Workspace Settings to be created. | message = {
required: true
}
|
Request to delete an API.
| Field | Description | Validation Rule |
|---|
fqn | string
REQUIRED
Fully-qualified name of the API. | string = {
min_len: 1
}
|
Request to delete a Workspace.
| Field | Description | Validation Rule |
|---|
fqn | string
REQUIRED
Fully-qualified name of the Workspace. | string = {
min_len: 1
}
|
force | bool
Force the deletion of the object even if deletion protection is enabled.
If this is set, then the object and all its children will be deleted even if any of them
has the deletion protection enabled. | – |
Request to delete a Workspace Settings.
| Field | Description | Validation Rule |
|---|
fqn | string
REQUIRED
Fully-qualified name of the Workspace Settings. | string = {
min_len: 1
}
|
Request to retrieve an API.
| Field | Description | Validation Rule |
|---|
fqn | string
REQUIRED
Fully-qualified name of the API. | string = {
min_len: 1
}
|
Request to retrieve a Workspace.
| Field | Description | Validation Rule |
|---|
fqn | string
REQUIRED
Fully-qualified name of the Workspace. | string = {
min_len: 1
}
|
Request to retrieve a Workspace Settings.
| Field | Description | Validation Rule |
|---|
fqn | string
REQUIRED
Fully-qualified name of the Workspace Settings. | string = {
min_len: 1
}
|
Request to list APIs.
| Field | Description | Validation Rule |
|---|
parent | string
REQUIRED
Parent resource to list APIs from. | string = {
min_len: 1
}
|
pageSize | int32
Optional. Maximum number of items to return in one page. If zero and page_token
is also empty, the response contains the complete, unpaginated list (the behavior
prior to pagination support). Values above 1000 are rejected with
INVALID_ARGUMENT naming the maximum, rather than being clamped to it — a clamped
caller receives a smaller page than it asked for with nothing saying so. A non-empty
page_token with a zero page_size uses a default page size of 50. Prefer setting
page_size explicitly on every request of a walk: sending only the token falls back
to that default rather than reusing the previous page's size. Negative values, and
values between 1 and 9, are rejected with INVALID_ARGUMENT — small pages are
disproportionately expensive to serve, so request at least 10 items per page. | – |
pageToken | string
Optional. Opaque continuation token from a previous response's next_page_token.
Tokens are bound to the query that issued them: replaying a token with a different
parent or against a different List method is rejected with INVALID_ARGUMENT.
A token confers no authority of its own: parent is validated on every request, so a
resume whose parent no longer exists is rejected with NOT_FOUND rather than returning
an empty page. | – |
List of all API objects in the workspace.
| Field | Description | Validation Rule |
|---|
apis | List of tetrateio.api.tsb.v2.API
| – |
nextPageToken | string
Opaque token for the next page. Empty when there are no further pages — this is
the only end-of-list signal: a page may contain fewer items than page_size
(even zero) while more pages remain. Item order is unspecified and not a stable
contract. | – |
totalSize | int32
Total number of items under parent that match this request and the caller is
permitted to see, counted after permission filtering. Set on every response, paged or
not, so a client never has to branch on whether it paginated to learn the count. Exact on an unpaged response, where it is simply the number of items returned. On a
paged response it is an UPPER BOUND: it counts authorized entries before they are
loaded, so it can exceed what a full walk ultimately yields if an item is present in
the authorization graph but absent from the store. A zero always means the result is empty. This field is set on every response, so a
zero never means the server declined to compute a total. | – |
Request to list Workspace Settings.
| Field | Description | Validation Rule |
|---|
parent | string
REQUIRED
Parent resource to list Workspace Settings from. | string = {
min_len: 1
}
|
The existing settings objects for the given workspace.
Request to list Workspaces.
| Field | Description | Validation Rule |
|---|
parent | string
REQUIRED
Parent resource to list Workspaces from. | string = {
min_len: 1
}
|
pageSize | int32
Optional. Maximum number of items to return in one page. If zero and page_token
is also empty, the response contains the complete, unpaginated list (the behavior
prior to pagination support). Values above 1000 are rejected with
INVALID_ARGUMENT naming the maximum, rather than being clamped to it — a clamped
caller receives a smaller page than it asked for with nothing saying so. A non-empty
page_token with a zero page_size uses a default page size of 50. Prefer setting
page_size explicitly on every request of a walk: sending only the token falls back
to that default rather than reusing the previous page's size. Negative values, and
values between 1 and 9, are rejected with INVALID_ARGUMENT — small pages are
disproportionately expensive to serve, so request at least 10 items per page. | – |
pageToken | string
Optional. Opaque continuation token from a previous response's next_page_token.
Tokens are bound to the query that issued them: replaying a token with a different
parent or against a different List method is rejected with INVALID_ARGUMENT.
A token confers no authority of its own: parent is validated on every request, so a
resume whose parent no longer exists is rejected with NOT_FOUND rather than returning
an empty page. | – |
The existing workspaces for the given tenant.
| Field | Description | Validation Rule |
|---|
workspaces | List of tetrateio.api.tsb.v2.Workspace
| – |
nextPageToken | string
Opaque token for the next page. Empty when there are no further pages — this is
the only end-of-list signal: a page may contain fewer items than page_size
(even zero) while more pages remain. Item order is unspecified and not a stable
contract. | – |
totalSize | int32
Total number of items under parent that match this request and the caller is
permitted to see, counted after permission filtering. Set on every response, paged or
not, so a client never has to branch on whether it paginated to learn the count. Exact on an unpaged response, where it is simply the number of items returned. On a
paged response it is an UPPER BOUND: it counts authorized entries before they are
loaded, so it can exceed what a full walk ultimately yields if an item is present in
the authorization graph but absent from the store. A zero always means the result is empty. This field is set on every response, so a
zero never means the server declined to compute a total. | – |
Tetrate Service BridgeVersion: next