Class SearchIndexEndpointRequest (0.20.0)
Version 0.20.0keyboard_arrow_down
public final class SearchIndexEndpointRequest extends GeneratedMessageV3 implements SearchIndexEndpointRequestOrBuilder
Request message for SearchIndexEndpoint.
Protobuf type google.cloud.visionai.v1.SearchIndexEndpointRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CRITERIA_FIELD_NUMBER
public static final int CRITERIA_FIELD_NUMBER
Field Value
Type Description
int
EXCLUSION_CRITERIA_FIELD_NUMBER
public static final int EXCLUSION_CRITERIA_FIELD_NUMBER
Field Value
Type Description
int
IMAGE_QUERY_FIELD_NUMBER
public static final int IMAGE_QUERY_FIELD_NUMBER
Field Value
Type Description
int
INDEX_ENDPOINT_FIELD_NUMBER
public static final int INDEX_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int
TEXT_QUERY_FIELD_NUMBER
public static final int TEXT_QUERY_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static SearchIndexEndpointRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchIndexEndpointRequest . Builder newBuilder ()
newBuilder(SearchIndexEndpointRequest prototype)
public static SearchIndexEndpointRequest . Builder newBuilder ( SearchIndexEndpointRequest prototype )
public static SearchIndexEndpointRequest parseDelimitedFrom ( InputStream input )
public static SearchIndexEndpointRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchIndexEndpointRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchIndexEndpointRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchIndexEndpointRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchIndexEndpointRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SearchIndexEndpointRequest parseFrom ( CodedInputStream input )
public static SearchIndexEndpointRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchIndexEndpointRequest parseFrom ( InputStream input )
public static SearchIndexEndpointRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchIndexEndpointRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchIndexEndpointRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchIndexEndpointRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getCriteria(int index)
public Criteria getCriteria ( int index )
Criteria applied to search results.
repeated .google.cloud.visionai.v1.Criteria criteria = 4;
Parameter
Name Description
indexint
getCriteriaCount()
public int getCriteriaCount ()
Criteria applied to search results.
repeated .google.cloud.visionai.v1.Criteria criteria = 4;
Returns
Type Description
int
getCriteriaList()
public List<Criteria> getCriteriaList ()
Criteria applied to search results.
repeated .google.cloud.visionai.v1.Criteria criteria = 4;
getCriteriaOrBuilder(int index)
public CriteriaOrBuilder getCriteriaOrBuilder ( int index )
Criteria applied to search results.
repeated .google.cloud.visionai.v1.Criteria criteria = 4;
Parameter
Name Description
indexint
getCriteriaOrBuilderList()
public List <? extends CriteriaOrBuilder > getCriteriaOrBuilderList ()
Criteria applied to search results.
repeated .google.cloud.visionai.v1.Criteria criteria = 4;
Returns
Type Description
List <? extends com.google.cloud.visionai.v1.CriteriaOrBuilder >
getDefaultInstanceForType()
public SearchIndexEndpointRequest getDefaultInstanceForType ()
getExclusionCriteria(int index)
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;
Parameter
Name Description
indexint
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;
Returns
Type Description
int
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;
getExclusionCriteriaOrBuilder(int index)
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;
Parameter
Name Description
indexint
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;
Returns
Type Description
List <? extends com.google.cloud.visionai.v1.CriteriaOrBuilder >
getImageQuery()
public ImageQuery getImageQuery ()
An image-only query.
.google.cloud.visionai.v1.ImageQuery image_query = 2;
Returns
Type Description
ImageQuery The imageQuery.
getImageQueryOrBuilder()
public ImageQueryOrBuilder getImageQueryOrBuilder ()
An image-only query.
.google.cloud.visionai.v1.ImageQuery image_query = 2;
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) = { ... }
Returns
Type Description
String The indexEndpoint.
getIndexEndpointBytes()
public 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) = { ... }
Returns
Type Description
ByteString The bytes for indexEndpoint.
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 100.
int32 page_size = 5;
Returns
Type Description
int 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;
Returns
Type Description
String The pageToken.
getPageTokenBytes()
public ByteString getPageTokenBytes ()
The continuation token to fetch the next page. If empty, it means it is
fetching the first page.
string page_token = 6;
Returns
Type Description
ByteString The bytes for pageToken.
getParserForType()
public Parser<SearchIndexEndpointRequest> getParserForType ()
Overrides
getQueryCase()
public SearchIndexEndpointRequest . QueryCase getQueryCase ()
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getTextQuery()
public String getTextQuery ()
A text-only query.
string text_query = 3;
Returns
Type Description
String The textQuery.
getTextQueryBytes()
public ByteString getTextQueryBytes ()
A text-only query.
string text_query = 3;
Returns
Type Description
ByteString The bytes for textQuery.
hasImageQuery()
public boolean hasImageQuery ()
An image-only query.
.google.cloud.visionai.v1.ImageQuery image_query = 2;
Returns
Type Description
boolean Whether the imageQuery field is set.
hasTextQuery()
public boolean hasTextQuery ()
A text-only query.
string text_query = 3;
Returns
Type Description
boolean Whether the textQuery field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchIndexEndpointRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchIndexEndpointRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public SearchIndexEndpointRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
