Google Cloud Dataform V1beta1 Client - Class FetchWorkspaceBranchesRequest (0.15.3)

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

Request message for FetchWorkspaceBranches method.

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

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

↳ filter int

Optional. Filter for the returned list.

↳ page_size int

Optional. Maximum number of branches to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

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

getName

Required. The workspace resource name.

Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

Returns
Type Description
string

setName

Required. The workspace resource name.

Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filter for the returned list.

Returns
Type Description
int Enum of type BranchFilter.

setFilter

Optional. Filter for the returned list.

Parameter
Name Description
var int

Enum of type BranchFilter.

Returns
Type Description
$this

getPageSize

Optional. Maximum number of branches to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

Optional. Maximum number of branches to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

When paginating, all other parameters provided to FetchWorkspaceBranches, with the exception of page_size, must match the call that provided the page token.

Returns
Type Description
string

setPageToken

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

When paginating, all other parameters provided to FetchWorkspaceBranches, with the exception of page_size, must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this