public final class SearchResourcesRequest extends GeneratedMessageV3 implements SearchResourcesRequestOrBuilder
The SearchResources method's
request.
Protobuf type google.cloud.apihub.v1.SearchResourcesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SearchResourcesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchResourcesRequest.Builder newBuilder()
newBuilder(SearchResourcesRequest prototype)
public static SearchResourcesRequest.Builder newBuilder(SearchResourcesRequest prototype)
public static SearchResourcesRequest parseDelimitedFrom(InputStream input)
public static SearchResourcesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchResourcesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchResourcesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchResourcesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResourcesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResourcesRequest parseFrom(CodedInputStream input)
public static SearchResourcesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResourcesRequest parseFrom(InputStream input)
public static SearchResourcesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchResourcesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchResourcesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchResourcesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SearchResourcesRequest getDefaultInstanceForType()
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, 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.
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, 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.
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()
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.
|
getParserForType()
public Parser<SearchResourcesRequest> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchResourcesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchResourcesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchResourcesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
