Google Cloud Dataform V1beta1 Client - Class SearchFilesRequest (0.6.0)

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

Configuration containing file search request parameters.

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

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ workspace string

Required. The workspace's name.

↳ page_size int

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_token string

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

↳ filter string

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

getWorkspace

Required. The workspace's name.

Returns
Type Description
string

setWorkspace

Required. The workspace's name.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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

Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

Returns
Type Description
string

setFilter

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

Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

Parameter
Name Description
var string
Returns
Type Description
$this