Google Cloud Dataform V1beta1 Client - Class ListWorkspacesRequest (0.3.0)

Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class ListWorkspacesRequest.

ListWorkspaces request message.

Generated from protobuf message google.cloud.dataform.v1beta1.ListWorkspacesRequest

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ page_size int

Optional. 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 string

Optional. Page token received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

↳ order_by 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.

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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

Returns
TypeDescription
int

setPageSize

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. Page token received from a previous ListWorkspaces call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

Returns
TypeDescription
string

setPageToken

Optional. Page token received from a previous ListWorkspaces call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

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.

Returns
TypeDescription
string

setOrderBy

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. Filter for the returned list.

Returns
TypeDescription
string

setFilter

Optional. Filter for the returned list.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*. Please see Google\Cloud\Dataform\V1beta1\DataformClient::repositoryName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Dataform\V1beta1\ListWorkspacesRequest