Class AnnotateVideoRequest.Builder (2.27.0)

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

Video annotation request.

Protobuf type google.cloud.videointelligence.v1p3beta1.AnnotateVideoRequest

Static Methods

getDescriptor()

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

Methods

addAllFeatures(Iterable<? extends Feature> values)

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

Required. Requested video annotation features.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.videointelligence.v1p3beta1.Feature>

The features to add.

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

Parameter
NameDescription
valuesIterable<Integer>

The enum numeric values on the wire for features to add.

Returns
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

addFeatures(Feature value)

public AnnotateVideoRequest.Builder addFeatures(Feature value)

Required. Requested video annotation features.

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

Parameter
NameDescription
valueFeature

The features to add.

Returns
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

addFeaturesValue(int value)

public AnnotateVideoRequest.Builder addFeaturesValue(int value)

Required. Requested video annotation features.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for features to add.

Returns
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnnotateVideoRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

build()

public AnnotateVideoRequest build()
Returns
TypeDescription
AnnotateVideoRequest

buildPartial()

public AnnotateVideoRequest buildPartial()
Returns
TypeDescription
AnnotateVideoRequest

clear()

public AnnotateVideoRequest.Builder clear()
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

clearFeatures()

public AnnotateVideoRequest.Builder clearFeatures()

Required. Requested video annotation features.

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

Returns
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AnnotateVideoRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

clearInputContent()

public AnnotateVideoRequest.Builder clearInputContent()

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
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

clearInputUri()

public AnnotateVideoRequest.Builder clearInputUri()

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
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

clearLocationId()

public AnnotateVideoRequest.Builder clearLocationId()

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
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AnnotateVideoRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

clearOutputUri()

public AnnotateVideoRequest.Builder clearOutputUri()

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
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

clearVideoContext()

public AnnotateVideoRequest.Builder clearVideoContext()

Additional video context and/or feature-specific parameters.

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

Returns
TypeDescription
AnnotateVideoRequest.Builder

clone()

public AnnotateVideoRequest.Builder clone()
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

getDefaultInstanceForType()

public AnnotateVideoRequest getDefaultInstanceForType()
Returns
TypeDescription
AnnotateVideoRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFeatures(int index)

public Feature getFeatures(int index)

Required. Requested video annotation features.

repeated .google.cloud.videointelligence.v1p3beta1.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.v1p3beta1.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.v1p3beta1.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.v1p3beta1.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.v1p3beta1.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 the input_uri. If set, input_uri must be unset.

bytes input_content = 6;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for outputUri.

getVideoContext()

public VideoContext getVideoContext()

Additional video context and/or feature-specific parameters.

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

Returns
TypeDescription
VideoContext

The videoContext.

getVideoContextBuilder()

public VideoContext.Builder getVideoContextBuilder()

Additional video context and/or feature-specific parameters.

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

Returns
TypeDescription
VideoContext.Builder

getVideoContextOrBuilder()

public VideoContextOrBuilder getVideoContextOrBuilder()

Additional video context and/or feature-specific parameters.

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

Returns
TypeDescription
VideoContextOrBuilder

hasVideoContext()

public boolean hasVideoContext()

Additional video context and/or feature-specific parameters.

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

Returns
TypeDescription
boolean

Whether the videoContext field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AnnotateVideoRequest other)

public AnnotateVideoRequest.Builder mergeFrom(AnnotateVideoRequest other)
Parameter
NameDescription
otherAnnotateVideoRequest
Returns
TypeDescription
AnnotateVideoRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnnotateVideoRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AnnotateVideoRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnnotateVideoRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

mergeVideoContext(VideoContext value)

public AnnotateVideoRequest.Builder mergeVideoContext(VideoContext value)

Additional video context and/or feature-specific parameters.

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

Parameter
NameDescription
valueVideoContext
Returns
TypeDescription
AnnotateVideoRequest.Builder

setFeatures(int index, Feature value)

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

Required. Requested video annotation features.

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

Parameters
NameDescription
indexint

The index to set the value at.

valueFeature

The features to set.

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

Parameters
NameDescription
indexint

The index to set the value at.

valueint

The enum numeric value on the wire for features to set.

Returns
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AnnotateVideoRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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 the input_uri. If set, input_uri must be unset.

bytes input_content = 6;

Parameter
NameDescription
valueByteString

The inputContent to set.

Returns
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

setInputUri(String value)

public AnnotateVideoRequest.Builder setInputUri(String value)

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;

Parameter
NameDescription
valueString

The inputUri to set.

Returns
TypeDescription
AnnotateVideoRequest.Builder

This builder for chaining.

setInputUriBytes(ByteString value)

public AnnotateVideoRequest.Builder setInputUriBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for inputUri to set.

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

Parameter
NameDescription
valueString

The locationId to set.

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

Parameter
NameDescription
valueByteString

The bytes for locationId to set.

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

Parameter
NameDescription
valueString

The outputUri to set.

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

Parameter
NameDescription
valueByteString

The bytes for outputUri to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AnnotateVideoRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AnnotateVideoRequest.Builder
Overrides

setVideoContext(VideoContext value)

public AnnotateVideoRequest.Builder setVideoContext(VideoContext value)

Additional video context and/or feature-specific parameters.

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

Parameter
NameDescription
valueVideoContext
Returns
TypeDescription
AnnotateVideoRequest.Builder

setVideoContext(VideoContext.Builder builderForValue)

public AnnotateVideoRequest.Builder setVideoContext(VideoContext.Builder builderForValue)

Additional video context and/or feature-specific parameters.

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

Parameter
NameDescription
builderForValueVideoContext.Builder
Returns
TypeDescription
AnnotateVideoRequest.Builder