Class SearchResourcesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.apihub.v1.SearchResourcesRequest
All Implemented Interfaces:
SearchResourcesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class SearchResourcesRequest extends com.google.protobuf.GeneratedMessage implements SearchResourcesRequestOrBuilder
 The [SearchResources][google.cloud.apihub.v1.ApiHub.SearchResources] method's
 request.
 
Protobuf type google.cloud.apihub.v1.SearchResourcesRequest
See Also:
  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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) = { ... }
      Specified by:
      getLocation in interface SearchResourcesRequestOrBuilder
      Returns:
      The location.
    • getLocationBytes

      public 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) = { ... }
      Specified by:
      getLocationBytes in interface SearchResourcesRequestOrBuilder
      Returns:
      The bytes for location.
    • 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];
      Specified by:
      getQuery in interface SearchResourcesRequestOrBuilder
      Returns:
      The query.
    • getQueryBytes

      public 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];
      Specified by:
      getQueryBytes in interface SearchResourcesRequestOrBuilder
      Returns:
      The bytes for query.
    • 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];
      Specified by:
      getFilter in interface SearchResourcesRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface SearchResourcesRequestOrBuilder
      Returns:
      The bytes for filter.
    • 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];
      Specified by:
      getPageSize in interface SearchResourcesRequestOrBuilder
      Returns:
      The pageSize.
    • getPageToken

      public 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];
      Specified by:
      getPageToken in interface SearchResourcesRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface SearchResourcesRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static SearchResourcesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchResourcesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchResourcesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchResourcesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchResourcesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchResourcesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchResourcesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchResourcesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchResourcesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchResourcesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchResourcesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchResourcesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public SearchResourcesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static SearchResourcesRequest.Builder newBuilder()
    • newBuilder

      public static SearchResourcesRequest.Builder newBuilder(SearchResourcesRequest prototype)
    • toBuilder

      public SearchResourcesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected SearchResourcesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static SearchResourcesRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SearchResourcesRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<SearchResourcesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public SearchResourcesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder