Google Cloud Dataform V1 Client - Class ListWorkspacesRequest (0.9.1)
Reference documentation and code samples for the Google Cloud Dataform V1 Client class ListWorkspacesRequest.
ListWorkspaces request message.
Generated from protobuf messagegoogle.cloud.dataform.v1.ListWorkspacesRequest
Namespace
Google \ Cloud \ Dataform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ parent | stringRequired. The repository in which to list workspaces. Must be in the format |
↳ page_size | intOptional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
↳ page_token | stringOptional. Page token received from a previous |
↳ order_by | stringOptional. This field only supports ordering by |
↳ filter | stringOptional. Filter for the returned list. |
getParent
Required. The repository in which to list workspaces. Must be in theformatprojects/*/locations/*/repositories/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The repository in which to list workspaces. Must be in theformatprojects/*/locations/*/repositories/*.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. Maximum number of workspaces to return. The server may returnfewer items than requested. If unspecified, the server will pick anappropriate default.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. Maximum number of workspaces to return. The server may returnfewer items than requested. If unspecified, the server will pick anappropriate default.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Optional. Page token received from a previousListWorkspaces call.
Provide this to retrieve the subsequent page.When paginating, all other parameters provided toListWorkspaces, withthe exception ofpage_size, must match the call that provided the pagetoken.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. Page token received from a previousListWorkspaces call.
Provide this to retrieve the subsequent page.When paginating, all other parameters provided toListWorkspaces, withthe exception ofpage_size, must match the call that provided the pagetoken.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Optional. This field only supports ordering byname. If unspecified, theserver will choose the ordering. If specified, the default order isascending for thename field.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Optional. This field only supports ordering byname. If unspecified, theserver will choose the ordering. If specified, the default order isascending for thename field.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. Filter for the returned list.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. Filter for the returned list.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent | stringRequired. The repository in which to list workspaces. Must be in theformat |
| Returns | |
|---|---|
| Type | Description |
ListWorkspacesRequest | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-09 UTC.