Reference documentation and code samples for the Google Cloud Api Hub V1 Client class SearchResourcesRequest.
The SearchResources method's request.
Generated from protobuf message google.cloud.apihub.v1.SearchResourcesRequest
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ location
string
Required. The resource name of the location which will be of the type projects/{project_id}/locations/{location_id}
. This field is used to identify the instance of API-Hub in which resources should be searched.
↳ query
string
Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc.
↳ filter
string
Optional. An expression that filters the list of search results. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be =
. Filters are not case sensitive. The following field names are eligible for filtering: * * resource_type
- The type of resource in the search results. Must be one of the following: Api
, ApiOperation
, Deployment
, Definition
, Spec
or Version
. This field can only be specified once in the filter. Here are is an example: * * resource_type = Api
- The resource_type is Api
.
↳ page_size
int
Optional. The maximum number of search results to return. The service may return fewer than this value. If unspecified at most 10 search results will be returned. If value is negative then INVALID_ARGUMENT
error is returned. The maximum value is 25; values above 25 will be coerced to 25. While paginating, you can specify a new page size parameter for each page of search results to be listed.
↳ page_token
string
Optional. A page token, received from a previous SearchResources
call. Specify this parameter to retrieve the next page of transactions. When paginating, you must specify the page_token
parameter and all the other parameters except page_size
should be specified with the same value which was used in the previous call. If the other fields are set with a different value than the previous call then INVALID_ARGUMENT
error is returned.
getLocation
Required. The resource name of the location which will be of the type projects/{project_id}/locations/{location_id}
. This field is used to
identify the instance of API-Hub in which resources should be searched.
string
setLocation
Required. The resource name of the location which will be of the type projects/{project_id}/locations/{location_id}
. This field is used to
identify the instance of API-Hub in which resources should be searched.
var
string
$this
getQuery
Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc.
string
setQuery
Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc.
var
string
$this
getFilter
Optional. An expression that filters the list of search results.
A filter expression consists of a field name, a comparison operator,
and a value for filtering. The value must be a string, a number, or a
boolean. The comparison operator must be =
. Filters are not case
sensitive.
The following field names are eligible for filtering:
-
resource_type- The type of resource in the search results. Must be one of the following:Api,ApiOperation,Deployment,Definition,SpecorVersion. This field can only be specified once in the filter. Here are is an example:-
resource_type = Api- The resource_type is Api .
-
string
setFilter
Optional. An expression that filters the list of search results.
A filter expression consists of a field name, a comparison operator,
and a value for filtering. The value must be a string, a number, or a
boolean. The comparison operator must be =
. Filters are not case
sensitive.
The following field names are eligible for filtering:
-
resource_type- The type of resource in the search results. Must be one of the following:Api,ApiOperation,Deployment,Definition,SpecorVersion. This field can only be specified once in the filter. Here are is an example:-
resource_type = Api- The resource_type is Api .
-
var
string
$this
getPageSize
Optional. The maximum number of search results to return. The service may
return fewer than this value. If unspecified at most 10 search results will
be returned. If value is negative then INVALID_ARGUMENT
error is
returned. The maximum value is 25; values above 25 will be coerced to 25.
While paginating, you can specify a new page size parameter for each page of search results to be listed.
int
setPageSize
Optional. The maximum number of search results to return. The service may
return fewer than this value. If unspecified at most 10 search results will
be returned. If value is negative then INVALID_ARGUMENT
error is
returned. The maximum value is 25; values above 25 will be coerced to 25.
While paginating, you can specify a new page size parameter for each page of search results to be listed.
var
int
$this
getPageToken
Optional. A page token, received from a previous SearchResources call. Specify this parameter to retrieve the next page of transactions.
When paginating, you must specify the page_token
parameter and all the
other parameters except page_size
should be specified with the same value which was used in the previous
call. If the other fields are set with a different value than the previous
call then INVALID_ARGUMENT
error is returned.
string
setPageToken
Optional. A page token, received from a previous SearchResources call. Specify this parameter to retrieve the next page of transactions.
When paginating, you must specify the page_token
parameter and all the
other parameters except page_size
should be specified with the same value which was used in the previous
call. If the other fields are set with a different value than the previous
call then INVALID_ARGUMENT
error is returned.
var
string
$this
static::build
location
string
Required. The resource name of the location which will be of the type projects/{project_id}/locations/{location_id}
. This field is used to
identify the instance of API-Hub in which resources should be searched. Please see ApiHubClient::locationName()
for help formatting this field.
query
string
Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc.

