Class SearchResultItem.Builder (0.10.0)

Version latest

• 0.10.0 (latest)
• 0.9.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class SearchResultItem.Builder extends GeneratedMessageV3.Builder<SearchResultItem.Builder> implements SearchResultItemOrBuilder

Search result contains asset name and corresponding time ranges.

Protobuf type google.cloud.visionai.v1.SearchResultItem

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResultItem.Builder

Implements

SearchResultItemOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAnnotationMatchingResults(Iterable<? extends AnnotationMatchingResult> values)

public SearchResultItem.Builder addAllAnnotationMatchingResults(Iterable<? extends AnnotationMatchingResult> values)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.visionai.v1.AnnotationMatchingResult>

Returns
Type	Description
SearchResultItem.Builder

addAllRequestedAnnotations(Iterable<? extends Annotation> values)

public SearchResultItem.Builder addAllRequestedAnnotations(Iterable<? extends Annotation> values)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.visionai.v1.Annotation>

Returns
Type	Description
SearchResultItem.Builder

addAllSegments(Iterable<? extends Partition.TemporalPartition> values) (deprecated)

public SearchResultItem.Builder addAllSegments(Iterable<? extends Partition.TemporalPartition> values)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.visionai.v1.Partition.TemporalPartition>

Returns
Type	Description
SearchResultItem.Builder

addAnnotationMatchingResults(AnnotationMatchingResult value)

public SearchResultItem.Builder addAnnotationMatchingResults(AnnotationMatchingResult value)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name	Description
value	AnnotationMatchingResult

Returns
Type	Description
SearchResultItem.Builder

addAnnotationMatchingResults(AnnotationMatchingResult.Builder builderForValue)

public SearchResultItem.Builder addAnnotationMatchingResults(AnnotationMatchingResult.Builder builderForValue)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name	Description
builderForValue	AnnotationMatchingResult.Builder

Returns
Type	Description
SearchResultItem.Builder

addAnnotationMatchingResults(int index, AnnotationMatchingResult value)

public SearchResultItem.Builder addAnnotationMatchingResults(int index, AnnotationMatchingResult value)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameters
Name	Description
index	int
value	AnnotationMatchingResult

Returns
Type	Description
SearchResultItem.Builder

addAnnotationMatchingResults(int index, AnnotationMatchingResult.Builder builderForValue)

public SearchResultItem.Builder addAnnotationMatchingResults(int index, AnnotationMatchingResult.Builder builderForValue)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameters
Name	Description
index	int
builderForValue	AnnotationMatchingResult.Builder

Returns
Type	Description
SearchResultItem.Builder

addAnnotationMatchingResultsBuilder()

public AnnotationMatchingResult.Builder addAnnotationMatchingResultsBuilder()

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Returns
Type	Description
AnnotationMatchingResult.Builder

addAnnotationMatchingResultsBuilder(int index)

public AnnotationMatchingResult.Builder addAnnotationMatchingResultsBuilder(int index)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
AnnotationMatchingResult.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResultItem.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRequestedAnnotations(Annotation value)

public SearchResultItem.Builder addRequestedAnnotations(Annotation value)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name	Description
value	Annotation

Returns
Type	Description
SearchResultItem.Builder

addRequestedAnnotations(Annotation.Builder builderForValue)

public SearchResultItem.Builder addRequestedAnnotations(Annotation.Builder builderForValue)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name	Description
builderForValue	Annotation.Builder

Returns
Type	Description
SearchResultItem.Builder

addRequestedAnnotations(int index, Annotation value)

public SearchResultItem.Builder addRequestedAnnotations(int index, Annotation value)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameters
Name	Description
index	int
value	Annotation

Returns
Type	Description
SearchResultItem.Builder

addRequestedAnnotations(int index, Annotation.Builder builderForValue)

public SearchResultItem.Builder addRequestedAnnotations(int index, Annotation.Builder builderForValue)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameters
Name	Description
index	int
builderForValue	Annotation.Builder

Returns
Type	Description
SearchResultItem.Builder

addRequestedAnnotationsBuilder()

public Annotation.Builder addRequestedAnnotationsBuilder()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Returns
Type	Description
Annotation.Builder

addRequestedAnnotationsBuilder(int index)

public Annotation.Builder addRequestedAnnotationsBuilder(int index)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
Annotation.Builder

addSegments(Partition.TemporalPartition value) (deprecated)

public SearchResultItem.Builder addSegments(Partition.TemporalPartition value)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name	Description
value	Partition.TemporalPartition

Returns
Type	Description
SearchResultItem.Builder

addSegments(Partition.TemporalPartition.Builder builderForValue) (deprecated)

public SearchResultItem.Builder addSegments(Partition.TemporalPartition.Builder builderForValue)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name	Description
builderForValue	Partition.TemporalPartition.Builder

Returns
Type	Description
SearchResultItem.Builder

addSegments(int index, Partition.TemporalPartition value) (deprecated)

public SearchResultItem.Builder addSegments(int index, Partition.TemporalPartition value)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameters
Name	Description
index	int
value	Partition.TemporalPartition

Returns
Type	Description
SearchResultItem.Builder

addSegments(int index, Partition.TemporalPartition.Builder builderForValue) (deprecated)

public SearchResultItem.Builder addSegments(int index, Partition.TemporalPartition.Builder builderForValue)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameters
Name	Description
index	int
builderForValue	Partition.TemporalPartition.Builder

Returns
Type	Description
SearchResultItem.Builder

addSegmentsBuilder() (deprecated)

public Partition.TemporalPartition.Builder addSegmentsBuilder()

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Returns
Type	Description
Partition.TemporalPartition.Builder

addSegmentsBuilder(int index) (deprecated)

public Partition.TemporalPartition.Builder addSegmentsBuilder(int index)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
Partition.TemporalPartition.Builder

build()

public SearchResultItem build()

Returns
Type	Description
SearchResultItem

buildPartial()

public SearchResultItem buildPartial()

Returns
Type	Description
SearchResultItem

clear()

public SearchResultItem.Builder clear()

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAnnotationMatchingResults()

public SearchResultItem.Builder clearAnnotationMatchingResults()

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Returns
Type	Description
SearchResultItem.Builder

clearAsset()

public SearchResultItem.Builder clearAsset()

The resource name of the asset. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

string asset = 1;

Returns
Type	Description
SearchResultItem.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchResultItem.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResultItem.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRelevance()

public SearchResultItem.Builder clearRelevance()

Available to IMAGE corpus types. Relevance of this SearchResultItem to user search query (text query or image query). By default this represents cosine similarity between the query and the retrieved media content. The value is in the range of [-1, 1]. Note that search ranking is not only decided by this relevance score, but also other factors such as the match of annotations.

double relevance = 6;

Returns
Type	Description
SearchResultItem.Builder	This builder for chaining.

clearRequestedAnnotations()

public SearchResultItem.Builder clearRequestedAnnotations()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Returns
Type	Description
SearchResultItem.Builder

clearSegment()

public SearchResultItem.Builder clearSegment()

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Returns
Type	Description
SearchResultItem.Builder

clearSegments() (deprecated)

public SearchResultItem.Builder clearSegments()

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Returns
Type	Description
SearchResultItem.Builder

clone()

public SearchResultItem.Builder clone()

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAnnotationMatchingResults(int index)

public AnnotationMatchingResult getAnnotationMatchingResults(int index)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
AnnotationMatchingResult

getAnnotationMatchingResultsBuilder(int index)

public AnnotationMatchingResult.Builder getAnnotationMatchingResultsBuilder(int index)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
AnnotationMatchingResult.Builder

getAnnotationMatchingResultsBuilderList()

public List<AnnotationMatchingResult.Builder> getAnnotationMatchingResultsBuilderList()

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Returns
Type	Description
List<Builder>

getAnnotationMatchingResultsCount()

public int getAnnotationMatchingResultsCount()

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Returns
Type	Description
int

getAnnotationMatchingResultsList()

public List<AnnotationMatchingResult> getAnnotationMatchingResultsList()

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Returns
Type	Description
List<AnnotationMatchingResult>

getAnnotationMatchingResultsOrBuilder(int index)

public AnnotationMatchingResultOrBuilder getAnnotationMatchingResultsOrBuilder(int index)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
AnnotationMatchingResultOrBuilder

getAnnotationMatchingResultsOrBuilderList()

public List<? extends AnnotationMatchingResultOrBuilder> getAnnotationMatchingResultsOrBuilderList()

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

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

getAsset()

public String getAsset()

The resource name of the asset. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

string asset = 1;

Returns
Type	Description
String	The asset.

getAssetBytes()

public ByteString getAssetBytes()

The resource name of the asset. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

string asset = 1;

Returns
Type	Description
ByteString	The bytes for asset.

getDefaultInstanceForType()

public SearchResultItem getDefaultInstanceForType()

Returns
Type	Description
SearchResultItem

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getRelevance()

public double getRelevance()

Available to IMAGE corpus types. Relevance of this SearchResultItem to user search query (text query or image query). By default this represents cosine similarity between the query and the retrieved media content. The value is in the range of [-1, 1]. Note that search ranking is not only decided by this relevance score, but also other factors such as the match of annotations.

double relevance = 6;

Returns
Type	Description
double	The relevance.

getRequestedAnnotations(int index)

public Annotation getRequestedAnnotations(int index)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
Annotation

getRequestedAnnotationsBuilder(int index)

public Annotation.Builder getRequestedAnnotationsBuilder(int index)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
Annotation.Builder

getRequestedAnnotationsBuilderList()

public List<Annotation.Builder> getRequestedAnnotationsBuilderList()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Returns
Type	Description
List<Builder>

getRequestedAnnotationsCount()

public int getRequestedAnnotationsCount()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Returns
Type	Description
int

getRequestedAnnotationsList()

public List<Annotation> getRequestedAnnotationsList()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Returns
Type	Description
List<Annotation>

getRequestedAnnotationsOrBuilder(int index)

public AnnotationOrBuilder getRequestedAnnotationsOrBuilder(int index)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
AnnotationOrBuilder

getRequestedAnnotationsOrBuilderList()

public List<? extends AnnotationOrBuilder> getRequestedAnnotationsOrBuilderList()

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

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

getSegment()

public Partition.TemporalPartition getSegment()

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Returns
Type	Description
Partition.TemporalPartition	The segment.

getSegmentBuilder()

public Partition.TemporalPartition.Builder getSegmentBuilder()

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Returns
Type	Description
Partition.TemporalPartition.Builder

getSegmentOrBuilder()

public Partition.TemporalPartitionOrBuilder getSegmentOrBuilder()

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Returns
Type	Description
Partition.TemporalPartitionOrBuilder

getSegments(int index) (deprecated)

public Partition.TemporalPartition getSegments(int index)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
Partition.TemporalPartition

getSegmentsBuilder(int index) (deprecated)

public Partition.TemporalPartition.Builder getSegmentsBuilder(int index)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
Partition.TemporalPartition.Builder

getSegmentsBuilderList() (deprecated)

public List<Partition.TemporalPartition.Builder> getSegmentsBuilderList()

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Returns
Type	Description
List<Builder>

getSegmentsCount() (deprecated)

public int getSegmentsCount()

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Returns
Type	Description
int

getSegmentsList() (deprecated)

public List<Partition.TemporalPartition> getSegmentsList()

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Returns
Type	Description
List<TemporalPartition>

getSegmentsOrBuilder(int index) (deprecated)

public Partition.TemporalPartitionOrBuilder getSegmentsOrBuilder(int index)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
Partition.TemporalPartitionOrBuilder

getSegmentsOrBuilderList() (deprecated)

public List<? extends Partition.TemporalPartitionOrBuilder> getSegmentsOrBuilderList()

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

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

hasSegment()

public boolean hasSegment()

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Returns
Type	Description
boolean	Whether the segment field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchResultItem other)

public SearchResultItem.Builder mergeFrom(SearchResultItem other)

Parameter
Name	Description
other	SearchResultItem

Returns
Type	Description
SearchResultItem.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResultItem.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResultItem.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchResultItem.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchResultItem.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSegment(Partition.TemporalPartition value)

public SearchResultItem.Builder mergeSegment(Partition.TemporalPartition value)

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Parameter
Name	Description
value	Partition.TemporalPartition

Returns
Type	Description
SearchResultItem.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResultItem.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeAnnotationMatchingResults(int index)

public SearchResultItem.Builder removeAnnotationMatchingResults(int index)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResultItem.Builder

removeRequestedAnnotations(int index)

public SearchResultItem.Builder removeRequestedAnnotations(int index)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResultItem.Builder

removeSegments(int index) (deprecated)

public SearchResultItem.Builder removeSegments(int index)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResultItem.Builder

setAnnotationMatchingResults(int index, AnnotationMatchingResult value)

public SearchResultItem.Builder setAnnotationMatchingResults(int index, AnnotationMatchingResult value)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameters
Name	Description
index	int
value	AnnotationMatchingResult

Returns
Type	Description
SearchResultItem.Builder

setAnnotationMatchingResults(int index, AnnotationMatchingResult.Builder builderForValue)

public SearchResultItem.Builder setAnnotationMatchingResults(int index, AnnotationMatchingResult.Builder builderForValue)

Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true.

repeated .google.cloud.visionai.v1.AnnotationMatchingResult annotation_matching_results = 4;

Parameters
Name	Description
index	int
builderForValue	AnnotationMatchingResult.Builder

Returns
Type	Description
SearchResultItem.Builder

setAsset(String value)

public SearchResultItem.Builder setAsset(String value)

The resource name of the asset. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

string asset = 1;

Parameter
Name	Description
value	String The asset to set.

Returns
Type	Description
SearchResultItem.Builder	This builder for chaining.

setAssetBytes(ByteString value)

public SearchResultItem.Builder setAssetBytes(ByteString value)

The resource name of the asset. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

string asset = 1;

Parameter
Name	Description
value	ByteString The bytes for asset to set.

Returns
Type	Description
SearchResultItem.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResultItem.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRelevance(double value)

public SearchResultItem.Builder setRelevance(double value)

Available to IMAGE corpus types. Relevance of this SearchResultItem to user search query (text query or image query). By default this represents cosine similarity between the query and the retrieved media content. The value is in the range of [-1, 1]. Note that search ranking is not only decided by this relevance score, but also other factors such as the match of annotations.

double relevance = 6;

Parameter
Name	Description
value	double The relevance to set.

Returns
Type	Description
SearchResultItem.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequestedAnnotations(int index, Annotation value)

public SearchResultItem.Builder setRequestedAnnotations(int index, Annotation value)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameters
Name	Description
index	int
value	Annotation

Returns
Type	Description
SearchResultItem.Builder

setRequestedAnnotations(int index, Annotation.Builder builderForValue)

public SearchResultItem.Builder setRequestedAnnotations(int index, Annotation.Builder builderForValue)

Search result annotations specified by result_annotation_keys in search request.

repeated .google.cloud.visionai.v1.Annotation requested_annotations = 3;

Parameters
Name	Description
index	int
builderForValue	Annotation.Builder

Returns
Type	Description
SearchResultItem.Builder

setSegment(Partition.TemporalPartition value)

public SearchResultItem.Builder setSegment(Partition.TemporalPartition value)

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Parameter
Name	Description
value	Partition.TemporalPartition

Returns
Type	Description
SearchResultItem.Builder

setSegment(Partition.TemporalPartition.Builder builderForValue)

public SearchResultItem.Builder setSegment(Partition.TemporalPartition.Builder builderForValue)

The matched asset segment.

.google.cloud.visionai.v1.Partition.TemporalPartition segment = 5;

Parameter
Name	Description
builderForValue	Partition.TemporalPartition.Builder

Returns
Type	Description
SearchResultItem.Builder

setSegments(int index, Partition.TemporalPartition value) (deprecated)

public SearchResultItem.Builder setSegments(int index, Partition.TemporalPartition value)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameters
Name	Description
index	int
value	Partition.TemporalPartition

Returns
Type	Description
SearchResultItem.Builder

setSegments(int index, Partition.TemporalPartition.Builder builderForValue) (deprecated)

public SearchResultItem.Builder setSegments(int index, Partition.TemporalPartition.Builder builderForValue)

The matched asset segments. Deprecated: please use singular segment field.

repeated .google.cloud.visionai.v1.Partition.TemporalPartition segments = 2 [deprecated = true];

Parameters
Name	Description
index	int
builderForValue	Partition.TemporalPartition.Builder

Returns
Type	Description
SearchResultItem.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResultItem.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchResultItem.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)