Interface SearchAssetsRequestOrBuilder (0.12.0) 

public interface SearchAssetsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContentTimeRanges()

public abstract DateTimeRangeArray getContentTimeRanges()

Time ranges that matching video content must fall within. If no ranges are provided, there will be no time restriction. This field is treated just like the criteria below, but defined separately for convenience as it is used frequently. Note that if the end_time is in the future, it will be clamped to the time the request was received.

.google.cloud.visionai.v1.DateTimeRangeArray content_time_ranges = 5;

Returns
Type Description
DateTimeRangeArray

The contentTimeRanges.

getContentTimeRangesOrBuilder()

public abstract DateTimeRangeArrayOrBuilder getContentTimeRangesOrBuilder()

Time ranges that matching video content must fall within. If no ranges are provided, there will be no time restriction. This field is treated just like the criteria below, but defined separately for convenience as it is used frequently. Note that if the end_time is in the future, it will be clamped to the time the request was received.

.google.cloud.visionai.v1.DateTimeRangeArray content_time_ranges = 5;

Returns
Type Description
DateTimeRangeArrayOrBuilder

getCorpus()

public abstract String getCorpus()

Required. The parent corpus to search. Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}'

string corpus = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The corpus.

getCorpusBytes()

public abstract ByteString getCorpusBytes()

Required. The parent corpus to search. Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}'

string corpus = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for corpus.

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>

getFacetSelections(int index)

public abstract FacetGroup getFacetSelections(int index)

Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria.

repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;

Parameter
Name Description
index int
Returns
Type Description
FacetGroup

getFacetSelectionsCount()

public abstract int getFacetSelectionsCount()

Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria.

repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;

Returns
Type Description
int

getFacetSelectionsList()

public abstract List<FacetGroup> getFacetSelectionsList()

Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria.

repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;

Returns
Type Description
List<FacetGroup>

getFacetSelectionsOrBuilder(int index)

public abstract FacetGroupOrBuilder getFacetSelectionsOrBuilder(int index)

Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria.

repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;

Parameter
Name Description
index int
Returns
Type Description
FacetGroupOrBuilder

getFacetSelectionsOrBuilderList()

public abstract List<? extends FacetGroupOrBuilder> getFacetSelectionsOrBuilderList()

Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria.

repeated .google.cloud.visionai.v1.FacetGroup facet_selections = 6;

Returns
Type Description
List<? extends com.google.cloud.visionai.v1.FacetGroupOrBuilder>

getPageSize()

public abstract int getPageSize()

The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size.

int32 page_size = 2;

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 = 3;

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 = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getResultAnnotationKeys(int index)

public abstract String getResultAnnotationKeys(int index)

A list of annotation keys to specify the annotations to be retrieved and returned with each search result. Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search strategy must not be NO_SEARCH.

repeated string result_annotation_keys = 8;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The resultAnnotationKeys at the given index.

getResultAnnotationKeysBytes(int index)

public abstract ByteString getResultAnnotationKeysBytes(int index)

A list of annotation keys to specify the annotations to be retrieved and returned with each search result. Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search strategy must not be NO_SEARCH.

repeated string result_annotation_keys = 8;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the resultAnnotationKeys at the given index.

getResultAnnotationKeysCount()

public abstract int getResultAnnotationKeysCount()

A list of annotation keys to specify the annotations to be retrieved and returned with each search result. Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search strategy must not be NO_SEARCH.

repeated string result_annotation_keys = 8;

Returns
Type Description
int

The count of resultAnnotationKeys.

getResultAnnotationKeysList()

public abstract List<String> getResultAnnotationKeysList()

A list of annotation keys to specify the annotations to be retrieved and returned with each search result. Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search strategy must not be NO_SEARCH.

repeated string result_annotation_keys = 8;

Returns
Type Description
List<String>

A list containing the resultAnnotationKeys.

getSchemaKeySortingStrategy()

public abstract SchemaKeySortingStrategy getSchemaKeySortingStrategy()

Sort by the value under the data schema key.

.google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;

Returns
Type Description
SchemaKeySortingStrategy

The schemaKeySortingStrategy.

getSchemaKeySortingStrategyOrBuilder()

public abstract SchemaKeySortingStrategyOrBuilder getSchemaKeySortingStrategyOrBuilder()

Sort by the value under the data schema key.

.google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;

Returns
Type Description
SchemaKeySortingStrategyOrBuilder

getSearchQuery()

public abstract String getSearchQuery()

Global search query. Allows user to search assets without needing to specify which field the value belongs to.

string search_query = 10;

Returns
Type Description
String

The searchQuery.

getSearchQueryBytes()

public abstract ByteString getSearchQueryBytes()

Global search query. Allows user to search assets without needing to specify which field the value belongs to.

string search_query = 10;

Returns
Type Description
ByteString

The bytes for searchQuery.

getSortSpecCase()

public abstract SearchAssetsRequest.SortSpecCase getSortSpecCase()
Returns
Type Description
SearchAssetsRequest.SortSpecCase

hasContentTimeRanges()

public abstract boolean hasContentTimeRanges()

Time ranges that matching video content must fall within. If no ranges are provided, there will be no time restriction. This field is treated just like the criteria below, but defined separately for convenience as it is used frequently. Note that if the end_time is in the future, it will be clamped to the time the request was received.

.google.cloud.visionai.v1.DateTimeRangeArray content_time_ranges = 5;

Returns
Type Description
boolean

Whether the contentTimeRanges field is set.

hasSchemaKeySortingStrategy()

public abstract boolean hasSchemaKeySortingStrategy()

Sort by the value under the data schema key.

.google.cloud.visionai.v1.SchemaKeySortingStrategy schema_key_sorting_strategy = 9;

Returns
Type Description
boolean

Whether the schemaKeySortingStrategy field is set.