Class VideoAnnotationResults (2.43.0)

public final class VideoAnnotationResults extends GeneratedMessageV3 implements VideoAnnotationResultsOrBuilder

Annotation results for a single video.

Protobuf type google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults

Static Fields

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

EXPLICIT_ANNOTATION_FIELD_NUMBER

public static final int EXPLICIT_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

FRAME_LABEL_ANNOTATIONS_FIELD_NUMBER

public static final int FRAME_LABEL_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

INPUT_URI_FIELD_NUMBER

public static final int INPUT_URI_FIELD_NUMBER
Field Value
Type Description
int

OBJECT_ANNOTATIONS_FIELD_NUMBER

public static final int OBJECT_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

SEGMENT_LABEL_ANNOTATIONS_FIELD_NUMBER

public static final int SEGMENT_LABEL_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

SHOT_ANNOTATIONS_FIELD_NUMBER

public static final int SHOT_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

SHOT_LABEL_ANNOTATIONS_FIELD_NUMBER

public static final int SHOT_LABEL_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_ANNOTATIONS_FIELD_NUMBER

public static final int TEXT_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VideoAnnotationResults getDefaultInstance()
Returns
Type Description
VideoAnnotationResults

getDescriptor()

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

newBuilder()

public static VideoAnnotationResults.Builder newBuilder()
Returns
Type Description
VideoAnnotationResults.Builder

newBuilder(VideoAnnotationResults prototype)

public static VideoAnnotationResults.Builder newBuilder(VideoAnnotationResults prototype)
Parameter
Name Description
prototype VideoAnnotationResults
Returns
Type Description
VideoAnnotationResults.Builder

parseDelimitedFrom(InputStream input)

public static VideoAnnotationResults parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoAnnotationResults parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static VideoAnnotationResults parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VideoAnnotationResults parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VideoAnnotationResults parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VideoAnnotationResults parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VideoAnnotationResults parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoAnnotationResults parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static VideoAnnotationResults parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoAnnotationResults parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static VideoAnnotationResults parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VideoAnnotationResults parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoAnnotationResults
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<VideoAnnotationResults> parser()
Returns
Type Description
Parser<VideoAnnotationResults>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public VideoAnnotationResults getDefaultInstanceForType()
Returns
Type Description
VideoAnnotationResults

getError()

public Status getError()

If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

.google.rpc.Status error = 9;

Returns
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

.google.rpc.Status error = 9;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getExplicitAnnotation()

public ExplicitContentAnnotation getExplicitAnnotation()

Explicit content annotation.

.google.cloud.videointelligence.v1p2beta1.ExplicitContentAnnotation explicit_annotation = 7;

Returns
Type Description
ExplicitContentAnnotation

The explicitAnnotation.

getExplicitAnnotationOrBuilder()

public ExplicitContentAnnotationOrBuilder getExplicitAnnotationOrBuilder()

Explicit content annotation.

.google.cloud.videointelligence.v1p2beta1.ExplicitContentAnnotation explicit_annotation = 7;

Returns
Type Description
ExplicitContentAnnotationOrBuilder

getFrameLabelAnnotations(int index)

public LabelAnnotation getFrameLabelAnnotations(int index)

Label annotations on frame level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation frame_label_annotations = 4;

Parameter
Name Description
index int
Returns
Type Description
LabelAnnotation

getFrameLabelAnnotationsCount()

public int getFrameLabelAnnotationsCount()

Label annotations on frame level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation frame_label_annotations = 4;

Returns
Type Description
int

getFrameLabelAnnotationsList()

public List<LabelAnnotation> getFrameLabelAnnotationsList()

Label annotations on frame level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation frame_label_annotations = 4;

Returns
Type Description
List<LabelAnnotation>

getFrameLabelAnnotationsOrBuilder(int index)

public LabelAnnotationOrBuilder getFrameLabelAnnotationsOrBuilder(int index)

Label annotations on frame level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation frame_label_annotations = 4;

Parameter
Name Description
index int
Returns
Type Description
LabelAnnotationOrBuilder

getFrameLabelAnnotationsOrBuilderList()

public List<? extends LabelAnnotationOrBuilder> getFrameLabelAnnotationsOrBuilderList()

Label annotations on frame level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation frame_label_annotations = 4;

Returns
Type Description
List<? extends com.google.cloud.videointelligence.v1p2beta1.LabelAnnotationOrBuilder>

getInputUri()

public String getInputUri()

Video file location in Google Cloud Storage.

string input_uri = 1;

Returns
Type Description
String

The inputUri.

getInputUriBytes()

public ByteString getInputUriBytes()

Video file location in Google Cloud Storage.

string input_uri = 1;

Returns
Type Description
ByteString

The bytes for inputUri.

getObjectAnnotations(int index)

public ObjectTrackingAnnotation getObjectAnnotations(int index)

Annotations for list of objects detected and tracked in video.

repeated .google.cloud.videointelligence.v1p2beta1.ObjectTrackingAnnotation object_annotations = 14;

Parameter
Name Description
index int
Returns
Type Description
ObjectTrackingAnnotation

getObjectAnnotationsCount()

public int getObjectAnnotationsCount()

Annotations for list of objects detected and tracked in video.

repeated .google.cloud.videointelligence.v1p2beta1.ObjectTrackingAnnotation object_annotations = 14;

Returns
Type Description
int

getObjectAnnotationsList()

public List<ObjectTrackingAnnotation> getObjectAnnotationsList()

Annotations for list of objects detected and tracked in video.

repeated .google.cloud.videointelligence.v1p2beta1.ObjectTrackingAnnotation object_annotations = 14;

Returns
Type Description
List<ObjectTrackingAnnotation>

getObjectAnnotationsOrBuilder(int index)

public ObjectTrackingAnnotationOrBuilder getObjectAnnotationsOrBuilder(int index)

Annotations for list of objects detected and tracked in video.

repeated .google.cloud.videointelligence.v1p2beta1.ObjectTrackingAnnotation object_annotations = 14;

Parameter
Name Description
index int
Returns
Type Description
ObjectTrackingAnnotationOrBuilder

getObjectAnnotationsOrBuilderList()

public List<? extends ObjectTrackingAnnotationOrBuilder> getObjectAnnotationsOrBuilderList()

Annotations for list of objects detected and tracked in video.

repeated .google.cloud.videointelligence.v1p2beta1.ObjectTrackingAnnotation object_annotations = 14;

Returns
Type Description
List<? extends com.google.cloud.videointelligence.v1p2beta1.ObjectTrackingAnnotationOrBuilder>

getParserForType()

public Parser<VideoAnnotationResults> getParserForType()
Returns
Type Description
Parser<VideoAnnotationResults>
Overrides

getSegmentLabelAnnotations(int index)

public LabelAnnotation getSegmentLabelAnnotations(int index)

Label annotations on video level or user specified segment level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation segment_label_annotations = 2;

Parameter
Name Description
index int
Returns
Type Description
LabelAnnotation

getSegmentLabelAnnotationsCount()

public int getSegmentLabelAnnotationsCount()

Label annotations on video level or user specified segment level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation segment_label_annotations = 2;

Returns
Type Description
int

getSegmentLabelAnnotationsList()

public List<LabelAnnotation> getSegmentLabelAnnotationsList()

Label annotations on video level or user specified segment level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation segment_label_annotations = 2;

Returns
Type Description
List<LabelAnnotation>

getSegmentLabelAnnotationsOrBuilder(int index)

public LabelAnnotationOrBuilder getSegmentLabelAnnotationsOrBuilder(int index)

Label annotations on video level or user specified segment level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation segment_label_annotations = 2;

Parameter
Name Description
index int
Returns
Type Description
LabelAnnotationOrBuilder

getSegmentLabelAnnotationsOrBuilderList()

public List<? extends LabelAnnotationOrBuilder> getSegmentLabelAnnotationsOrBuilderList()

Label annotations on video level or user specified segment level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation segment_label_annotations = 2;

Returns
Type Description
List<? extends com.google.cloud.videointelligence.v1p2beta1.LabelAnnotationOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShotAnnotations(int index)

public VideoSegment getShotAnnotations(int index)

Shot annotations. Each shot is represented as a video segment.

repeated .google.cloud.videointelligence.v1p2beta1.VideoSegment shot_annotations = 6;

Parameter
Name Description
index int
Returns
Type Description
VideoSegment

getShotAnnotationsCount()

public int getShotAnnotationsCount()

Shot annotations. Each shot is represented as a video segment.

repeated .google.cloud.videointelligence.v1p2beta1.VideoSegment shot_annotations = 6;

Returns
Type Description
int

getShotAnnotationsList()

public List<VideoSegment> getShotAnnotationsList()

Shot annotations. Each shot is represented as a video segment.

repeated .google.cloud.videointelligence.v1p2beta1.VideoSegment shot_annotations = 6;

