Method: projects.locations.repositories.workspaces.list

Lists Workspaces in a given Repository.

HTTP request

GET https://dataform.googleapis.com/v1beta1/{parent=projects/*/locations/*/repositories/*}/workspaces

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.

Authorization requires the following IAM permission on the specified resource parent:

  • dataform.workspaces.list

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
pageToken

string

Optional. Page token received from a previous workspaces.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to workspaces.list, with the exception of pageSize, must match the call that provided the page token.
orderBy

string

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.
filter

string

Optional. Filter for the returned list.

Request body

The request body must be empty.

Response body

workspaces.list response message.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "workspaces": [
    {
      object (Workspace)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
workspaces[]

object (Workspace)

List of workspaces.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
unreachable[]

string

Locations which could not be reached.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • dataform.workspaces.list

For more information, see the IAM documentation.