Class AnnotateVideoRequest (2.6.0) 

public final class AnnotateVideoRequest extends GeneratedMessageV3 implements AnnotateVideoRequestOrBuilder

Video annotation request.

Protobuf type google.cloud.videointelligence.v1.AnnotateVideoRequest

Inheritance

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

Static Fields

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER
Field Value
Type Description
int

INPUT_CONTENT_FIELD_NUMBER

public static final int INPUT_CONTENT_FIELD_NUMBER
Field Value
Type Description
int

INPUT_URI_FIELD_NUMBER

public static final int INPUT_URI_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_URI_FIELD_NUMBER

public static final int OUTPUT_URI_FIELD_NUMBER
Field Value
Type Description
int

VIDEO_CONTEXT_FIELD_NUMBER

public static final int VIDEO_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnnotateVideoRequest getDefaultInstance()
Returns
Type Description
AnnotateVideoRequest

getDescriptor()

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

newBuilder()

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

newBuilder(AnnotateVideoRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public AnnotateVideoRequest getDefaultInstanceForType()
Returns
Type Description
AnnotateVideoRequest

getFeatures(int index)

public Feature getFeatures(int index)

Required. Requested video annotation features.

repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
Feature

The features at the given index.

getFeaturesCount()

public int getFeaturesCount()

Required. Requested video annotation features.

repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of features.

getFeaturesList()

public List<Feature> getFeaturesList()

Required. Requested video annotation features.

repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Feature>

A list containing the features.

getFeaturesValue(int index)

public int getFeaturesValue(int index)

Required. Requested video annotation features.

repeated .google.cloud.videointelligence.v1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of 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];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for features.

getInputContent()

public 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;

Returns
Type Description
ByteString

The inputContent.

getInputUri()

public String getInputUri()

Input video location. Currently, only Cloud 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). For more information, see Request URIs. 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;

Returns
Type Description
String

The inputUri.

getInputUriBytes()

public ByteString getInputUriBytes()

Input video location. Currently, only Cloud 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). For more information, see Request URIs. 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;

Returns
Type Description
ByteString

The bytes for inputUri.

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];

Returns
Type Description
String

The locationId.

getLocationIdBytes()

public 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];

Returns
Type Description
ByteString

The bytes for locationId.

getOutputUri()

public String getOutputUri()

Optional. Location where the output (in JSON format) should be stored. Currently, only Cloud 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). For more information, see Request URIs.

string output_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The outputUri.

getOutputUriBytes()

public ByteString getOutputUriBytes()

Optional. Location where the output (in JSON format) should be stored. Currently, only Cloud 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). For more information, see Request URIs.

string output_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for outputUri.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getVideoContext()

public VideoContext getVideoContext()

Additional video context and/or feature-specific parameters.

.google.cloud.videointelligence.v1.VideoContext video_context = 3;

Returns
Type Description
VideoContext

The videoContext.

getVideoContextOrBuilder()

public VideoContextOrBuilder getVideoContextOrBuilder()

Additional video context and/or feature-specific parameters.

.google.cloud.videointelligence.v1.VideoContext video_context = 3;

Returns
Type Description
VideoContextOrBuilder

hasVideoContext()

public boolean hasVideoContext()

Additional video context and/or feature-specific parameters.

.google.cloud.videointelligence.v1.VideoContext video_context = 3;

Returns
Type Description
boolean

Whether the videoContext 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 AnnotateVideoRequest.Builder newBuilderForType()
Returns
Type Description
AnnotateVideoRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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