Class SearchIndexEndpointRequest (0.8.0)

public final class SearchIndexEndpointRequest extends GeneratedMessageV3 implements SearchIndexEndpointRequestOrBuilder

Request message for SearchIndexEndpoint.

Protobuf type google.cloud.visionai.v1.SearchIndexEndpointRequest

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()
Returns
Type Description
SearchIndexEndpointRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchIndexEndpointRequest.Builder newBuilder()
Returns
Type Description
SearchIndexEndpointRequest.Builder

newBuilder(SearchIndexEndpointRequest prototype)

public static SearchIndexEndpointRequest.Builder newBuilder(SearchIndexEndpointRequest prototype)
Parameter
Name Description
prototype SearchIndexEndpointRequest
Returns
Type Description
SearchIndexEndpointRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchIndexEndpointRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchIndexEndpointRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchIndexEndpointRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchIndexEndpointRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchIndexEndpointRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchIndexEndpointRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchIndexEndpointRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchIndexEndpointRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchIndexEndpointRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchIndexEndpointRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchIndexEndpointRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchIndexEndpointRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchIndexEndpointRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchIndexEndpointRequest> parser()
Returns
Type Description
Parser<SearchIndexEndpointRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
index int
Returns
Type Description
Criteria

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;

Returns
Type Description
List<Criteria>

getCriteriaOrBuilder(int index)

public CriteriaOrBuilder getCriteriaOrBuilder(int index)

Criteria applied to search results.

repeated .google.cloud.visionai.v1.Criteria criteria = 4;

Parameter
Name Description
index int
Returns
Type Description
CriteriaOrBuilder

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()
Returns
Type Description
SearchIndexEndpointRequest

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
index int
Returns
Type Description
Criteria

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;

Returns
Type Description
List<Criteria>

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
index int
Returns
Type Description
CriteriaOrBuilder

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;

Returns
Type Description
ImageQueryOrBuilder

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()

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 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()
Returns
Type Description
Parser<SearchIndexEndpointRequest>
Overrides

getQueryCase()

public SearchIndexEndpointRequest.QueryCase getQueryCase()
Returns
Type Description
SearchIndexEndpointRequest.QueryCase

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchIndexEndpointRequest.Builder newBuilderForType()
Returns
Type Description
SearchIndexEndpointRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchIndexEndpointRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchIndexEndpointRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchIndexEndpointRequest.Builder toBuilder()
Returns
Type Description
SearchIndexEndpointRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException