Class AnnotateVideoRequest.Builder (2.41.0) 

public static final class AnnotateVideoRequest.Builder extends GeneratedMessageV3.Builder<AnnotateVideoRequest.Builder> implements AnnotateVideoRequestOrBuilder

Video annotation request.

Protobuf type google.cloud.videointelligence.v1p2beta1.AnnotateVideoRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllFeatures(Iterable<? extends Feature> values)

public AnnotateVideoRequest.Builder addAllFeatures(Iterable<? extends Feature> values)

Required. Requested video annotation features.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.videointelligence.v1p2beta1.Feature>

The features to add.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

addAllFeaturesValue(Iterable<Integer> values)

public AnnotateVideoRequest.Builder addAllFeaturesValue(Iterable<Integer> values)

Required. Requested video annotation features.

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

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for features to add.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

addFeatures(Feature value)

public AnnotateVideoRequest.Builder addFeatures(Feature value)

Required. Requested video annotation features.

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

Parameter
Name Description
value Feature

The features to add.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

addFeaturesValue(int value)

public AnnotateVideoRequest.Builder addFeaturesValue(int value)

Required. Requested video annotation features.

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

Parameter
Name Description
value int

The enum numeric value on the wire for features to add.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnnotateVideoRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

build()

public AnnotateVideoRequest build()
Returns
Type Description
AnnotateVideoRequest

buildPartial()

public AnnotateVideoRequest buildPartial()
Returns
Type Description
AnnotateVideoRequest

clear()

public AnnotateVideoRequest.Builder clear()
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

clearFeatures()

public AnnotateVideoRequest.Builder clearFeatures()

Required. Requested video annotation features.

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

Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AnnotateVideoRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

clearInputContent()

public AnnotateVideoRequest.Builder clearInputContent()

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
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

clearInputUri()

public AnnotateVideoRequest.Builder clearInputUri()

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
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

clearLocationId()

public AnnotateVideoRequest.Builder clearLocationId()

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
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AnnotateVideoRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

clearOutputUri()

public AnnotateVideoRequest.Builder clearOutputUri()

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
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

clearVideoContext()

public AnnotateVideoRequest.Builder clearVideoContext()

Additional video context and/or feature-specific parameters.

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

Returns
Type Description
AnnotateVideoRequest.Builder

clone()

public AnnotateVideoRequest.Builder clone()
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

getDefaultInstanceForType()

public AnnotateVideoRequest getDefaultInstanceForType()
Returns
Type Description
AnnotateVideoRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFeatures(int index)

public Feature getFeatures(int index)

Required. Requested video annotation features.

repeated .google.cloud.videointelligence.v1p2beta1.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.v1p2beta1.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.v1p2beta1.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.v1p2beta1.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.v1p2beta1.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 input_uri. If set, input_uri should be unset.

bytes input_content = 6;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for outputUri.

getVideoContext()

public VideoContext getVideoContext()

Additional video context and/or feature-specific parameters.

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

Returns
Type Description
VideoContext

The videoContext.

getVideoContextBuilder()

public VideoContext.Builder getVideoContextBuilder()

Additional video context and/or feature-specific parameters.

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

Returns
Type Description
VideoContext.Builder

getVideoContextOrBuilder()

public VideoContextOrBuilder getVideoContextOrBuilder()

Additional video context and/or feature-specific parameters.

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

Returns
Type Description
VideoContextOrBuilder

hasVideoContext()

public boolean hasVideoContext()

Additional video context and/or feature-specific parameters.

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

Returns
Type Description
boolean

Whether the videoContext field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AnnotateVideoRequest other)

public AnnotateVideoRequest.Builder mergeFrom(AnnotateVideoRequest other)
Parameter
Name Description
other AnnotateVideoRequest
Returns
Type Description
AnnotateVideoRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnnotateVideoRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AnnotateVideoRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnnotateVideoRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

mergeVideoContext(VideoContext value)

public AnnotateVideoRequest.Builder mergeVideoContext(VideoContext value)

Additional video context and/or feature-specific parameters.

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

Parameter
Name Description
value VideoContext
Returns
Type Description
AnnotateVideoRequest.Builder

setFeatures(int index, Feature value)

public AnnotateVideoRequest.Builder setFeatures(int index, Feature value)

Required. Requested video annotation features.

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

Parameters
Name Description
index int

The index to set the value at.
value Feature

The features to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setFeaturesValue(int index, int value)

public AnnotateVideoRequest.Builder setFeaturesValue(int index, int value)

Required. Requested video annotation features.

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

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for features to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AnnotateVideoRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

setInputContent(ByteString value)

public AnnotateVideoRequest.Builder setInputContent(ByteString value)

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;

Parameter
Name Description
value ByteString

The inputContent to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setInputUri(String value)

public AnnotateVideoRequest.Builder setInputUri(String value)

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;

Parameter
Name Description
value String

The inputUri to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setInputUriBytes(ByteString value)

public AnnotateVideoRequest.Builder setInputUriBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for inputUri to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setLocationId(String value)

public AnnotateVideoRequest.Builder setLocationId(String value)

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

Parameter
Name Description
value String

The locationId to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setLocationIdBytes(ByteString value)

public AnnotateVideoRequest.Builder setLocationIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for locationId to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setOutputUri(String value)

public AnnotateVideoRequest.Builder setOutputUri(String value)

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

Parameter
Name Description
value String

The outputUri to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setOutputUriBytes(ByteString value)

public AnnotateVideoRequest.Builder setOutputUriBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for outputUri to set.
Returns
Type Description
AnnotateVideoRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AnnotateVideoRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AnnotateVideoRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnnotateVideoRequest.Builder
Overrides

setVideoContext(VideoContext value)

public AnnotateVideoRequest.Builder setVideoContext(VideoContext value)

Additional video context and/or feature-specific parameters.

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

Parameter
Name Description
value VideoContext
Returns
Type Description
AnnotateVideoRequest.Builder

setVideoContext(VideoContext.Builder builderForValue)

public AnnotateVideoRequest.Builder setVideoContext(VideoContext.Builder builderForValue)

Additional video context and/or feature-specific parameters.

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

Parameter
Name Description
builderForValue VideoContext.Builder
Returns
Type Description
AnnotateVideoRequest.Builder