Package com.google.cloud.visionai.v1

Class SearchIndexEndpointRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchIndexEndpointRequest.Builder>
com.google.cloud.visionai.v1.SearchIndexEndpointRequest.Builder
All Implemented Interfaces:
SearchIndexEndpointRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchIndexEndpointRequest
public static final class SearchIndexEndpointRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchIndexEndpointRequest.Builder> implements SearchIndexEndpointRequestOrBuilder
 Request message for SearchIndexEndpoint.
Protobuf type google.cloud.visionai.v1.SearchIndexEndpointRequest

  • 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<SearchIndexEndpointRequest.Builder>

    • clear

      public SearchIndexEndpointRequest.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<SearchIndexEndpointRequest.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<SearchIndexEndpointRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchIndexEndpointRequest.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<SearchIndexEndpointRequest.Builder>

    • mergeFrom

      public SearchIndexEndpointRequest.Builder mergeFrom(SearchIndexEndpointRequest other)

    • isInitialized

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

    • mergeFrom

      public SearchIndexEndpointRequest.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<SearchIndexEndpointRequest.Builder>
      Throws:
      IOException

    • getQueryCase

      public SearchIndexEndpointRequest.QueryCase getQueryCase()
      Specified by:
      getQueryCase in interface SearchIndexEndpointRequestOrBuilder

    • clearQuery

      public SearchIndexEndpointRequest.Builder clearQuery()

    • hasImageQuery

      public boolean hasImageQuery()
       An image-only query.
      .google.cloud.visionai.v1.ImageQuery image_query = 2;
      Specified by:
      hasImageQuery in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      Whether the imageQuery field is set.

    • getImageQuery

      public ImageQuery getImageQuery()
       An image-only query.
      .google.cloud.visionai.v1.ImageQuery image_query = 2;
      Specified by:
      getImageQuery in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      The imageQuery.

    • setImageQuery

      public SearchIndexEndpointRequest.Builder setImageQuery(ImageQuery value)
       An image-only query.
      .google.cloud.visionai.v1.ImageQuery image_query = 2;

    • setImageQuery

      public SearchIndexEndpointRequest.Builder setImageQuery(ImageQuery.Builder builderForValue)
       An image-only query.
      .google.cloud.visionai.v1.ImageQuery image_query = 2;

    • mergeImageQuery

      public SearchIndexEndpointRequest.Builder mergeImageQuery(ImageQuery value)
       An image-only query.
      .google.cloud.visionai.v1.ImageQuery image_query = 2;

    • clearImageQuery

      public SearchIndexEndpointRequest.Builder clearImageQuery()
       An image-only query.
      .google.cloud.visionai.v1.ImageQuery image_query = 2;

    • getImageQueryBuilder

      public ImageQuery.Builder getImageQueryBuilder()
       An image-only query.
      .google.cloud.visionai.v1.ImageQuery image_query = 2;

    • getImageQueryOrBuilder

      public ImageQueryOrBuilder getImageQueryOrBuilder()
       An image-only query.
      .google.cloud.visionai.v1.ImageQuery image_query = 2;
      Specified by:
      getImageQueryOrBuilder in interface SearchIndexEndpointRequestOrBuilder

    • hasTextQuery

      public boolean hasTextQuery()
       A text-only query.
      string text_query = 3;
      Specified by:
      hasTextQuery in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      Whether the textQuery field is set.

    • getTextQuery

      public String getTextQuery()
       A text-only query.
      string text_query = 3;
      Specified by:
      getTextQuery in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      The textQuery.

    • getTextQueryBytes

      public com.google.protobuf.ByteString getTextQueryBytes()
       A text-only query.
      string text_query = 3;
      Specified by:
      getTextQueryBytes in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      The bytes for textQuery.

    • setTextQuery

      public SearchIndexEndpointRequest.Builder setTextQuery(String value)
       A text-only query.
      string text_query = 3;
      Parameters:
      value - The textQuery to set.
      Returns:
      This builder for chaining.

    • clearTextQuery

      public SearchIndexEndpointRequest.Builder clearTextQuery()
       A text-only query.
      string text_query = 3;
      Returns:
      This builder for chaining.

    • setTextQueryBytes

      public SearchIndexEndpointRequest.Builder setTextQueryBytes(com.google.protobuf.ByteString value)
       A text-only query.
      string text_query = 3;
      Parameters:
      value - The bytes for textQuery to set.
      Returns:
      This builder for chaining.

    • getIndexEndpoint

      public String getIndexEndpoint()
       Required. The index endpoint to search.
 Format:
 `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getIndexEndpoint in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      The indexEndpoint.

    • getIndexEndpointBytes

      public com.google.protobuf.ByteString getIndexEndpointBytes()
       Required. The index endpoint to search.
 Format:
 `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getIndexEndpointBytes in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      The bytes for indexEndpoint.

    • setIndexEndpoint

      public SearchIndexEndpointRequest.Builder setIndexEndpoint(String value)
       Required. The index endpoint to search.
 Format:
 `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The indexEndpoint to set.
      Returns:
      This builder for chaining.

    • clearIndexEndpoint

      public SearchIndexEndpointRequest.Builder clearIndexEndpoint()
       Required. The index endpoint to search.
 Format:
 `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setIndexEndpointBytes

      public SearchIndexEndpointRequest.Builder setIndexEndpointBytes(com.google.protobuf.ByteString value)
       Required. The index endpoint to search.
 Format:
 `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for indexEndpoint to set.
      Returns:
      This builder for chaining.

    • getCriteriaList

      public List<Criteria> getCriteriaList()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaList in interface SearchIndexEndpointRequestOrBuilder

    • getCriteriaCount

      public int getCriteriaCount()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaCount in interface SearchIndexEndpointRequestOrBuilder

    • getCriteria

      public Criteria getCriteria(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteria in interface SearchIndexEndpointRequestOrBuilder

    • setCriteria

      public SearchIndexEndpointRequest.Builder setCriteria(int index, Criteria value)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • setCriteria

      public SearchIndexEndpointRequest.Builder setCriteria(int index, Criteria.Builder builderForValue)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • addCriteria

      public SearchIndexEndpointRequest.Builder addCriteria(Criteria value)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • addCriteria

      public SearchIndexEndpointRequest.Builder addCriteria(int index, Criteria value)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • addCriteria

      public SearchIndexEndpointRequest.Builder addCriteria(Criteria.Builder builderForValue)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • addCriteria

      public SearchIndexEndpointRequest.Builder addCriteria(int index, Criteria.Builder builderForValue)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • addAllCriteria

      public SearchIndexEndpointRequest.Builder addAllCriteria(Iterable<? extends Criteria> values)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • clearCriteria

      public SearchIndexEndpointRequest.Builder clearCriteria()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • removeCriteria

      public SearchIndexEndpointRequest.Builder removeCriteria(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getCriteriaBuilder

      public Criteria.Builder getCriteriaBuilder(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getCriteriaOrBuilder

      public CriteriaOrBuilder getCriteriaOrBuilder(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaOrBuilder in interface SearchIndexEndpointRequestOrBuilder

    • getCriteriaOrBuilderList

      public List<? extends CriteriaOrBuilder> getCriteriaOrBuilderList()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaOrBuilderList in interface SearchIndexEndpointRequestOrBuilder

    • addCriteriaBuilder

      public Criteria.Builder addCriteriaBuilder()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • addCriteriaBuilder

      public Criteria.Builder addCriteriaBuilder(int index)
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getCriteriaBuilderList

      public List<Criteria.Builder> getCriteriaBuilderList()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;

    • getExclusionCriteriaList

      public List<Criteria> getExclusionCriteriaList()
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;
      Specified by:
      getExclusionCriteriaList in interface SearchIndexEndpointRequestOrBuilder

    • getExclusionCriteriaCount

      public int getExclusionCriteriaCount()
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;
      Specified by:
      getExclusionCriteriaCount in interface SearchIndexEndpointRequestOrBuilder

    • getExclusionCriteria

      public Criteria getExclusionCriteria(int index)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;
      Specified by:
      getExclusionCriteria in interface SearchIndexEndpointRequestOrBuilder

    • setExclusionCriteria

      public SearchIndexEndpointRequest.Builder setExclusionCriteria(int index, Criteria value)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • setExclusionCriteria

      public SearchIndexEndpointRequest.Builder setExclusionCriteria(int index, Criteria.Builder builderForValue)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • addExclusionCriteria

      public SearchIndexEndpointRequest.Builder addExclusionCriteria(Criteria value)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • addExclusionCriteria

      public SearchIndexEndpointRequest.Builder addExclusionCriteria(int index, Criteria value)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • addExclusionCriteria

      public SearchIndexEndpointRequest.Builder addExclusionCriteria(Criteria.Builder builderForValue)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • addExclusionCriteria

      public SearchIndexEndpointRequest.Builder addExclusionCriteria(int index, Criteria.Builder builderForValue)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • addAllExclusionCriteria

      public SearchIndexEndpointRequest.Builder addAllExclusionCriteria(Iterable<? extends Criteria> values)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • clearExclusionCriteria

      public SearchIndexEndpointRequest.Builder clearExclusionCriteria()
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • removeExclusionCriteria

      public SearchIndexEndpointRequest.Builder removeExclusionCriteria(int index)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • getExclusionCriteriaBuilder

      public Criteria.Builder getExclusionCriteriaBuilder(int index)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • getExclusionCriteriaOrBuilder

      public CriteriaOrBuilder getExclusionCriteriaOrBuilder(int index)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;
      Specified by:
      getExclusionCriteriaOrBuilder in interface SearchIndexEndpointRequestOrBuilder

    • getExclusionCriteriaOrBuilderList

      public List<? extends CriteriaOrBuilder> getExclusionCriteriaOrBuilderList()
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;
      Specified by:
      getExclusionCriteriaOrBuilderList in interface SearchIndexEndpointRequestOrBuilder

    • addExclusionCriteriaBuilder

      public Criteria.Builder addExclusionCriteriaBuilder()
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • addExclusionCriteriaBuilder

      public Criteria.Builder addExclusionCriteriaBuilder(int index)
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • getExclusionCriteriaBuilderList

      public List<Criteria.Builder> getExclusionCriteriaBuilderList()
       Criteria to exclude from search results.
 Note that `fetch_matched_annotations` will be ignored.
      repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;

    • getPageSize

      public int getPageSize()
       Requested page size. API may return fewer results than requested.
 If negative, INVALID_ARGUMENT error will be returned.
 If unspecified or 0, API will pick a default size, which is 10.
 If the requested page size is larger than the maximum size, API will pick
 the maximum size, which is 200.
      int32 page_size = 5;
      Specified by:
      getPageSize in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public SearchIndexEndpointRequest.Builder setPageSize(int value)
       Requested page size. API may return fewer results than requested.
 If negative, INVALID_ARGUMENT error will be returned.
 If unspecified or 0, API will pick a default size, which is 10.
 If the requested page size is larger than the maximum size, API will pick
 the maximum size, which is 200.
      int32 page_size = 5;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public SearchIndexEndpointRequest.Builder clearPageSize()
       Requested page size. API may return fewer results than requested.
 If negative, INVALID_ARGUMENT error will be returned.
 If unspecified or 0, API will pick a default size, which is 10.
 If the requested page size is larger than the maximum size, API will pick
 the maximum size, which is 200.
      int32 page_size = 5;
      Returns:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       The continuation token to fetch the next page. If empty, it means it is
 fetching the first page.
      string page_token = 6;
      Specified by:
      getPageToken in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       The continuation token to fetch the next page. If empty, it means it is
 fetching the first page.
      string page_token = 6;
      Specified by:
      getPageTokenBytes in interface SearchIndexEndpointRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public SearchIndexEndpointRequest.Builder setPageToken(String value)
       The continuation token to fetch the next page. If empty, it means it is
 fetching the first page.
      string page_token = 6;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public SearchIndexEndpointRequest.Builder clearPageToken()
       The continuation token to fetch the next page. If empty, it means it is
 fetching the first page.
      string page_token = 6;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public SearchIndexEndpointRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       The continuation token to fetch the next page. If empty, it means it is
 fetching the first page.
      string page_token = 6;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.