Google Cloud Dataform V1 Client - Class SearchFilesRequest (0.8.1)

Reference documentation and code samples for the Google Cloud Dataform V1 Client class SearchFilesRequest.

Configuration containing file search request parameters.

Generated from protobuf messagegoogle.cloud.dataform.v1.SearchFilesRequest

Namespace

Google \ Cloud \ Dataform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ workspacestring

Required. The workspace's name.

↳ page_sizeint

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

↳ page_tokenstring

Optional. Page token received from a previousSearchFilesRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toSearchFilesRequest, with the exception ofpage_size, must match the call that provided the page token.

↳ filterstring

Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on thepath field. Seehttps://google.aip.dev/160 for details.

getWorkspace

Required. The workspace's name.

Returns
TypeDescription
string

setWorkspace

Required. The workspace's name.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getPageSize

Optional. Maximum number of search results to return. The server may returnfewer items than requested. If unspecified, the server will pick anappropriate default.

Returns
TypeDescription
int

setPageSize

Optional. Maximum number of search results to return. The server may returnfewer items than requested. If unspecified, the server will pick anappropriate default.

Parameter
NameDescription
varint
Returns
TypeDescription
$this

getPageToken

Optional. Page token received from a previousSearchFilesRequestcall. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided toSearchFilesRequest,with the exception ofpage_size, must match the call that provided thepage token.

Returns
TypeDescription
string

setPageToken

Optional. Page token received from a previousSearchFilesRequestcall. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided toSearchFilesRequest,with the exception ofpage_size, must match the call that provided thepage token.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getFilter

Returns
TypeDescription
string

setFilter

Optional. Optional filter for the returned list in filtering format.

Filtering is only currently supported on thepath field.Seehttps://google.aip.dev/160 for details.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-09 UTC.