com.google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-video-intelligence-v1p1beta1 Show documentation
PROTO library for proto-google-cloud-video-intelligence-v1p1beta1
There is a newer version: 0.143.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/videointelligence/v1p1beta1/video_intelligence.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.videointelligence.v1p1beta1;

public interface AnnotateVideoRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Input video location. Currently, only
   * [Google Cloud Storage](https://cloud.google.com/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][google.rpc.Code.INVALID_ARGUMENT]). For
   * more information, see [Request
   * URIs](https://cloud.google.com/storage/docs/request-endpoints). 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;
   *
   * @return The inputUri.
   */
  java.lang.String getInputUri();
  /**
   *
   *
   *    * Input video location. Currently, only
   * [Google Cloud Storage](https://cloud.google.com/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][google.rpc.Code.INVALID_ARGUMENT]). For
   * more information, see [Request
   * URIs](https://cloud.google.com/storage/docs/request-endpoints). 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;
   *
   * @return The bytes for inputUri.
   */
  com.google.protobuf.ByteString getInputUriBytes();

  /**
   *
   *
   *    * 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;
   *
   * @return The inputContent.
   */
  com.google.protobuf.ByteString getInputContent();

  /**
   *
   *
   *    * Required. Requested video annotation features.
   * 
   *
   * 
   * repeated .google.cloud.videointelligence.v1p1beta1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return A list containing the features.
   */
  java.util.List getFeaturesList();
  /**
   *
   *
   *    * Required. Requested video annotation features.
   * 
   *
   * 
   * repeated .google.cloud.videointelligence.v1p1beta1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The count of features.
   */
  int getFeaturesCount();
  /**
   *
   *
   *    * Required. Requested video annotation features.
   * 
   *
   * 
   * repeated .google.cloud.videointelligence.v1p1beta1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @param index The index of the element to return.
   * @return The features at the given index.
   */
  com.google.cloud.videointelligence.v1p1beta1.Feature getFeatures(int index);
  /**
   *
   *
   *    * Required. Requested video annotation features.
   * 
   *
   * 
   * repeated .google.cloud.videointelligence.v1p1beta1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return A list containing the enum numeric values on the wire for features.
   */
  java.util.List getFeaturesValueList();
  /**
   *
   *
   *    * Required. Requested video annotation features.
   * 
   *
   * 
   * repeated .google.cloud.videointelligence.v1p1beta1.Feature features = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of features at the given index.
   */
  int getFeaturesValue(int index);

  /**
   *
   *
   *    * Additional video context and/or feature-specific parameters.
   * 
   *
   * .google.cloud.videointelligence.v1p1beta1.VideoContext video_context = 3;
   *
   * @return Whether the videoContext field is set.
   */
  boolean hasVideoContext();
  /**
   *
   *
   *    * Additional video context and/or feature-specific parameters.
   * 
   *
   * .google.cloud.videointelligence.v1p1beta1.VideoContext video_context = 3;
   *
   * @return The videoContext.
   */
  com.google.cloud.videointelligence.v1p1beta1.VideoContext getVideoContext();
  /**
   *
   *
   *    * Additional video context and/or feature-specific parameters.
   * 
   *
   * .google.cloud.videointelligence.v1p1beta1.VideoContext video_context = 3;
   */
  com.google.cloud.videointelligence.v1p1beta1.VideoContextOrBuilder getVideoContextOrBuilder();

  /**
   *
   *
   *    * Optional. Location where the output (in JSON format) should be stored.
   * Currently, only [Google Cloud Storage](https://cloud.google.com/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][google.rpc.Code.INVALID_ARGUMENT]). For
   * more information, see [Request
   * URIs](https://cloud.google.com/storage/docs/request-endpoints).
   * 
   *
   * string output_uri = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The outputUri.
   */
  java.lang.String getOutputUri();
  /**
   *
   *
   *    * Optional. Location where the output (in JSON format) should be stored.
   * Currently, only [Google Cloud Storage](https://cloud.google.com/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][google.rpc.Code.INVALID_ARGUMENT]). For
   * more information, see [Request
   * URIs](https://cloud.google.com/storage/docs/request-endpoints).
   * 
   *
   * string output_uri = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for outputUri.
   */
  com.google.protobuf.ByteString getOutputUriBytes();

  /**
   *
   *
   *    * 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];
   *
   * @return The locationId.
   */
  java.lang.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];
   *
   * @return The bytes for locationId.
   */
  com.google.protobuf.ByteString getLocationIdBytes();
}