Class SearchResultItem (0.1.0)

public final class SearchResultItem extends GeneratedMessageV3 implements SearchResultItemOrBuilder

Search result contains asset name and corresponding time ranges.

Protobuf type google.cloud.visionai.v1.SearchResultItem

Inheritance

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

Implements

SearchResultItemOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANNOTATION_MATCHING_RESULTS_FIELD_NUMBER

public static final int ANNOTATION_MATCHING_RESULTS_FIELD_NUMBER

Field Value
Type	Description
`int`

ASSET_FIELD_NUMBER

public static final int ASSET_FIELD_NUMBER

Field Value
Type	Description
`int`

RELEVANCE_FIELD_NUMBER

public static final int RELEVANCE_FIELD_NUMBER

Field Value
Type	Description
`int`

REQUESTED_ANNOTATIONS_FIELD_NUMBER

public static final int REQUESTED_ANNOTATIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

SEGMENTS_FIELD_NUMBER

public static final int SEGMENTS_FIELD_NUMBER

Field Value
Type	Description
`int`

SEGMENT_FIELD_NUMBER

public static final int SEGMENT_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static SearchResultItem getDefaultInstance()

Returns
Type	Description
`SearchResultItem`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static SearchResultItem.Builder newBuilder()

Returns
Type	Description
`SearchResultItem.Builder`

newBuilder(SearchResultItem prototype)

public static SearchResultItem.Builder newBuilder(SearchResultItem prototype)

Parameter
Name	Description
`prototype`	`SearchResultItem`

Returns
Type	Description
`SearchResultItem.Builder`

parseDelimitedFrom(InputStream input)

public static SearchResultItem parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResultItem parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static SearchResultItem parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResultItem parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static SearchResultItem parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResultItem parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static SearchResultItem parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResultItem parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static SearchResultItem parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResultItem parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static SearchResultItem parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResultItem parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchResultItem`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<SearchResultItem> parser()

Returns
Type	Description
`Parser<SearchResultItem>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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`

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`

getParserForType()

public Parser<SearchResultItem> getParserForType()

Returns
Type	Description
`Parser<SearchResultItem>`

Overrides

GeneratedMessageV3.getParserForType()

getRelevance()

public double getRelevance()

Relevance of this SearchResultItem to user search request. Currently available only in Image Warehouse, and by default represents cosine similarity. In the future can be other measures such as "dot product" or "topicality" requested in the search request.

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`

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.

getSegmentOrBuilder()

public Partition.TemporalPartitionOrBuilder getSegmentOrBuilder()

The matched asset segment.

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

Returns
Type	Description
`Partition.TemporalPartitionOrBuilder`