Package com.google.cloud.videointelligence.v1

Class VideoAnnotationResults

  • All Implemented Interfaces:
    VideoAnnotationResultsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class VideoAnnotationResults
extends com.google.protobuf.GeneratedMessageV3
implements VideoAnnotationResultsOrBuilder
     Annotation results for a single video.
    Protobuf type google.cloud.videointelligence.v1.VideoAnnotationResults
    See Also:
    Serialized Form

    • Field Detail

      • SEGMENT_LABEL_ANNOTATIONS_FIELD_NUMBER

        public static final int SEGMENT_LABEL_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SEGMENT_PRESENCE_LABEL_ANNOTATIONS_FIELD_NUMBER

        public static final int SEGMENT_PRESENCE_LABEL_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHOT_LABEL_ANNOTATIONS_FIELD_NUMBER

        public static final int SHOT_LABEL_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHOT_PRESENCE_LABEL_ANNOTATIONS_FIELD_NUMBER

        public static final int SHOT_PRESENCE_LABEL_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FRAME_LABEL_ANNOTATIONS_FIELD_NUMBER

        public static final int FRAME_LABEL_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FACE_ANNOTATIONS_FIELD_NUMBER

        public static final int FACE_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FACE_DETECTION_ANNOTATIONS_FIELD_NUMBER

        public static final int FACE_DETECTION_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHOT_ANNOTATIONS_FIELD_NUMBER

        public static final int SHOT_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPLICIT_ANNOTATION_FIELD_NUMBER

        public static final int EXPLICIT_ANNOTATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SPEECH_TRANSCRIPTIONS_FIELD_NUMBER

        public static final int SPEECH_TRANSCRIPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_ANNOTATIONS_FIELD_NUMBER

        public static final int TEXT_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OBJECT_ANNOTATIONS_FIELD_NUMBER

        public static final int OBJECT_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOGO_RECOGNITION_ANNOTATIONS_FIELD_NUMBER

        public static final int LOGO_RECOGNITION_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PERSON_DETECTION_ANNOTATIONS_FIELD_NUMBER

        public static final int PERSON_DETECTION_ANNOTATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getInputUriBytes

        public com.google.protobuf.ByteString getInputUriBytes()
         Video file location in
 [Cloud Storage](https://cloud.google.com/storage/).
        string input_uri = 1;
        Specified by:
        getInputUriBytes in interface VideoAnnotationResultsOrBuilder
        Returns:
        The bytes for inputUri.

      • hasSegment

        public boolean hasSegment()
         Video segment on which the annotation is run.
        .google.cloud.videointelligence.v1.VideoSegment segment = 10;
        Specified by:
        hasSegment in interface VideoAnnotationResultsOrBuilder
        Returns:
        Whether the segment field is set.

      • getSegmentLabelAnnotationsList

        public List<LabelAnnotation> getSegmentLabelAnnotationsList()
         Topical label annotations on video level or user-specified segment level.
 There is exactly one element for each unique label.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation segment_label_annotations = 2;
        Specified by:
        getSegmentLabelAnnotationsList in interface VideoAnnotationResultsOrBuilder

      • getSegmentLabelAnnotationsCount

        public int getSegmentLabelAnnotationsCount()
         Topical label annotations on video level or user-specified segment level.
 There is exactly one element for each unique label.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation segment_label_annotations = 2;
        Specified by:
        getSegmentLabelAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • getSegmentLabelAnnotations

        public LabelAnnotation getSegmentLabelAnnotations​(int index)
         Topical label annotations on video level or user-specified segment level.
 There is exactly one element for each unique label.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation segment_label_annotations = 2;
        Specified by:
        getSegmentLabelAnnotations in interface VideoAnnotationResultsOrBuilder

      • getSegmentPresenceLabelAnnotationsList

        public List<LabelAnnotation> getSegmentPresenceLabelAnnotationsList()
         Presence label annotations on video level or user-specified segment level.
 There is exactly one element for each unique label. Compared to the
 existing topical `segment_label_annotations`, this field presents more
 fine-grained, segment-level labels detected in video content and is made
 available only when the client sets `LabelDetectionConfig.model` to
 "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation segment_presence_label_annotations = 23;
        Specified by:
        getSegmentPresenceLabelAnnotationsList in interface VideoAnnotationResultsOrBuilder

      • getSegmentPresenceLabelAnnotationsOrBuilderList

        public List<? extends LabelAnnotationOrBuilder> getSegmentPresenceLabelAnnotationsOrBuilderList()
         Presence label annotations on video level or user-specified segment level.
 There is exactly one element for each unique label. Compared to the
 existing topical `segment_label_annotations`, this field presents more
 fine-grained, segment-level labels detected in video content and is made
 available only when the client sets `LabelDetectionConfig.model` to
 "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation segment_presence_label_annotations = 23;
        Specified by:
        getSegmentPresenceLabelAnnotationsOrBuilderList in interface VideoAnnotationResultsOrBuilder

      • getSegmentPresenceLabelAnnotationsCount

        public int getSegmentPresenceLabelAnnotationsCount()
         Presence label annotations on video level or user-specified segment level.
 There is exactly one element for each unique label. Compared to the
 existing topical `segment_label_annotations`, this field presents more
 fine-grained, segment-level labels detected in video content and is made
 available only when the client sets `LabelDetectionConfig.model` to
 "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation segment_presence_label_annotations = 23;
        Specified by:
        getSegmentPresenceLabelAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • getSegmentPresenceLabelAnnotations

        public LabelAnnotation getSegmentPresenceLabelAnnotations​(int index)
         Presence label annotations on video level or user-specified segment level.
 There is exactly one element for each unique label. Compared to the
 existing topical `segment_label_annotations`, this field presents more
 fine-grained, segment-level labels detected in video content and is made
 available only when the client sets `LabelDetectionConfig.model` to
 "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation segment_presence_label_annotations = 23;
        Specified by:
        getSegmentPresenceLabelAnnotations in interface VideoAnnotationResultsOrBuilder

      • getSegmentPresenceLabelAnnotationsOrBuilder

        public LabelAnnotationOrBuilder getSegmentPresenceLabelAnnotationsOrBuilder​(int index)
         Presence label annotations on video level or user-specified segment level.
 There is exactly one element for each unique label. Compared to the
 existing topical `segment_label_annotations`, this field presents more
 fine-grained, segment-level labels detected in video content and is made
 available only when the client sets `LabelDetectionConfig.model` to
 "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation segment_presence_label_annotations = 23;
        Specified by:
        getSegmentPresenceLabelAnnotationsOrBuilder in interface VideoAnnotationResultsOrBuilder

      • getShotLabelAnnotationsCount

        public int getShotLabelAnnotationsCount()
         Topical label annotations on shot level.
 There is exactly one element for each unique label.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation shot_label_annotations = 3;
        Specified by:
        getShotLabelAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • getShotLabelAnnotations

        public LabelAnnotation getShotLabelAnnotations​(int index)
         Topical label annotations on shot level.
 There is exactly one element for each unique label.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation shot_label_annotations = 3;
        Specified by:
        getShotLabelAnnotations in interface VideoAnnotationResultsOrBuilder

      • getShotPresenceLabelAnnotationsList

        public List<LabelAnnotation> getShotPresenceLabelAnnotationsList()
         Presence label annotations on shot level. There is exactly one element for
 each unique label. Compared to the existing topical
 `shot_label_annotations`, this field presents more fine-grained, shot-level
 labels detected in video content and is made available only when the client
 sets `LabelDetectionConfig.model` to "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation shot_presence_label_annotations = 24;
        Specified by:
        getShotPresenceLabelAnnotationsList in interface VideoAnnotationResultsOrBuilder

      • getShotPresenceLabelAnnotationsOrBuilderList

        public List<? extends LabelAnnotationOrBuilder> getShotPresenceLabelAnnotationsOrBuilderList()
         Presence label annotations on shot level. There is exactly one element for
 each unique label. Compared to the existing topical
 `shot_label_annotations`, this field presents more fine-grained, shot-level
 labels detected in video content and is made available only when the client
 sets `LabelDetectionConfig.model` to "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation shot_presence_label_annotations = 24;
        Specified by:
        getShotPresenceLabelAnnotationsOrBuilderList in interface VideoAnnotationResultsOrBuilder

      • getShotPresenceLabelAnnotationsCount

        public int getShotPresenceLabelAnnotationsCount()
         Presence label annotations on shot level. There is exactly one element for
 each unique label. Compared to the existing topical
 `shot_label_annotations`, this field presents more fine-grained, shot-level
 labels detected in video content and is made available only when the client
 sets `LabelDetectionConfig.model` to "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation shot_presence_label_annotations = 24;
        Specified by:
        getShotPresenceLabelAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • getShotPresenceLabelAnnotations

        public LabelAnnotation getShotPresenceLabelAnnotations​(int index)
         Presence label annotations on shot level. There is exactly one element for
 each unique label. Compared to the existing topical
 `shot_label_annotations`, this field presents more fine-grained, shot-level
 labels detected in video content and is made available only when the client
 sets `LabelDetectionConfig.model` to "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation shot_presence_label_annotations = 24;
        Specified by:
        getShotPresenceLabelAnnotations in interface VideoAnnotationResultsOrBuilder

      • getShotPresenceLabelAnnotationsOrBuilder

        public LabelAnnotationOrBuilder getShotPresenceLabelAnnotationsOrBuilder​(int index)
         Presence label annotations on shot level. There is exactly one element for
 each unique label. Compared to the existing topical
 `shot_label_annotations`, this field presents more fine-grained, shot-level
 labels detected in video content and is made available only when the client
 sets `LabelDetectionConfig.model` to "builtin/latest" in the request.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation shot_presence_label_annotations = 24;
        Specified by:
        getShotPresenceLabelAnnotationsOrBuilder in interface VideoAnnotationResultsOrBuilder

      • getFrameLabelAnnotationsCount

        public int getFrameLabelAnnotationsCount()
         Label annotations on frame level.
 There is exactly one element for each unique label.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation frame_label_annotations = 4;
        Specified by:
        getFrameLabelAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • getFrameLabelAnnotations

        public LabelAnnotation getFrameLabelAnnotations​(int index)
         Label annotations on frame level.
 There is exactly one element for each unique label.
        repeated .google.cloud.videointelligence.v1.LabelAnnotation frame_label_annotations = 4;
        Specified by:
        getFrameLabelAnnotations in interface VideoAnnotationResultsOrBuilder

      • getFaceAnnotationsCount

        @Deprecated
public int getFaceAnnotationsCount()
        Deprecated.
         Deprecated. Please use `face_detection_annotations` instead.
        repeated .google.cloud.videointelligence.v1.FaceAnnotation face_annotations = 5 [deprecated = true];
        Specified by:
        getFaceAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • getShotAnnotationsCount

        public int getShotAnnotationsCount()
         Shot annotations. Each shot is represented as a video segment.
        repeated .google.cloud.videointelligence.v1.VideoSegment shot_annotations = 6;
        Specified by:
        getShotAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • hasExplicitAnnotation

        public boolean hasExplicitAnnotation()
         Explicit content annotation.
        .google.cloud.videointelligence.v1.ExplicitContentAnnotation explicit_annotation = 7;
        Specified by:
        hasExplicitAnnotation in interface VideoAnnotationResultsOrBuilder
        Returns:
        Whether the explicitAnnotation field is set.

      • 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.v1.TextAnnotation text_annotations = 12;
        Specified by:
        getTextAnnotationsList in interface VideoAnnotationResultsOrBuilder

      • 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.v1.TextAnnotation text_annotations = 12;
        Specified by:
        getTextAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • getTextAnnotations

        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.v1.TextAnnotation text_annotations = 12;
        Specified by:
        getTextAnnotations in interface VideoAnnotationResultsOrBuilder

      • getTextAnnotationsOrBuilder

        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.v1.TextAnnotation text_annotations = 12;
        Specified by:
        getTextAnnotationsOrBuilder in interface VideoAnnotationResultsOrBuilder

      • getObjectAnnotationsCount

        public int getObjectAnnotationsCount()
         Annotations for list of objects detected and tracked in video.
        repeated .google.cloud.videointelligence.v1.ObjectTrackingAnnotation object_annotations = 14;
        Specified by:
        getObjectAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • getLogoRecognitionAnnotationsCount

        public int getLogoRecognitionAnnotationsCount()
         Annotations for list of logos detected, tracked and recognized in video.
        repeated .google.cloud.videointelligence.v1.LogoRecognitionAnnotation logo_recognition_annotations = 19;
        Specified by:
        getLogoRecognitionAnnotationsCount in interface VideoAnnotationResultsOrBuilder

      • 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;
        Specified by:
        hasError in interface VideoAnnotationResultsOrBuilder
        Returns:
        Whether the error field is set.

      • getError

        public com.google.rpc.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;
        Specified by:
        getError in interface VideoAnnotationResultsOrBuilder
        Returns:
        The error.

      • getErrorOrBuilder

        public com.google.rpc.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;
        Specified by:
        getErrorOrBuilder in interface VideoAnnotationResultsOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static VideoAnnotationResults parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VideoAnnotationResults parseFrom​(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VideoAnnotationResults parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VideoAnnotationResults parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VideoAnnotationResults parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static VideoAnnotationResults parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public VideoAnnotationResults.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public VideoAnnotationResults.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected VideoAnnotationResults.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<VideoAnnotationResults> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public VideoAnnotationResults getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder