public static final class SearchResourcesRequest.Builder extends GeneratedMessageV3.Builder<SearchResourcesRequest.Builder> implements SearchResourcesRequestOrBuilderThe SearchResources method's request.
Protobuf type google.cloud.apihub.v1.SearchResourcesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResourcesRequest.BuilderImplements
SearchResourcesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResourcesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
build()
public SearchResourcesRequest build()| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest |
|
buildPartial()
public SearchResourcesRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest |
|
clear()
public SearchResourcesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public SearchResourcesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
clearFilter()
public SearchResourcesRequest.Builder clearFilter()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 filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
clearLocation()
public SearchResourcesRequest.Builder clearLocation() 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 location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResourcesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
clearPageSize()
public SearchResourcesRequest.Builder clearPageSize() 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.
int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
clearPageToken()
public SearchResourcesRequest.Builder clearPageToken()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 page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
clearQuery()
public SearchResourcesRequest.Builder clearQuery()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 query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
clone()
public SearchResourcesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
getDefaultInstanceForType()
public SearchResourcesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String 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 filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()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 filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getLocation()
public String 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 location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The location. |
getLocationBytes()
public ByteString getLocationBytes() 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 location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for location. |
getPageSize()
public int 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.
int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String 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 page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()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 page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getQuery()
public String 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 query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public ByteString getQueryBytes()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 query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for query. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchResourcesRequest other)
public SearchResourcesRequest.Builder mergeFrom(SearchResourcesRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchResourcesRequest |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResourcesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchResourcesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResourcesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResourcesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
setFilter(String value)
public SearchResourcesRequest.Builder setFilter(String value)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 filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public SearchResourcesRequest.Builder setFilterBytes(ByteString value)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 filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setLocation(String value)
public SearchResourcesRequest.Builder setLocation(String value) 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 location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe location to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setLocationBytes(ByteString value)
public SearchResourcesRequest.Builder setLocationBytes(ByteString value) 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 location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for location to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public SearchResourcesRequest.Builder setPageSize(int value) 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.
int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public SearchResourcesRequest.Builder setPageToken(String value)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 page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public SearchResourcesRequest.Builder setPageTokenBytes(ByteString value)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 page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setQuery(String value)
public SearchResourcesRequest.Builder setQuery(String value)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 query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setQueryBytes(ByteString value)
public SearchResourcesRequest.Builder setQueryBytes(ByteString value)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 query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResourcesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResourcesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResourcesRequest.Builder |
|