Package com.google.cloud.visionai.v1

Class SearchIndexEndpointRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.SearchIndexEndpointRequest
All Implemented Interfaces:
SearchIndexEndpointRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchIndexEndpointRequest extends com.google.protobuf.GeneratedMessage implements SearchIndexEndpointRequestOrBuilder
 Request message for SearchIndexEndpoint.
Protobuf type google.cloud.visionai.v1.SearchIndexEndpointRequest
See Also:

  • Field Details

    • IMAGE_QUERY_FIELD_NUMBER

      public static final int IMAGE_QUERY_FIELD_NUMBER
      See Also:

    • TEXT_QUERY_FIELD_NUMBER

      public static final int TEXT_QUERY_FIELD_NUMBER
      See Also:

    • INDEX_ENDPOINT_FIELD_NUMBER

      public static final int INDEX_ENDPOINT_FIELD_NUMBER
      See Also:

    • CRITERIA_FIELD_NUMBER

      public static final int CRITERIA_FIELD_NUMBER
      See Also:

    • EXCLUSION_CRITERIA_FIELD_NUMBER

      public static final int EXCLUSION_CRITERIA_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

  • 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

    • getQueryCase

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

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

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

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

    • getCriteriaList

      public List<Criteria> getCriteriaList()
       Criteria applied to search results.
      repeated .google.cloud.visionai.v1.Criteria criteria = 4;
      Specified by:
      getCriteriaList 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

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

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

    • 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 SearchIndexEndpointRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SearchIndexEndpointRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SearchIndexEndpointRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchIndexEndpointRequest.Builder newBuilder()

    • newBuilder

      public static SearchIndexEndpointRequest.Builder newBuilder(SearchIndexEndpointRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchIndexEndpointRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchIndexEndpointRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchIndexEndpointRequest> 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 SearchIndexEndpointRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder