Class ObjectTrackingAnnotation.Builder (2.45.0)

public static final class ObjectTrackingAnnotation.Builder extends GeneratedMessageV3.Builder<ObjectTrackingAnnotation.Builder> implements ObjectTrackingAnnotationOrBuilder

Annotations corresponding to one tracked object.

Protobuf type google.cloud.videointelligence.v1.ObjectTrackingAnnotation

Static Methods

getDescriptor()

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

Methods

addAllFrames(Iterable<? extends ObjectTrackingFrame> values)

public ObjectTrackingAnnotation.Builder addAllFrames(Iterable<? extends ObjectTrackingFrame> values)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameter
Name Description
values Iterable<? extends com.google.cloud.videointelligence.v1.ObjectTrackingFrame>
Returns
Type Description
ObjectTrackingAnnotation.Builder

addFrames(ObjectTrackingFrame value)

public ObjectTrackingAnnotation.Builder addFrames(ObjectTrackingFrame value)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameter
Name Description
value ObjectTrackingFrame
Returns
Type Description
ObjectTrackingAnnotation.Builder

addFrames(ObjectTrackingFrame.Builder builderForValue)

public ObjectTrackingAnnotation.Builder addFrames(ObjectTrackingFrame.Builder builderForValue)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameter
Name Description
builderForValue ObjectTrackingFrame.Builder
Returns
Type Description
ObjectTrackingAnnotation.Builder

addFrames(int index, ObjectTrackingFrame value)

public ObjectTrackingAnnotation.Builder addFrames(int index, ObjectTrackingFrame value)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameters
Name Description
index int
value ObjectTrackingFrame
Returns
Type Description
ObjectTrackingAnnotation.Builder

addFrames(int index, ObjectTrackingFrame.Builder builderForValue)

public ObjectTrackingAnnotation.Builder addFrames(int index, ObjectTrackingFrame.Builder builderForValue)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameters
Name Description
index int
builderForValue ObjectTrackingFrame.Builder
Returns
Type Description
ObjectTrackingAnnotation.Builder

addFramesBuilder()

public ObjectTrackingFrame.Builder addFramesBuilder()

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Returns
Type Description
ObjectTrackingFrame.Builder

addFramesBuilder(int index)

public ObjectTrackingFrame.Builder addFramesBuilder(int index)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameter
Name Description
index int
Returns
Type Description
ObjectTrackingFrame.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ObjectTrackingAnnotation build()
Returns
Type Description
ObjectTrackingAnnotation

buildPartial()

public ObjectTrackingAnnotation buildPartial()
Returns
Type Description
ObjectTrackingAnnotation

clear()

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

clearConfidence()

public ObjectTrackingAnnotation.Builder clearConfidence()

Object category's labeling confidence of this track.

float confidence = 4;

Returns
Type Description
ObjectTrackingAnnotation.Builder

This builder for chaining.

clearEntity()

public ObjectTrackingAnnotation.Builder clearEntity()

Entity to specify the object category that this track is labeled as.

.google.cloud.videointelligence.v1.Entity entity = 1;

Returns
Type Description
ObjectTrackingAnnotation.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearFrames()

public ObjectTrackingAnnotation.Builder clearFrames()

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Returns
Type Description
ObjectTrackingAnnotation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSegment()

public ObjectTrackingAnnotation.Builder clearSegment()

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

.google.cloud.videointelligence.v1.VideoSegment segment = 3;

Returns
Type Description
ObjectTrackingAnnotation.Builder

clearTrackId()

public ObjectTrackingAnnotation.Builder clearTrackId()

Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time.

int64 track_id = 5;

Returns
Type Description
ObjectTrackingAnnotation.Builder

This builder for chaining.

clearTrackInfo()

public ObjectTrackingAnnotation.Builder clearTrackInfo()
Returns
Type Description
ObjectTrackingAnnotation.Builder

clearVersion()

public ObjectTrackingAnnotation.Builder clearVersion()

Feature version.

string version = 6;

