com.google.cloud.visionai.v1.SearchIndexEndpointRequestOrBuilder Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/visionai/v1/warehouse.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.visionai.v1;
public interface SearchIndexEndpointRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.SearchIndexEndpointRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* An image-only query.
*
*
* .google.cloud.visionai.v1.ImageQuery image_query = 2;
*
* @return Whether the imageQuery field is set.
*/
boolean hasImageQuery();
/**
*
*
*
* An image-only query.
*
*
* .google.cloud.visionai.v1.ImageQuery image_query = 2;
*
* @return The imageQuery.
*/
com.google.cloud.visionai.v1.ImageQuery getImageQuery();
/**
*
*
*
* An image-only query.
*
*
* .google.cloud.visionai.v1.ImageQuery image_query = 2;
*/
com.google.cloud.visionai.v1.ImageQueryOrBuilder getImageQueryOrBuilder();
/**
*
*
*
* A text-only query.
*
*
* string text_query = 3;
*
* @return Whether the textQuery field is set.
*/
boolean hasTextQuery();
/**
*
*
*
* A text-only query.
*
*
* string text_query = 3;
*
* @return The textQuery.
*/
java.lang.String getTextQuery();
/**
*
*
*
* A text-only query.
*
*
* string text_query = 3;
*
* @return The bytes for textQuery.
*/
com.google.protobuf.ByteString getTextQueryBytes();
/**
*
*
*
* 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) = { ... }
*
*
* @return The indexEndpoint.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for indexEndpoint.
*/
com.google.protobuf.ByteString getIndexEndpointBytes();
/**
*
*
*
* Criteria applied to search results.
*
*
* repeated .google.cloud.visionai.v1.Criteria criteria = 4;
*/
java.util.List getCriteriaList();
/**
*
*
*
* Criteria applied to search results.
*
*
* repeated .google.cloud.visionai.v1.Criteria criteria = 4;
*/
com.google.cloud.visionai.v1.Criteria getCriteria(int index);
/**
*
*
*
* Criteria applied to search results.
*
*
* repeated .google.cloud.visionai.v1.Criteria criteria = 4;
*/
int getCriteriaCount();
/**
*
*
*
* Criteria applied to search results.
*
*
* repeated .google.cloud.visionai.v1.Criteria criteria = 4;
*/
java.util.List
getCriteriaOrBuilderList();
/**
*
*
*
* Criteria applied to search results.
*
*
* repeated .google.cloud.visionai.v1.Criteria criteria = 4;
*/
com.google.cloud.visionai.v1.CriteriaOrBuilder getCriteriaOrBuilder(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;
*/
java.util.List getExclusionCriteriaList();
/**
*
*
*
* Criteria to exclude from search results.
* Note that `fetch_matched_annotations` will be ignored.
*
*
* repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;
*/
com.google.cloud.visionai.v1.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;
*/
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;
*/
java.util.List
getExclusionCriteriaOrBuilderList();
/**
*
*
*
* Criteria to exclude from search results.
* Note that `fetch_matched_annotations` will be ignored.
*
*
* repeated .google.cloud.visionai.v1.Criteria exclusion_criteria = 7;
*/
com.google.cloud.visionai.v1.CriteriaOrBuilder getExclusionCriteriaOrBuilder(int index);
/**
*
*
*
* 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 100.
*
*
* int32 page_size = 5;
*
* @return The pageSize.
*/
int getPageSize();
/**
*
*
*
* The continuation token to fetch the next page. If empty, it means it is
* fetching the first page.
*
*
* string page_token = 6;
*
* @return The pageToken.
*/
java.lang.String getPageToken();
/**
*
*
*
* The continuation token to fetch the next page. If empty, it means it is
* fetching the first page.
*
*
* string page_token = 6;
*
* @return The bytes for pageToken.
*/
com.google.protobuf.ByteString getPageTokenBytes();
com.google.cloud.visionai.v1.SearchIndexEndpointRequest.QueryCase getQueryCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy