Google Cloud Dataform V1beta1 Client - Class QueryFolderContentsRequest (0.10.0)

Version latest

• 0.10.0 (latest)
• 0.9.2
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.1
• 0.4.7
• 0.3.0
• 0.2.3
• 0.1.6

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

QueryFolderContents request message.

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

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ folder	string Required. Name of the folder whose contents to list. Format: projects//locations//folders/*
↳ 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 QueryFolderContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size, must match the call that provided the page token.
↳ order_by	string Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: - orderBy="display_name" - orderBy="display_name desc"
↳ filter	string Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field. Example: - filter="display_name="MyFolder""

getFolder

Required. Name of the folder whose contents to list.

Format: projects//locations//folders/*

Returns
Type	Description
string

setFolder

Required. Name of the folder whose contents to list.

Format: projects//locations//folders/*

Parameter
Name	Description
var	string

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. Page token received from a previous QueryFolderContents call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryFolderContents, 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 QueryFolderContents call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size, must match the call that provided the page token.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

Optional. Field to additionally sort results by.

Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

• orderBy="display_name"
• orderBy="display_name desc"

Returns
Type	Description
string

setOrderBy

Optional. Field to additionally sort results by.

Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

• orderBy="display_name"
• orderBy="display_name desc"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

Example:

• filter="display_name="MyFolder""

Returns
Type	Description
string

setFilter

Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

Example:

• filter="display_name="MyFolder""

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
folder	string Required. Name of the folder whose contents to list. Format: projects//locations//folders/* Please see DataformClient::folderName() for help formatting this field.

Returns
Type	Description
QueryFolderContentsRequest