docs: update comments on protos (#203)

googleapis · Mar 1, 2019 · 4a67558 · 4a67558
1 parent 4b27c60
commit 4a67558
Show file tree

Hide file tree

Showing 19 changed files with 138 additions and 128 deletions.
diff --git a/...cloud-videointelligence/protos/google/cloud/videointelligence/v1/video_intelligence.proto b/...cloud-videointelligence/protos/google/cloud/videointelligence/v1/video_intelligence.proto
@@ -30,15 +30,18 @@ option java_outer_classname = "VideoIntelligenceServiceProto";
 option java_package = "com.google.cloud.videointelligence.v1";
 option php_namespace = "Google\\Cloud\\VideoIntelligence\\V1";
 
-
 // Service that implements Google Cloud Video Intelligence API.
 service VideoIntelligenceService {
   // Performs asynchronous video annotation. Progress and results can be
   // retrieved through the `google.longrunning.Operations` interface.
   // `Operation.metadata` contains `AnnotateVideoProgress` (progress).
   // `Operation.response` contains `AnnotateVideoResponse` (results).
-  rpc AnnotateVideo(AnnotateVideoRequest) returns (google.longrunning.Operation) {
-    option (google.api.http) = { post: "/v1/videos:annotate" body: "*" };
+  rpc AnnotateVideo(AnnotateVideoRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/videos:annotate"
+      body: "*"
+    };
   }
 }
 
@@ -48,10 +51,10 @@ message AnnotateVideoRequest {
   // [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](/storage/docs/reference-uris).
-  // A video URI may include wildcards in `object-id`, and thus identify
-  // multiple videos. Supported wildcards: '*' to match 0 or more characters;
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris). 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;
@@ -71,8 +74,8 @@ message AnnotateVideoRequest {
   // 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](/storage/docs/reference-uris).
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris).
   string output_uri = 4;
 
   // Optional cloud region where annotation should take place. Supported cloud

diff --git a/...-videointelligence/protos/google/cloud/videointelligence/v1beta1/video_intelligence.proto b/...-videointelligence/protos/google/cloud/videointelligence/v1beta1/video_intelligence.proto
@@ -34,8 +34,12 @@ service VideoIntelligenceService {
   // retrieved through the `google.longrunning.Operations` interface.
   // `Operation.metadata` contains `AnnotateVideoProgress` (progress).
   // `Operation.response` contains `AnnotateVideoResponse` (results).
-  rpc AnnotateVideo(AnnotateVideoRequest) returns (google.longrunning.Operation) {
-    option (google.api.http) = { post: "/v1beta1/videos:annotate" body: "*" };
+  rpc AnnotateVideo(AnnotateVideoRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta1/videos:annotate"
+      body: "*"
+    };
   }
 }
 
@@ -45,10 +49,10 @@ message AnnotateVideoRequest {
   // [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](/storage/docs/reference-uris).
-  // A video URI may include wildcards in `object-id`, and thus identify
-  // multiple videos. Supported wildcards: '*' to match 0 or more characters;
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris). 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;
@@ -67,8 +71,8 @@ message AnnotateVideoRequest {
   // 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](/storage/docs/reference-uris).
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris).
   string output_uri = 4;
 
   // Optional cloud region where annotation should take place. Supported cloud

diff --git a/...-videointelligence/protos/google/cloud/videointelligence/v1beta2/video_intelligence.proto b/...-videointelligence/protos/google/cloud/videointelligence/v1beta2/video_intelligence.proto
@@ -29,15 +29,18 @@ option java_outer_classname = "VideoIntelligenceServiceProto";
 option java_package = "com.google.cloud.videointelligence.v1beta2";
 option php_namespace = "Google\\Cloud\\VideoIntelligence\\V1beta2";
 
-
 // Service that implements Google Cloud Video Intelligence API.
 service VideoIntelligenceService {
   // Performs asynchronous video annotation. Progress and results can be
   // retrieved through the `google.longrunning.Operations` interface.
   // `Operation.metadata` contains `AnnotateVideoProgress` (progress).
   // `Operation.response` contains `AnnotateVideoResponse` (results).
-  rpc AnnotateVideo(AnnotateVideoRequest) returns (google.longrunning.Operation) {
-    option (google.api.http) = { post: "/v1beta2/videos:annotate" body: "*" };
+  rpc AnnotateVideo(AnnotateVideoRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta2/videos:annotate"
+      body: "*"
+    };
   }
 }
 
@@ -47,10 +50,10 @@ message AnnotateVideoRequest {
   // [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](/storage/docs/reference-uris).
-  // A video URI may include wildcards in `object-id`, and thus identify
-  // multiple videos. Supported wildcards: '*' to match 0 or more characters;
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris). 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;
@@ -70,8 +73,8 @@ message AnnotateVideoRequest {
   // 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](/storage/docs/reference-uris).
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris).
   string output_uri = 4;
 
   // Optional cloud region where annotation should take place. Supported cloud

diff --git a/...ideointelligence/protos/google/cloud/videointelligence/v1p1beta1/video_intelligence.proto b/...ideointelligence/protos/google/cloud/videointelligence/v1p1beta1/video_intelligence.proto
@@ -29,14 +29,14 @@ option java_outer_classname = "VideoIntelligenceServiceProto";
 option java_package = "com.google.cloud.videointelligence.v1p1beta1";
 option php_namespace = "Google\\Cloud\\VideoIntelligence\\V1p1beta1";
 
-
 // Service that implements Google Cloud Video Intelligence API.
 service VideoIntelligenceService {
   // Performs asynchronous video annotation. Progress and results can be
   // retrieved through the `google.longrunning.Operations` interface.
   // `Operation.metadata` contains `AnnotateVideoProgress` (progress).
   // `Operation.response` contains `AnnotateVideoResponse` (results).
-  rpc AnnotateVideo(AnnotateVideoRequest) returns (google.longrunning.Operation) {
+  rpc AnnotateVideo(AnnotateVideoRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1p1beta1/videos:annotate"
       body: "*"
@@ -50,10 +50,10 @@ message AnnotateVideoRequest {
   // [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](/storage/docs/reference-uris).
-  // A video URI may include wildcards in `object-id`, and thus identify
-  // multiple videos. Supported wildcards: '*' to match 0 or more characters;
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris). 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;
@@ -73,8 +73,8 @@ message AnnotateVideoRequest {
   // 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](/storage/docs/reference-uris).
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris).
   string output_uri = 4;
 
   // Optional cloud region where annotation should take place. Supported cloud

diff --git a/...ideointelligence/protos/google/cloud/videointelligence/v1p2beta1/video_intelligence.proto b/...ideointelligence/protos/google/cloud/videointelligence/v1p2beta1/video_intelligence.proto
@@ -30,14 +30,14 @@ option java_outer_classname = "VideoIntelligenceServiceProto";
 option java_package = "com.google.cloud.videointelligence.v1p2beta1";
 option php_namespace = "Google\\Cloud\\VideoIntelligence\\V1p2beta1";
 
-
 // Service that implements Google Cloud Video Intelligence API.
 service VideoIntelligenceService {
   // Performs asynchronous video annotation. Progress and results can be
   // retrieved through the `google.longrunning.Operations` interface.
   // `Operation.metadata` contains `AnnotateVideoProgress` (progress).
   // `Operation.response` contains `AnnotateVideoResponse` (results).
-  rpc AnnotateVideo(AnnotateVideoRequest) returns (google.longrunning.Operation) {
+  rpc AnnotateVideo(AnnotateVideoRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1p2beta1/videos:annotate"
       body: "*"
@@ -51,10 +51,10 @@ message AnnotateVideoRequest {
   // [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](/storage/docs/reference-uris).
-  // A video URI may include wildcards in `object-id`, and thus identify
-  // multiple videos. Supported wildcards: '*' to match 0 or more characters;
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris). 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;
@@ -74,8 +74,8 @@ message AnnotateVideoRequest {
   // 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](/storage/docs/reference-uris).
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris).
   string output_uri = 4;
 
   // Optional cloud region where annotation should take place. Supported cloud

diff --git a/...ideointelligence/protos/google/cloud/videointelligence/v1p3beta1/video_intelligence.proto b/...ideointelligence/protos/google/cloud/videointelligence/v1p3beta1/video_intelligence.proto
@@ -30,14 +30,14 @@ option java_outer_classname = "VideoIntelligenceServiceProto";
 option java_package = "com.google.cloud.videointelligence.v1p3beta1";
 option php_namespace = "Google\\Cloud\\VideoIntelligence\\V1p3beta1";
 
-
 // Service that implements Google Cloud Video Intelligence API.
 service VideoIntelligenceService {
   // Performs asynchronous video annotation. Progress and results can be
   // retrieved through the `google.longrunning.Operations` interface.
   // `Operation.metadata` contains `AnnotateVideoProgress` (progress).
   // `Operation.response` contains `AnnotateVideoResponse` (results).
-  rpc AnnotateVideo(AnnotateVideoRequest) returns (google.longrunning.Operation) {
+  rpc AnnotateVideo(AnnotateVideoRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1p3beta1/videos:annotate"
       body: "*"
@@ -51,7 +51,7 @@ service StreamingVideoIntelligenceService {
   // while sending video/audio bytes.
   // This method is only available via the gRPC API (not REST).
   rpc StreamingAnnotateVideo(stream StreamingAnnotateVideoRequest)
-    returns (stream StreamingAnnotateVideoResponse);
+      returns (stream StreamingAnnotateVideoResponse);
 }
 
 // Video annotation request.
@@ -60,10 +60,10 @@ message AnnotateVideoRequest {
   // [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](/storage/docs/reference-uris).
-  // A video URI may include wildcards in `object-id`, and thus identify
-  // multiple videos. Supported wildcards: '*' to match 0 or more characters;
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris). 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;
@@ -83,8 +83,8 @@ message AnnotateVideoRequest {
   // 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](/storage/docs/reference-uris).
+  // [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
+  // more information, see [Request URIs](/storage/docs/reference-uris).
   string output_uri = 4;
 
   // Optional cloud region where annotation should take place. Supported cloud
@@ -545,7 +545,7 @@ message StreamingVideoConfig {
 
     // Config for STREAMING_EXPLICIT_CONTENT_DETECTION.
     StreamingExplicitContentDetectionConfig explicit_content_detection_config =
-      4;
+        4;
 
     // Config for STREAMING_OBJECT_TRACKING.
     StreamingObjectTrackingConfig object_tracking_config = 5;

diff --git a/...-videointelligence/src/v1/doc/google/cloud/videointelligence/v1/doc_video_intelligence.js b/...-videointelligence/src/v1/doc/google/cloud/videointelligence/v1/doc_video_intelligence.js
@@ -23,10 +23,10 @@
  *   [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). For more information, see
- *   [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
- *   A video URI may include wildcards in `object-id`, and thus identify
- *   multiple videos. Supported wildcards: '*' to match 0 or more characters;
+ *   google.rpc.Code.INVALID_ARGUMENT). For
+ *   more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris). 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.
  *
@@ -50,8 +50,8 @@
  *   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). For more information, see
- *   [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
+ *   google.rpc.Code.INVALID_ARGUMENT). For
+ *   more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
  *
  * @property {string} locationId
  *   Optional cloud region where annotation should take place. Supported cloud

diff --git a/packages/google-cloud-videointelligence/src/v1/video_intelligence_service_client.js b/packages/google-cloud-videointelligence/src/v1/video_intelligence_service_client.js
@@ -221,10 +221,10 @@ class VideoIntelligenceServiceClient {
    *   [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). For more information, see
-   *   [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
-   *   A video URI may include wildcards in `object-id`, and thus identify
-   *   multiple videos. Supported wildcards: '*' to match 0 or more characters;
+   *   google.rpc.Code.INVALID_ARGUMENT). For
+   *   more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris). 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.
    * @param {string} [request.inputContent]
@@ -244,8 +244,8 @@ class VideoIntelligenceServiceClient {
    *   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). For more information, see
-   *   [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
+   *   google.rpc.Code.INVALID_ARGUMENT). For
+   *   more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
    * @param {string} [request.locationId]
    *   Optional cloud region where annotation should take place. Supported cloud
    *   regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region