Class AnnotateVideoRequest (2.19.0)

public final class AnnotateVideoRequest extends GeneratedMessageV3 implements AnnotateVideoRequestOrBuilder

Video annotation request.

Protobuf type google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest

Static Fields

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_CONTENT_FIELD_NUMBER

public static final int INPUT_CONTENT_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_URI_FIELD_NUMBER

public static final int INPUT_URI_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_URI_FIELD_NUMBER

public static final int OUTPUT_URI_FIELD_NUMBER
Field Value
TypeDescription
int

VIDEO_CONTEXT_FIELD_NUMBER

public static final int VIDEO_CONTEXT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AnnotateVideoRequest getDefaultInstance()
Returns
TypeDescription
AnnotateVideoRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AnnotateVideoRequest.Builder newBuilder()
Returns
TypeDescription
AnnotateVideoRequest.Builder

newBuilder(AnnotateVideoRequest prototype)

public static AnnotateVideoRequest.Builder newBuilder(AnnotateVideoRequest prototype)
Parameter
NameDescription
prototypeAnnotateVideoRequest
Returns
TypeDescription
AnnotateVideoRequest.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateVideoRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateVideoRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AnnotateVideoRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateVideoRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateVideoRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateVideoRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateVideoRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateVideoRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AnnotateVideoRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateVideoRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AnnotateVideoRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateVideoRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateVideoRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AnnotateVideoRequest> parser()
Returns
TypeDescription
Parser<AnnotateVideoRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AnnotateVideoRequest getDefaultInstanceForType()
Returns
TypeDescription
AnnotateVideoRequest

getFeatures(int index)

public Feature getFeatures(int index)

Required. Requested video annotation features.

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
Feature

The features at the given index.

getFeaturesCount()

public int getFeaturesCount()

Required. Requested video annotation features.

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

Returns
TypeDescription
int

The count of features.

getFeaturesList()

public List<Feature> getFeaturesList()

Required. Requested video annotation features.

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

Returns
TypeDescription
List<Feature>

A list containing the features.

getFeaturesValue(int index)

public int getFeaturesValue(int index)

Required. Requested video annotation features.

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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.v1p1beta1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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 input_uri. If set, input_uri should be unset.

bytes input_content = 6;

Returns
TypeDescription
ByteString

The inputContent.

getInputUri()

public String getInputUri()

Input video location. Currently, only Google Cloud Storage URIs are supported, which 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. A video URI may include wildcards in object-id, and thus identify multiple videos. 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 should be unset.

string input_uri = 1;

Returns
TypeDescription
String

The inputUri.

getInputUriBytes()

public ByteString getInputUriBytes()

Input video location. Currently, only Google Cloud Storage URIs are supported, which 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. A video URI may include wildcards in object-id, and thus identify multiple videos. 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 should be unset.

string input_uri = 1;

Returns
TypeDescription
ByteString

The bytes for inputUri.

getLocationId()

public String getLocationId()

Optional. Cloud region where annotation should take place. Supported cloud regions: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, a region will be determined based on video file location.

string location_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

Optional. Cloud region where annotation should take place. Supported cloud regions: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, a region will be determined based on video file location.

string location_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for locationId.

getOutputUri()

public String getOutputUri()

Optional. Location where the output (in JSON format) should be stored. Currently, only Google Cloud Storage URIs are supported, which 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
TypeDescription
String

The outputUri.

getOutputUriBytes()

public ByteString getOutputUriBytes()

Optional. Location where the output (in JSON format) should be stored. Currently, only Google Cloud Storage URIs are supported, which 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
TypeDescription
ByteString

The bytes for outputUri.

getParserForType()

public Parser<AnnotateVideoRequest> getParserForType()
Returns
TypeDescription
Parser<AnnotateVideoRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getVideoContext()

public VideoContext getVideoContext()

Additional video context and/or feature-specific parameters.

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

Returns
TypeDescription
VideoContext

The videoContext.

getVideoContextOrBuilder()

public VideoContextOrBuilder getVideoContextOrBuilder()

Additional video context and/or feature-specific parameters.

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

Returns
TypeDescription
VideoContextOrBuilder

hasVideoContext()

public boolean hasVideoContext()

Additional video context and/or feature-specific parameters.

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

Returns
TypeDescription
boolean

Whether the videoContext field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AnnotateVideoRequest.Builder newBuilderForType()
Returns
TypeDescription
AnnotateVideoRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateVideoRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AnnotateVideoRequest.Builder toBuilder()
Returns
TypeDescription
AnnotateVideoRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException