Class SearchAssetsRequest.Builder (0.1.0)

public static final class SearchAssetsRequest.Builder extends GeneratedMessageV3.Builder<SearchAssetsRequest.Builder> implements SearchAssetsRequestOrBuilder

Request message for SearchAssets.

Protobuf type google.cloud.visionai.v1.SearchAssetsRequest

Static Methods

getDescriptor()

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

Methods

addAllCriteria(Iterable<? extends Criteria> values)

public SearchAssetsRequest.Builder addAllCriteria(Iterable<? extends Criteria> values)

Criteria applied to search results.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.visionai.v1.Criteria>
Returns
Type Description
SearchAssetsRequest.Builder

addAllFacetSelections(Iterable<? extends FacetGroup> values)

public SearchAssetsRequest.Builder addAllFacetSelections(Iterable<? extends FacetGroup> values)

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
values Iterable<? extends com.google.cloud.visionai.v1.FacetGroup>
Returns
Type Description
SearchAssetsRequest.Builder

addAllResultAnnotationKeys(Iterable<String> values)

public SearchAssetsRequest.Builder addAllResultAnnotationKeys(Iterable<String> values)

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
values Iterable<String>

The resultAnnotationKeys to add.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

addCriteria(Criteria value)

public SearchAssetsRequest.Builder addCriteria(Criteria value)

Criteria applied to search results.

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

Parameter
Name Description
value Criteria
Returns
Type Description
SearchAssetsRequest.Builder

addCriteria(Criteria.Builder builderForValue)

public SearchAssetsRequest.Builder addCriteria(Criteria.Builder builderForValue)

Criteria applied to search results.

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

Parameter
Name Description
builderForValue Criteria.Builder
Returns
Type Description
SearchAssetsRequest.Builder

addCriteria(int index, Criteria value)

public SearchAssetsRequest.Builder addCriteria(int index, Criteria value)

Criteria applied to search results.

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

Parameters
Name Description
index int
value Criteria
Returns
Type Description
SearchAssetsRequest.Builder

addCriteria(int index, Criteria.Builder builderForValue)

public SearchAssetsRequest.Builder addCriteria(int index, Criteria.Builder builderForValue)

Criteria applied to search results.

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

Parameters
Name Description
index int
builderForValue Criteria.Builder
Returns
Type Description
SearchAssetsRequest.Builder

addCriteriaBuilder()

public Criteria.Builder addCriteriaBuilder()

Criteria applied to search results.

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

Returns
Type Description
Criteria.Builder

addCriteriaBuilder(int index)

public Criteria.Builder addCriteriaBuilder(int index)

Criteria applied to search results.

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

Parameter
Name Description
index int
Returns
Type Description
Criteria.Builder

addFacetSelections(FacetGroup value)

public SearchAssetsRequest.Builder addFacetSelections(FacetGroup value)

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
value FacetGroup
Returns
Type Description
SearchAssetsRequest.Builder

addFacetSelections(FacetGroup.Builder builderForValue)

public SearchAssetsRequest.Builder addFacetSelections(FacetGroup.Builder builderForValue)

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
builderForValue FacetGroup.Builder
Returns
Type Description
SearchAssetsRequest.Builder

addFacetSelections(int index, FacetGroup value)

public SearchAssetsRequest.Builder addFacetSelections(int index, FacetGroup value)

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;

Parameters
Name Description
index int
value FacetGroup
Returns
Type Description
SearchAssetsRequest.Builder

addFacetSelections(int index, FacetGroup.Builder builderForValue)

public SearchAssetsRequest.Builder addFacetSelections(int index, FacetGroup.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue FacetGroup.Builder
Returns
Type Description
SearchAssetsRequest.Builder

addFacetSelectionsBuilder()

public FacetGroup.Builder addFacetSelectionsBuilder()

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
FacetGroup.Builder

addFacetSelectionsBuilder(int index)

public FacetGroup.Builder addFacetSelectionsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchAssetsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

addResultAnnotationKeys(String value)

public SearchAssetsRequest.Builder addResultAnnotationKeys(String value)

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
value String

The resultAnnotationKeys to add.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

addResultAnnotationKeysBytes(ByteString value)

public SearchAssetsRequest.Builder addResultAnnotationKeysBytes(ByteString value)

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
value ByteString

The bytes of the resultAnnotationKeys to add.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

build()

public SearchAssetsRequest build()
Returns
Type Description
SearchAssetsRequest

buildPartial()

public SearchAssetsRequest buildPartial()
Returns
Type Description
SearchAssetsRequest

clear()

public SearchAssetsRequest.Builder clear()
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

clearContentTimeRanges()

public SearchAssetsRequest.Builder clearContentTimeRanges()

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
SearchAssetsRequest.Builder

clearCorpus()

public SearchAssetsRequest.Builder clearCorpus()

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
SearchAssetsRequest.Builder

This builder for chaining.

clearCriteria()

public SearchAssetsRequest.Builder clearCriteria()

Criteria applied to search results.

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

Returns
Type Description
SearchAssetsRequest.Builder

clearFacetSelections()

public SearchAssetsRequest.Builder clearFacetSelections()

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
SearchAssetsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public SearchAssetsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchAssetsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

clearPageSize()

public SearchAssetsRequest.Builder clearPageSize()

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
SearchAssetsRequest.Builder

This builder for chaining.

clearPageToken()

public SearchAssetsRequest.Builder clearPageToken()

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
SearchAssetsRequest.Builder

This builder for chaining.

clearResultAnnotationKeys()

public SearchAssetsRequest.Builder clearResultAnnotationKeys()

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
SearchAssetsRequest.Builder

This builder for chaining.

clearSchemaKeySortingStrategy()

public SearchAssetsRequest.Builder clearSchemaKeySortingStrategy()

Sort by the value under the data schema key.

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

Returns
Type Description
SearchAssetsRequest.Builder

clearSearchQuery()

public SearchAssetsRequest.Builder clearSearchQuery()

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
SearchAssetsRequest.Builder

This builder for chaining.

clearSortSpec()

public SearchAssetsRequest.Builder clearSortSpec()
Returns
Type Description
SearchAssetsRequest.Builder

clone()

public SearchAssetsRequest.Builder clone()
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

getContentTimeRanges()

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

getContentTimeRangesBuilder()

public DateTimeRangeArray.Builder getContentTimeRangesBuilder()

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.Builder

getContentTimeRangesOrBuilder()

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

getCriteriaBuilder(int index)

public Criteria.Builder getCriteriaBuilder(int index)

Criteria applied to search results.

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

Parameter
Name Description
index int
Returns
Type Description
Criteria.Builder

getCriteriaBuilderList()

public List<Criteria.Builder> getCriteriaBuilderList()

Criteria applied to search results.

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

Returns
Type Description
List<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFacetSelections(int index)

public 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

getFacetSelectionsBuilder(int index)

public FacetGroup.Builder getFacetSelectionsBuilder(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.Builder

getFacetSelectionsBuilderList()

public List<FacetGroup.Builder> getFacetSelectionsBuilderList()

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<Builder>

getFacetSelectionsCount()

public 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 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 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 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the resultAnnotationKeys.

getSchemaKeySortingStrategy()

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

getSchemaKeySortingStrategyBuilder()

public SchemaKeySortingStrategy.Builder getSchemaKeySortingStrategyBuilder()

Sort by the value under the data schema key.

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

Returns
Type Description
SchemaKeySortingStrategy.Builder

getSchemaKeySortingStrategyOrBuilder()

public 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 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 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 SearchAssetsRequest.SortSpecCase getSortSpecCase()
Returns
Type Description
SearchAssetsRequest.SortSpecCase

hasContentTimeRanges()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeContentTimeRanges(DateTimeRangeArray value)

public SearchAssetsRequest.Builder mergeContentTimeRanges(DateTimeRangeArray value)

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;

Parameter
Name Description
value DateTimeRangeArray
Returns
Type Description
SearchAssetsRequest.Builder

mergeFrom(SearchAssetsRequest other)

public SearchAssetsRequest.Builder mergeFrom(SearchAssetsRequest other)
Parameter
Name Description
other SearchAssetsRequest
Returns
Type Description
SearchAssetsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchAssetsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchAssetsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchAssetsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

mergeSchemaKeySortingStrategy(SchemaKeySortingStrategy value)

public SearchAssetsRequest.Builder mergeSchemaKeySortingStrategy(SchemaKeySortingStrategy value)

Sort by the value under the data schema key.

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

Parameter
Name Description
value SchemaKeySortingStrategy
Returns
Type Description
SearchAssetsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchAssetsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

removeCriteria(int index)

public SearchAssetsRequest.Builder removeCriteria(int index)

Criteria applied to search results.

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

Parameter
Name Description
index int
Returns
Type Description
SearchAssetsRequest.Builder

removeFacetSelections(int index)

public SearchAssetsRequest.Builder removeFacetSelections(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
SearchAssetsRequest.Builder

setContentTimeRanges(DateTimeRangeArray value)

public SearchAssetsRequest.Builder setContentTimeRanges(DateTimeRangeArray value)

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;

Parameter
Name Description
value DateTimeRangeArray
Returns
Type Description
SearchAssetsRequest.Builder

setContentTimeRanges(DateTimeRangeArray.Builder builderForValue)

public SearchAssetsRequest.Builder setContentTimeRanges(DateTimeRangeArray.Builder builderForValue)

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;

Parameter
Name Description
builderForValue DateTimeRangeArray.Builder
Returns
Type Description
SearchAssetsRequest.Builder

setCorpus(String value)

public SearchAssetsRequest.Builder setCorpus(String value)

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) = { ... }

Parameter
Name Description
value String

The corpus to set.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

setCorpusBytes(ByteString value)

public SearchAssetsRequest.Builder setCorpusBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for corpus to set.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

setCriteria(int index, Criteria value)

public SearchAssetsRequest.Builder setCriteria(int index, Criteria value)

Criteria applied to search results.

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

Parameters
Name Description
index int
value Criteria
Returns
Type Description
SearchAssetsRequest.Builder

setCriteria(int index, Criteria.Builder builderForValue)

public SearchAssetsRequest.Builder setCriteria(int index, Criteria.Builder builderForValue)

Criteria applied to search results.

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

Parameters
Name Description
index int
builderForValue Criteria.Builder
Returns
Type Description
SearchAssetsRequest.Builder

setFacetSelections(int index, FacetGroup value)

public SearchAssetsRequest.Builder setFacetSelections(int index, FacetGroup value)

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;

Parameters
Name Description
index int
value FacetGroup
Returns
Type Description
SearchAssetsRequest.Builder

setFacetSelections(int index, FacetGroup.Builder builderForValue)

public SearchAssetsRequest.Builder setFacetSelections(int index, FacetGroup.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue FacetGroup.Builder
Returns
Type Description
SearchAssetsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchAssetsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

setPageSize(int value)

public SearchAssetsRequest.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchAssetsRequest.Builder setPageToken(String value)

The continuation token to fetch the next page. If empty, it means it is fetching the first page.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchAssetsRequest.Builder setPageTokenBytes(ByteString value)

The continuation token to fetch the next page. If empty, it means it is fetching the first page.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchAssetsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchAssetsRequest.Builder
Overrides

setResultAnnotationKeys(int index, String value)

public SearchAssetsRequest.Builder setResultAnnotationKeys(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The resultAnnotationKeys to set.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

setSchemaKeySortingStrategy(SchemaKeySortingStrategy value)

public SearchAssetsRequest.Builder setSchemaKeySortingStrategy(SchemaKeySortingStrategy value)

Sort by the value under the data schema key.

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

Parameter
Name Description
value SchemaKeySortingStrategy
Returns
Type Description
SearchAssetsRequest.Builder

setSchemaKeySortingStrategy(SchemaKeySortingStrategy.Builder builderForValue)

public SearchAssetsRequest.Builder setSchemaKeySortingStrategy(SchemaKeySortingStrategy.Builder builderForValue)

Sort by the value under the data schema key.

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

Parameter
Name Description
builderForValue SchemaKeySortingStrategy.Builder
Returns
Type Description
SearchAssetsRequest.Builder

setSearchQuery(String value)

public SearchAssetsRequest.Builder setSearchQuery(String value)

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

string search_query = 10;

Parameter
Name Description
value String

The searchQuery to set.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

setSearchQueryBytes(ByteString value)

public SearchAssetsRequest.Builder setSearchQueryBytes(ByteString value)

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

string search_query = 10;

Parameter
Name Description
value ByteString

The bytes for searchQuery to set.

Returns
Type Description
SearchAssetsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchAssetsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchAssetsRequest.Builder
Overrides