feat: add support for batch processing mode

Google APIs · copybara-github · commit 802cd84ccc94 · 2023-04-12T12:41:34.000-07:00
PiperOrigin-RevId: 523777114
diff --git a/google/cloud/video/transcoder/v1/resources.proto b/google/cloud/video/transcoder/v1/resources.proto
@@ -53,6 +53,21 @@ message Job {
     FAILED = 4;
   }
 
+  // The processing mode of the job.
+  enum ProcessingMode {
+    // The job processing mode is not specified.
+    PROCESSING_MODE_UNSPECIFIED = 0;
+
+    // The job processing mode is interactive mode.
+    // Interactive job will either be ran or rejected if quota does not allow
+    // for it.
+    PROCESSING_MODE_INTERACTIVE = 1;
+
+    // The job processing mode is batch mode.
+    // Batch mode allows queuing of jobs.
+    PROCESSING_MODE_BATCH = 2;
+  }
+
   // The resource name of the job.
   // Format: `projects/{project_number}/locations/{location}/jobs/{job}`
   string name = 1;
@@ -78,13 +93,9 @@ message Job {
   // the `Job.config` is populated by the `JobTemplate.config`.<br>
   oneof job_config {
     // Input only. Specify the `template_id` to use for populating `Job.config`.
-    // The default is `preset/web-hd`.
+    // The default is `preset/web-hd`, which is the only supported preset.
     //
-    // Preset Transcoder templates:
-    // - `preset/{preset_id}`
-    //
-    // - User defined JobTemplate:
-    //   `{job_template_id}`
+    // User defined JobTemplate: `{job_template_id}`
     string template_id = 4 [(google.api.field_behavior) = INPUT_ONLY];
 
     // The configuration for this job.
@@ -118,6 +129,10 @@ message Job {
   // Output only. An error object that describes the reason for the failure.
   // This property is always present when `state` is `FAILED`.
   google.rpc.Status error = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // The processing mode of the job.
+  // The default is `PROCESSING_MODE_INTERACTIVE`.
+  ProcessingMode mode = 20;
 }
 
 // Transcoding job template resource.
@@ -411,10 +426,10 @@ message Overlay {
     double y = 2;
   }
 
-  // Overlaid jpeg image.
+  // Overlaid image.
   message Image {
-    // Required. URI of the JPEG image in Cloud Storage. For example,
-    // `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
+    // Required. URI of the image in Cloud Storage. For example,
+    // `gs://bucket/inputs/image.png`. Only PNG and JPEG images are supported.
     string uri = 1 [(google.api.field_behavior) = REQUIRED];
 
     // Normalized image resolution, based on output video resolution. Valid
@@ -1171,11 +1186,12 @@ message AudioStream {
 
   // The BCP-47 language code, such as `en-US` or `sr-Latn`. For more
   // information, see
-  // https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+  // https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not
+  // supported in MP4 files.
   string language_code = 7;
 
   // The name for this particular audio stream that
-  // will be added to the HLS/DASH manifest.
+  // will be added to the HLS/DASH manifest. Not supported in MP4 files.
   string display_name = 8;
 }
 
@@ -1207,14 +1223,15 @@ message TextStream {
 
   // The BCP-47 language code, such as `en-US` or `sr-Latn`. For more
   // information, see
-  // https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+  // https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not
+  // supported in MP4 files.
   string language_code = 2;
 
   // The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
   repeated TextMapping mapping = 3;
 
   // The name for this particular text stream that
-  // will be added to the HLS/DASH manifest.
+  // will be added to the HLS/DASH manifest. Not supported in MP4 files.
   string display_name = 4;
 }
 
