- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- SearchResult
- FileSearchResult
- DirectorySearchResult
Finds the contents of a given Workspace directory by filter.
HTTP request
GET https://dataform.googleapis.com/v1beta1/{workspace=projects/*/locations/*/repositories/*/workspaces/*}:searchFiles
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
workspace |
Required. The workspace's name. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
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. |
pageToken |
Optional. Page token received from a previous When paginating, all other parameters provided to |
filter |
Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the |
Request body
The request body must be empty.
Response body
Client-facing representation of a file search response.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"searchResults": [
{
object ( |
Fields | |
---|---|
searchResults[] |
List of matched results. |
nextPageToken |
Optional. A token, which can be sent as |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the workspace
resource:
dataform.workspaces.searchFiles
For more information, see the IAM documentation.
SearchResult
Client-facing representation of a search result entry.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
file |
Details when search result is a file. |
directory |
Details when search result is a directory. |
FileSearchResult
Client-facing representation of a file entry in search results.
JSON representation |
---|
{ "path": string } |
Fields | |
---|---|
path |
File system path relative to the workspace root. |
DirectorySearchResult
Client-facing representation of a directory entry in search results.
JSON representation |
---|
{ "path": string } |
Fields | |
---|---|
path |
File system path relative to the workspace root. |