Interface SearchResourcesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchResourcesRequest, SearchResourcesRequest.Builder

@Generated public interface SearchResourcesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Optional.
    com.google.protobuf.ByteString
    Optional.
    Required.
    com.google.protobuf.ByteString
    Required.
    int
    Optional.
    Optional.
    com.google.protobuf.ByteString
    Optional.
    Required.
    com.google.protobuf.ByteString
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getLocation

      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:
      The location.
    • getLocationBytes

      com.google.protobuf.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:
      The bytes for location.
    • getQuery

      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:
      The query.
    • getQueryBytes

      com.google.protobuf.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:
      The bytes for query.
    • getFilter

      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:
      The filter.
    • getFilterBytes

      com.google.protobuf.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:
      The bytes for filter.
    • getPageSize

      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:
      The pageSize.
    • getPageToken

      String getPageToken()
       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.
       
      string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.
    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       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.
       
      string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.