Returns
Type Description
ObjectTrackingAnnotation.Builder

This builder for chaining.

clone()

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

getConfidence()

public float getConfidence()

Object category's labeling confidence of this track.

float confidence = 4;

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public ObjectTrackingAnnotation getDefaultInstanceForType()
Returns
Type Description
ObjectTrackingAnnotation

getDescriptorForType()

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

getEntity()

public Entity getEntity()

Entity to specify the object category that this track is labeled as.

.google.cloud.videointelligence.v1.Entity entity = 1;

Returns
Type Description
Entity

The entity.

getEntityBuilder()

public Entity.Builder getEntityBuilder()

Entity to specify the object category that this track is labeled as.

.google.cloud.videointelligence.v1.Entity entity = 1;

Returns
Type Description
Entity.Builder

getEntityOrBuilder()

public EntityOrBuilder getEntityOrBuilder()

Entity to specify the object category that this track is labeled as.

.google.cloud.videointelligence.v1.Entity entity = 1;

Returns
Type Description
EntityOrBuilder

getFrames(int index)

public ObjectTrackingFrame getFrames(int index)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameter
Name Description
index int
Returns
Type Description
ObjectTrackingFrame

getFramesBuilder(int index)

public ObjectTrackingFrame.Builder getFramesBuilder(int index)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameter
Name Description
index int
Returns
Type Description
ObjectTrackingFrame.Builder

getFramesBuilderList()

public List<ObjectTrackingFrame.Builder> getFramesBuilderList()

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Returns
Type Description
List<Builder>

getFramesCount()

public int getFramesCount()

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Returns
Type Description
int

getFramesList()

public List<ObjectTrackingFrame> getFramesList()

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Returns
Type Description
List<ObjectTrackingFrame>

getFramesOrBuilder(int index)

public ObjectTrackingFrameOrBuilder getFramesOrBuilder(int index)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameter
Name Description
index int
Returns
Type Description
ObjectTrackingFrameOrBuilder

getFramesOrBuilderList()

public List<? extends ObjectTrackingFrameOrBuilder> getFramesOrBuilderList()

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Returns
Type Description
List<? extends com.google.cloud.videointelligence.v1.ObjectTrackingFrameOrBuilder>

getSegment()

public VideoSegment getSegment()

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

.google.cloud.videointelligence.v1.VideoSegment segment = 3;

Returns
Type Description
VideoSegment

The segment.

getSegmentBuilder()

public VideoSegment.Builder getSegmentBuilder()

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

.google.cloud.videointelligence.v1.VideoSegment segment = 3;

Returns
Type Description
VideoSegment.Builder

getSegmentOrBuilder()

public VideoSegmentOrBuilder getSegmentOrBuilder()

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

.google.cloud.videointelligence.v1.VideoSegment segment = 3;

Returns
Type Description
VideoSegmentOrBuilder

getTrackId()

public long getTrackId()

Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time.

int64 track_id = 5;

Returns
Type Description
long

The trackId.

getTrackInfoCase()

public ObjectTrackingAnnotation.TrackInfoCase getTrackInfoCase()
Returns
Type Description
ObjectTrackingAnnotation.TrackInfoCase

getVersion()

public String getVersion()

Feature version.

string version = 6;

Returns
Type Description
String

The version.

getVersionBytes()

public ByteString getVersionBytes()

Feature version.

string version = 6;

Returns
Type Description
ByteString

The bytes for version.

hasEntity()

public boolean hasEntity()

Entity to specify the object category that this track is labeled as.

.google.cloud.videointelligence.v1.Entity entity = 1;

Returns
Type Description
boolean

Whether the entity field is set.

hasSegment()

public boolean hasSegment()

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

.google.cloud.videointelligence.v1.VideoSegment segment = 3;

Returns
Type Description
boolean

Whether the segment field is set.

hasTrackId()

public boolean hasTrackId()

Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time.

int64 track_id = 5;

Returns
Type Description
boolean

Whether the trackId field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEntity(Entity value)

public ObjectTrackingAnnotation.Builder mergeEntity(Entity value)

Entity to specify the object category that this track is labeled as.

.google.cloud.videointelligence.v1.Entity entity = 1;

Parameter
Name Description
value Entity
Returns
Type Description
ObjectTrackingAnnotation.Builder

mergeFrom(ObjectTrackingAnnotation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeSegment(VideoSegment value)

public ObjectTrackingAnnotation.Builder mergeSegment(VideoSegment value)

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

.google.cloud.videointelligence.v1.VideoSegment segment = 3;

Parameter
Name Description
value VideoSegment
Returns
Type Description
ObjectTrackingAnnotation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeFrames(int index)

public ObjectTrackingAnnotation.Builder removeFrames(int index)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameter
Name Description
index int
Returns
Type Description
ObjectTrackingAnnotation.Builder

setConfidence(float value)

public ObjectTrackingAnnotation.Builder setConfidence(float value)

Object category's labeling confidence of this track.

float confidence = 4;

Parameter
Name Description
value float

The confidence to set.

Returns
Type Description
ObjectTrackingAnnotation.Builder

This builder for chaining.

setEntity(Entity value)

public ObjectTrackingAnnotation.Builder setEntity(Entity value)

Entity to specify the object category that this track is labeled as.

.google.cloud.videointelligence.v1.Entity entity = 1;

Parameter
Name Description
value Entity
Returns
Type Description
ObjectTrackingAnnotation.Builder

setEntity(Entity.Builder builderForValue)

public ObjectTrackingAnnotation.Builder setEntity(Entity.Builder builderForValue)

Entity to specify the object category that this track is labeled as.

.google.cloud.videointelligence.v1.Entity entity = 1;

Parameter
Name Description
builderForValue Entity.Builder
Returns
Type Description
ObjectTrackingAnnotation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setFrames(int index, ObjectTrackingFrame value)

public ObjectTrackingAnnotation.Builder setFrames(int index, ObjectTrackingFrame value)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameters
Name Description
index int
value ObjectTrackingFrame
Returns
Type Description
ObjectTrackingAnnotation.Builder

setFrames(int index, ObjectTrackingFrame.Builder builderForValue)

public ObjectTrackingAnnotation.Builder setFrames(int index, ObjectTrackingFrame.Builder builderForValue)

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

repeated .google.cloud.videointelligence.v1.ObjectTrackingFrame frames = 2;

Parameters
Name Description
index int
builderForValue ObjectTrackingFrame.Builder
Returns
Type Description
ObjectTrackingAnnotation.Builder

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

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

setSegment(VideoSegment value)

public ObjectTrackingAnnotation.Builder setSegment(VideoSegment value)

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

.google.cloud.videointelligence.v1.VideoSegment segment = 3;

Parameter
Name Description
value VideoSegment
Returns
Type Description
ObjectTrackingAnnotation.Builder

setSegment(VideoSegment.Builder builderForValue)

public ObjectTrackingAnnotation.Builder setSegment(VideoSegment.Builder builderForValue)

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

.google.cloud.videointelligence.v1.VideoSegment segment = 3;

Parameter
Name Description
builderForValue VideoSegment.Builder
Returns
Type Description
ObjectTrackingAnnotation.Builder

setTrackId(long value)

public ObjectTrackingAnnotation.Builder setTrackId(long value)

Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time.

int64 track_id = 5;

Parameter
Name Description
value long

The trackId to set.

Returns
Type Description
ObjectTrackingAnnotation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setVersion(String value)

public ObjectTrackingAnnotation.Builder setVersion(String value)

Feature version.

string version = 6;

Parameter
Name Description
value String

The version to set.

Returns
Type Description
ObjectTrackingAnnotation.Builder

This builder for chaining.

setVersionBytes(ByteString value)

public ObjectTrackingAnnotation.Builder setVersionBytes(ByteString value)

Feature version.

string version = 6;

Parameter
Name Description
value ByteString

The bytes for version to set.

Returns
Type Description
ObjectTrackingAnnotation.Builder

This builder for chaining.