Google Cloud Dataform V1beta1 Client - Class QueryUserRootContentsRequest (0.10.0)

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

QueryUserRootContents request message.

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

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ location string

Required. Location of the user root folder whose contents to list. Format: projects//locations/
↳ 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 QueryUserRootContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryUserRootFolderContents, 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), created_at, last_modified_at. 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""

getLocation

Required. Location of the user root folder whose contents to list.

Format: projects//locations/

Returns
Type Description
string

setLocation

Required. Location of the user root folder whose contents to list.

Format: projects//locations/

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 QueryUserRootContents call.

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

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryUserRootFolderContents, 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), created_at, last_modified_at. 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), created_at, last_modified_at. 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
location string

Required. Location of the user root folder whose contents to list. Format: projects//locations/ Please see DataformClient::locationName() for help formatting this field.
Returns
Type Description
QueryUserRootContentsRequest