Interface AnnotateVideoRequestOrBuilder (2.52.0) 

public interface AnnotateVideoRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFeatures(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getVideoContext()

public abstract 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 abstract VideoContextOrBuilder getVideoContextOrBuilder()

Additional video context and/or feature-specific parameters.

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

Returns
Type Description
VideoContextOrBuilder

hasVideoContext()

public abstract 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.