feat: add support for user labels for job and job template

Google APIs · copybara-github · commit a9969d336bc1 · 2022-06-15T22:29:42.000-07:00
PiperOrigin-RevId: 455298767
diff --git a/google/cloud/video/transcoder/v1/resources.proto b/google/cloud/video/transcoder/v1/resources.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -60,12 +60,16 @@ message Job {
   // Input only. Specify the `input_uri` to populate empty `uri` fields in each element of
   // `Job.config.inputs` or `JobTemplate.config.inputs` when using template.
   // URI of the media. Input files must be at least 5 seconds in duration and
-  // stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
+  // stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). See
+  // [Supported input and output
+  // formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
   string input_uri = 2 [(google.api.field_behavior) = INPUT_ONLY];
 
   // Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or
   // `JobTemplate.config.output.uri` when using template.
-  // URI for the output file(s). For example, `gs://my-bucket/outputs/`.
+  // URI for the output file(s). For example, `gs://my-bucket/outputs/`. See
+  // [Supported input and output
+  // formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
   string output_uri = 3 [(google.api.field_behavior) = INPUT_ONLY];
 
   // Specify the `job_config` for the transcoding job. If you don't specify the
@@ -104,6 +108,10 @@ message Job {
   // a value between 1 and 90. The default is 30.
   int32 ttl_after_completion_days = 15;
 
+  // The labels associated with this job. You can use these to organize and
+  // group your jobs.
+  map<string, string> labels = 16;
+
   // 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];
@@ -123,6 +131,10 @@ message JobTemplate {
 
   // The configuration for this template.
   JobConfig config = 2;
+
+  // The labels associated with this job template. You can use these to organize
+  // and group your job templates.
+  map<string, string> labels = 3;
 }
 
 // Job configuration
@@ -154,6 +166,7 @@ message JobConfig {
   PubsubDestination pubsub_destination = 8;
 
   // List of output sprite sheets.
+  // Spritesheets require at least one VideoStream in the Jobconfig.
   repeated SpriteSheet sprite_sheets = 9;
 
   // List of overlays on the output video, in descending Z-order.
@@ -168,7 +181,9 @@ message Input {
 
   // URI of the media. Input files must be at least 5 seconds in duration and
   // stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
-  // If empty, the value will be populated from `Job.input_uri`.
+  // If empty, the value is populated from `Job.input_uri`. See
+  // [Supported input and output
+  // formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
   string uri = 2;
 
   // Preprocessing configurations.
@@ -178,7 +193,9 @@ message Input {
 // Location of output file(s) in a Cloud Storage bucket.
 message Output {
   // URI for the output file(s). For example, `gs://my-bucket/outputs/`.
-  // If empty the value is populated from `Job.output_uri`.
+  // If empty, the value is populated from `Job.output_uri`. See
+  // [Supported input and output
+  // formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
   string uri = 1;
 }
 
@@ -250,6 +267,10 @@ message MuxStream {
   // - `fmp4`- the corresponding file extension is `.m4s`
   // - `mp4`
   // - `vtt`
+  //
+  // See also:
+  // [Supported input and output
+  // formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats)
   string container = 3;
 
   // List of `ElementaryStream.key`s multiplexed in this stream.
@@ -400,6 +421,18 @@ message Overlay {
     google.protobuf.Duration start_time_offset = 2;
   }
 
+  // Fade type for the overlay: `FADE_IN` or `FADE_OUT`.
+  enum FadeType {
+    // The fade type is not specified.
+    FADE_TYPE_UNSPECIFIED = 0;
+
+    // Fade the overlay object into view.
+    FADE_IN = 1;
+
+    // Fade the overlay object out of view.
+    FADE_OUT = 2;
+  }
+
   // Display overlay object with fade animation.
   message AnimationFade {
     // Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
@@ -443,18 +476,6 @@ message Overlay {
     }
   }
 
-  // Fade type for the overlay: `FADE_IN` or `FADE_OUT`.
-  enum FadeType {
-    // The fade type is not specified.
-    FADE_TYPE_UNSPECIFIED = 0;
-
-    // Fade the overlay object into view.
-    FADE_IN = 1;
-
-    // Fade the overlay object out of view.
-    FADE_OUT = 2;
-  }
-
   // Image overlay.
   Image image = 1;
 
@@ -466,6 +487,8 @@ message Overlay {
 // Preprocessing configurations.
 message PreprocessingConfig {
   // Color preprocessing configuration.
+  //
+  // **Note:** This configuration is not supported.
   message Color {
     // Control color saturation of the video. Enter a value between -1 and 1,
     // where -1 is fully desaturated and 1 is maximum saturation. 0 is no
@@ -484,6 +507,8 @@ message PreprocessingConfig {
   }
 
   // Denoise preprocessing configuration.
+  //
+  // **Note:** This configuration is not supported.
   message Denoise {
     // Set strength of the denoise. Enter a value between 0 and 1. The higher
     // the value, the smoother the image. 0 is no denoising. The default is 0.
@@ -499,6 +524,8 @@ message PreprocessingConfig {
   }
 
   // Deblock preprocessing configuration.
+  //
+  // **Note:** This configuration is not supported.
   message Deblock {
     // Set strength of the deblocker. Enter a value between 0 and 1. The higher
     // the value, the stronger the block removal. 0 is no deblocking. The
@@ -525,9 +552,13 @@ message PreprocessingConfig {
     double lufs = 1;
 
     // Enable boosting high frequency components. The default is `false`.
+    //
+    // **Note:** This field is not supported.
     bool high_boost = 2;
 
     // Enable boosting low frequency components. The default is `false`.
+    //
+    // **Note:** This field is not supported.
     bool low_boost = 3;
   }
 
@@ -906,11 +937,12 @@ message VideoStream {
     // Supported rate control modes:
     //
     // - `vbr` - variable bitrate
-    // - `crf` - constant rate factor
     string rate_control_mode = 6;
 
     // Target CRF level. Must be between 10 and 36, where 10 is the highest
     // quality and 36 is the most efficient compression. The default is 21.
+    //
+    // **Note:** This field is not supported.
     int32 crf_level = 7;
 
     // GOP mode can be either by frame count or duration.
diff --git a/google/cloud/video/transcoder/v1/services.proto b/google/cloud/video/transcoder/v1/services.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright 2021 Google LLC`
	`1`	`+// Copyright 2022 Google LLC`
`2`	`2`	`//`
`3`	`3`	`// Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`// you may not use this file except in compliance with the License.`