Returns
Type Description
List<VideoSegment>

getShotAnnotationsOrBuilder(int index)

public VideoSegmentOrBuilder getShotAnnotationsOrBuilder(int index)

Shot annotations. Each shot is represented as a video segment.

repeated .google.cloud.videointelligence.v1p2beta1.VideoSegment shot_annotations = 6;

Parameter
Name Description
index int
Returns
Type Description
VideoSegmentOrBuilder

getShotAnnotationsOrBuilderList()

public List<? extends VideoSegmentOrBuilder> getShotAnnotationsOrBuilderList()

Shot annotations. Each shot is represented as a video segment.

repeated .google.cloud.videointelligence.v1p2beta1.VideoSegment shot_annotations = 6;

Returns
Type Description
List<? extends com.google.cloud.videointelligence.v1p2beta1.VideoSegmentOrBuilder>

getShotLabelAnnotations(int index)

public LabelAnnotation getShotLabelAnnotations(int index)

Label annotations on shot level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation shot_label_annotations = 3;

Parameter
Name Description
index int
Returns
Type Description
LabelAnnotation

getShotLabelAnnotationsCount()

public int getShotLabelAnnotationsCount()

Label annotations on shot level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation shot_label_annotations = 3;

Returns
Type Description
int

getShotLabelAnnotationsList()

public List<LabelAnnotation> getShotLabelAnnotationsList()

Label annotations on shot level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation shot_label_annotations = 3;

Returns
Type Description
List<LabelAnnotation>

getShotLabelAnnotationsOrBuilder(int index)

public LabelAnnotationOrBuilder getShotLabelAnnotationsOrBuilder(int index)

Label annotations on shot level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation shot_label_annotations = 3;

Parameter
Name Description
index int
Returns
Type Description
LabelAnnotationOrBuilder

getShotLabelAnnotationsOrBuilderList()

public List<? extends LabelAnnotationOrBuilder> getShotLabelAnnotationsOrBuilderList()

Label annotations on shot level. There is exactly one element for each unique label.

repeated .google.cloud.videointelligence.v1p2beta1.LabelAnnotation shot_label_annotations = 3;

Returns
Type Description
List<? extends com.google.cloud.videointelligence.v1p2beta1.LabelAnnotationOrBuilder>

getTextAnnotations(int index)

public TextAnnotation getTextAnnotations(int index)

OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it.

repeated .google.cloud.videointelligence.v1p2beta1.TextAnnotation text_annotations = 12;

Parameter
Name Description
index int
Returns
Type Description
TextAnnotation

getTextAnnotationsCount()

public int getTextAnnotationsCount()

OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it.

repeated .google.cloud.videointelligence.v1p2beta1.TextAnnotation text_annotations = 12;

Returns
Type Description
int

getTextAnnotationsList()

public List<TextAnnotation> getTextAnnotationsList()

OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it.

repeated .google.cloud.videointelligence.v1p2beta1.TextAnnotation text_annotations = 12;

Returns
Type Description
List<TextAnnotation>

getTextAnnotationsOrBuilder(int index)

public TextAnnotationOrBuilder getTextAnnotationsOrBuilder(int index)

OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it.

repeated .google.cloud.videointelligence.v1p2beta1.TextAnnotation text_annotations = 12;

Parameter
Name Description
index int
Returns
Type Description
TextAnnotationOrBuilder

getTextAnnotationsOrBuilderList()

public List<? extends TextAnnotationOrBuilder> getTextAnnotationsOrBuilderList()

OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it.

repeated .google.cloud.videointelligence.v1p2beta1.TextAnnotation text_annotations = 12;

Returns
Type Description
List<? extends com.google.cloud.videointelligence.v1p2beta1.TextAnnotationOrBuilder>

hasError()

public boolean hasError()

If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

.google.rpc.Status error = 9;

Returns
Type Description
boolean

Whether the error field is set.

hasExplicitAnnotation()

public boolean hasExplicitAnnotation()

Explicit content annotation.

.google.cloud.videointelligence.v1p2beta1.ExplicitContentAnnotation explicit_annotation = 7;

Returns
Type Description
boolean

Whether the explicitAnnotation field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public VideoAnnotationResults.Builder newBuilderForType()
Returns
Type Description
VideoAnnotationResults.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VideoAnnotationResults.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VideoAnnotationResults.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public VideoAnnotationResults.Builder toBuilder()
Returns
Type Description
VideoAnnotationResults.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException