Interface SearchIndexEndpointRequestOrBuilder (0.33.0)

public interface SearchIndexEndpointRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCriteria(int index)

public abstract 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 abstract int getCriteriaCount()

Criteria applied to search results.

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

Returns
Type	Description
`int`

getCriteriaList()

public abstract 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 abstract 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 abstract 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>`

getExclusionCriteria(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ImageQuery getImageQuery()

An image-only query.

.google.cloud.visionai.v1.ImageQuery image_query = 2;

Returns
Type	Description
`ImageQuery`	The imageQuery.

getImageQueryOrBuilder()

public abstract ImageQueryOrBuilder getImageQueryOrBuilder()

An image-only query.

.google.cloud.visionai.v1.ImageQuery image_query = 2;

Returns
Type	Description
`ImageQueryOrBuilder`

getIndexEndpoint()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getQueryCase()

public abstract SearchIndexEndpointRequest.QueryCase getQueryCase()

Returns
Type	Description
`SearchIndexEndpointRequest.QueryCase`

getTextQuery()

public abstract String getTextQuery()

A text-only query.

string text_query = 3;

Returns
Type	Description
`String`	The textQuery.

getTextQueryBytes()

public abstract ByteString getTextQueryBytes()

A text-only query.

string text_query = 3;

Returns
Type	Description
`ByteString`	The bytes for textQuery.

hasImageQuery()

public abstract 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 abstract boolean hasTextQuery()

A text-only query.

string text_query = 3;

Returns
Type	Description
`boolean`	Whether the textQuery field is set.