Package com.google.cloud.videointelligence.v1

Class AnnotateVideoRequest

  • All Implemented Interfaces:
    AnnotateVideoRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AnnotateVideoRequest
extends com.google.protobuf.GeneratedMessageV3
implements AnnotateVideoRequestOrBuilder
     Video annotation request.
    Protobuf type google.cloud.videointelligence.v1.AnnotateVideoRequest
    See Also:
    Serialized Form

    • 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

      • getInputUri

        public String getInputUri()
         Input video location. Currently, only
 [Cloud Storage](https://cloud.google.com/storage/) URIs are
 supported. URIs must be specified in the following format:
 `gs://bucket-id/object-id` (other URI formats return
 [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
 more information, see [Request
 URIs](https://cloud.google.com/storage/docs/request-endpoints). To identify
 multiple videos, a video URI may include wildcards in the `object-id`.
 Supported wildcards: '*' to match 0 or more characters;
 '?' to match 1 character. If unset, the input video should be embedded
 in the request as `input_content`. If set, `input_content` must be unset.
        string input_uri = 1;
        Specified by:
        getInputUri in interface AnnotateVideoRequestOrBuilder
        Returns:
        The inputUri.

      • getInputUriBytes

        public com.google.protobuf.ByteString getInputUriBytes()
         Input video location. Currently, only
 [Cloud Storage](https://cloud.google.com/storage/) URIs are
 supported. URIs must be specified in the following format:
 `gs://bucket-id/object-id` (other URI formats return
 [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
 more information, see [Request
 URIs](https://cloud.google.com/storage/docs/request-endpoints). To identify
 multiple videos, a video URI may include wildcards in the `object-id`.
 Supported wildcards: '*' to match 0 or more characters;
 '?' to match 1 character. If unset, the input video should be embedded
 in the request as `input_content`. If set, `input_content` must be unset.
        string input_uri = 1;
        Specified by:
        getInputUriBytes in interface AnnotateVideoRequestOrBuilder
        Returns:
        The bytes for inputUri.

      • getInputContent

        public com.google.protobuf.ByteString getInputContent()
         The video data bytes.
 If unset, the input video(s) should be specified via the `input_uri`.
 If set, `input_uri` must be unset.
        bytes input_content = 6;
        Specified by:
        getInputContent in interface AnnotateVideoRequestOrBuilder
        Returns:
        The inputContent.

      • getFeaturesList

        public List<Feature> getFeaturesList()
         Required. Requested video annotation features.
        repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeaturesList in interface AnnotateVideoRequestOrBuilder
        Returns:
        A list containing the features.

      • getFeaturesCount

        public int getFeaturesCount()
         Required. Requested video annotation features.
        repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeaturesCount in interface AnnotateVideoRequestOrBuilder
        Returns:
        The count of features.

      • getFeatures

        public Feature getFeatures​(int index)
         Required. Requested video annotation features.
        repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeatures in interface AnnotateVideoRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The features at the given index.

      • getFeaturesValueList

        public List<Integer> getFeaturesValueList()
         Required. Requested video annotation features.
        repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeaturesValueList in interface AnnotateVideoRequestOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for features.

      • getFeaturesValue

        public int getFeaturesValue​(int index)
         Required. Requested video annotation features.
        repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeaturesValue in interface AnnotateVideoRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of features at the given index.

      • hasVideoContext

        public boolean hasVideoContext()
         Additional video context and/or feature-specific parameters.
        .google.cloud.videointelligence.v1.VideoContext video_context = 3;
        Specified by:
        hasVideoContext in interface AnnotateVideoRequestOrBuilder
        Returns:
        Whether the videoContext field is set.

      • getVideoContext

        public VideoContext getVideoContext()
         Additional video context and/or feature-specific parameters.
        .google.cloud.videointelligence.v1.VideoContext video_context = 3;
        Specified by:
        getVideoContext in interface AnnotateVideoRequestOrBuilder
        Returns:
        The videoContext.

      • getOutputUri

        public String getOutputUri()
         Optional. Location where the output (in JSON format) should be stored.
 Currently, only [Cloud Storage](https://cloud.google.com/storage/)
 URIs are supported. These must be specified in the following format:
 `gs://bucket-id/object-id` (other URI formats return
 [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
 more information, see [Request
 URIs](https://cloud.google.com/storage/docs/request-endpoints).
        string output_uri = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOutputUri in interface AnnotateVideoRequestOrBuilder
        Returns:
        The outputUri.

      • getOutputUriBytes

        public com.google.protobuf.ByteString getOutputUriBytes()
         Optional. Location where the output (in JSON format) should be stored.
 Currently, only [Cloud Storage](https://cloud.google.com/storage/)
 URIs are supported. These must be specified in the following format:
 `gs://bucket-id/object-id` (other URI formats return
 [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
 more information, see [Request
 URIs](https://cloud.google.com/storage/docs/request-endpoints).
        string output_uri = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOutputUriBytes in interface AnnotateVideoRequestOrBuilder
        Returns:
        The bytes for outputUri.

      • getLocationId

        public String getLocationId()
         Optional. Cloud region where annotation should take place. Supported cloud
 regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no
 region is specified, the region will be determined based on video file
 location.
        string location_id = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLocationId in interface AnnotateVideoRequestOrBuilder
        Returns:
        The locationId.

      • getLocationIdBytes

        public com.google.protobuf.ByteString getLocationIdBytes()
         Optional. Cloud region where annotation should take place. Supported cloud
 regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no
 region is specified, the region will be determined based on video file
 location.
        string location_id = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLocationIdBytes in interface AnnotateVideoRequestOrBuilder
        Returns:
        The bytes for locationId.

      • 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 AnnotateVideoRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<AnnotateVideoRequest> 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 AnnotateVideoRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder