public sealed class SearchResourcesRequest : IPageRequest, IMessage<SearchResourcesRequest>, IEquatable<SearchResourcesRequest>, IDeepCloneable<SearchResourcesRequest>, IBufferMessage, IMessageReference documentation and code samples for the API hub v1 API class SearchResourcesRequest.
The [SearchResources][google.cloud.apihub.v1.ApiHub.SearchResources] method's request.
Implements
IPageRequest, IMessageSearchResourcesRequest, IEquatableSearchResourcesRequest, IDeepCloneableSearchResourcesRequest, IBufferMessage, IMessageNamespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
SearchResourcesRequest()
public SearchResourcesRequest()SearchResourcesRequest(SearchResourcesRequest)
public SearchResourcesRequest(SearchResourcesRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchResourcesRequest |
Properties
Filter
public string Filter { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Location
public string Location { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
LocationAsLocationName
public LocationName LocationAsLocationName { get; set; }LocationName-typed view over the Location resource name property.
| Property Value | |
|---|---|
| Type | Description |
LocationName |
|
PageSize
public int PageSize { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int |
|
PageToken
public string PageToken { get; set; }Optional. A page token, received from a previous [SearchResources][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][google.cloud.apihub.v1.SearchResourcesRequest.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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Query
public string Query { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|