Google Cloud Dataform V1beta1 Client - Class QueryDirectoryContentsRequest (0.2.3)

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

QueryDirectoryContents request message.

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

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ workspace string

Required. The workspace's name.

↳ path string

Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.

↳ page_size int

Optional. Maximum number of paths 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 QueryDirectoryContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryDirectoryContents must match the call that provided the page token.

getWorkspace

Required. The workspace's name.

Returns
TypeDescription
string

setWorkspace

Required. The workspace's name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPath

Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.

Returns
TypeDescription
string

setPath

Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. Maximum number of paths 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 paths 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 QueryDirectoryContents call.

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

Returns
TypeDescription
string

setPageToken

Optional. Page token received from a previous QueryDirectoryContents call.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this