Class SearchResourcesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchResourcesRequest.Builder>
com.google.cloud.apihub.v1.SearchResourcesRequest.Builder
All Implemented Interfaces:
SearchResourcesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchResourcesRequest

public static final class SearchResourcesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchResourcesRequest.Builder> implements SearchResourcesRequestOrBuilder
 The [SearchResources][google.cloud.apihub.v1.ApiHub.SearchResources] method's
 request.
 
Protobuf type google.cloud.apihub.v1.SearchResourcesRequest
  • 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.Builder<SearchResourcesRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SearchResourcesRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchResourcesRequest.Builder>
    • getDefaultInstanceForType

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

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

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

      public SearchResourcesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResourcesRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchResourcesRequest.Builder>
    • mergeFrom

      public SearchResourcesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResourcesRequest.Builder>
      Throws:
      IOException
    • 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.
    • setLocation

      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) = { ... }
      Parameters:
      value - The location to set.
      Returns:
      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:
      This builder for chaining.
    • setLocationBytes

      public SearchResourcesRequest.Builder setLocationBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for location to set.
      Returns:
      This builder for chaining.
    • 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.
    • setQuery

      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];
      Parameters:
      value - The query to set.
      Returns:
      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:
      This builder for chaining.
    • setQueryBytes

      public SearchResourcesRequest.Builder setQueryBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.
    • 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.
    • setFilter

      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`, `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];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.
    • 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`, `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:
      This builder for chaining.
    • setFilterBytes

      public SearchResourcesRequest.Builder setFilterBytes(com.google.protobuf.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`, `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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.
    • 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.
    • setPageSize

      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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • 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.
    • setPageToken

      public SearchResourcesRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.
    • clearPageToken

      public SearchResourcesRequest.Builder clearPageToken()
       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:
      This builder for chaining.
    • setPageTokenBytes

      public SearchResourcesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.