feat: add tagging request options

PiperOrigin-RevId: 365498709

Source-Author: Google APIs <[email protected]>
Source-Date: Sun Mar 28 20:54:25 2021 -0700
Source-Repo: googleapis/googleapis
Source-Sha: 6ce40ff8faf68226782f507ca6b2d497a77044de
Source-Link: googleapis/googleapis@6ce40ff

Author: yoshi-automation

google/cloud/spanner_admin_database_v1/proto/spanner_database_admin.proto

@@ -736,7 +736,7 @@ message RestoreDatabaseRequest {
   // to. If this field is not specified, the restored database will use the same
   // encryption configuration as the backup by default, namely
   // [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type]
-  // = `USE_CONFIG_DEFAULT_OR_DATABASE_ENCRYPTION`.
+  // = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
   RestoreDatabaseEncryptionConfig encryption_config = 4
       [(google.api.field_behavior) = OPTIONAL];
 }

google/cloud/spanner_admin_database_v1/types/spanner_database_admin.py

@@ -540,7 +540,7 @@ class RestoreDatabaseRequest(proto.Message):
             not specified, the restored database will use the same
             encryption configuration as the backup by default, namely
             [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type]
-            = ``USE_CONFIG_DEFAULT_OR_DATABASE_ENCRYPTION``.
+            = ``USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION``.
     """
 
     parent = proto.Field(proto.STRING, number=1)

google/cloud/spanner_admin_instance_v1/proto/spanner_instance_admin.proto

@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -373,7 +373,7 @@ message Instance {
   // either omitted or set to `CREATING`. For
   // [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
   // either omitted or set to `READY`.
-  State state = 6;
+  State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Cloud Labels are a flexible and lightweight mechanism for organizing cloud
   // resources into groups that reflect a customer's organizational needs and

google/cloud/spanner_v1/proto/spanner.proto

@@ -459,6 +459,27 @@ message RequestOptions {
 
   // Priority for the request.
   Priority priority = 1;
+
+  // A per-request tag which can be applied to queries or reads, used for
+  // statistics collection.
+  // Both request_tag and transaction_tag can be specified for a read or query
+  // that belongs to a transaction.
+  // This field is ignored for requests where it's not applicable (e.g.
+  // CommitRequest).
+  // `request_tag` must be a valid identifier of the form:
+  // `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length
+  string request_tag = 2;
+
+  // A tag used for statistics collection about this transaction.
+  // Both request_tag and transaction_tag can be specified for a read or query
+  // that belongs to a transaction.
+  // The value of transaction_tag should be the same for all requests belonging
+  // to the same transaction.
+  // If this request doesn’t belong to any transaction, transaction_tag will be
+  // ignored.
+  // `transaction_tag` must be a valid identifier of the format:
+  // `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`
+  string transaction_tag = 3;
 }
 
 // The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
@@ -490,15 +511,15 @@ message ExecuteSqlRequest {
     // The `optimizer_version` statement hint has precedence over this setting.
     string optimizer_version = 1;
 
-    // Query optimizer statistics package to use.
+    // An option to control the selection of optimizer statistics package.
     //
     // This parameter allows individual queries to use a different query
-    // optimizer statistics.
+    // optimizer statistics package.
     //
     // Specifying `latest` as a value instructs Cloud Spanner to use the latest
     // generated statistics package. If not specified, Cloud Spanner uses
-    // statistics package set at the database level options, or latest if
-    // the database option is not set.
+    // the statistics package set at the database level options, or the latest
+    // package if the database option is not set.
     //
     // The statistics package requested by the query has to be exempt from
     // garbage collection. This can be achieved with the following DDL
@@ -509,10 +530,10 @@ message ExecuteSqlRequest {
     // ```
     //
     // The list of available statistics packages can be queried from
-    // `SPANNER_SYS.OPTIMIZER_STATISTICS_PACKAGES`.
+    // `INFORMATION_SCHEMA.SPANNER_STATISTICS`.
     //
     // Executing a SQL statement with an invalid optimizer statistics package
-    // or with statistics package that allows garbage collection fails with
+    // or with a statistics package that allows garbage collection fails with
     // an `INVALID_ARGUMENT` error.
     string optimizer_statistics_package = 2;
   }

google/cloud/spanner_v1/types/spanner.py

@@ -247,6 +247,24 @@ class RequestOptions(proto.Message):
     Attributes:
         priority (google.cloud.spanner_v1.types.RequestOptions.Priority):
             Priority for the request.
+        request_tag (str):
+            A per-request tag which can be applied to queries or reads,
+            used for statistics collection. Both request_tag and
+            transaction_tag can be specified for a read or query that
+            belongs to a transaction. This field is ignored for requests
+            where it's not applicable (e.g. CommitRequest).
+            ``request_tag`` must be a valid identifier of the form:
+            ``[a-zA-Z][a-zA-Z0-9_\-]`` between 2 and 64 characters in
+            length
+        transaction_tag (str):
+            A tag used for statistics collection about this transaction.
+            Both request_tag and transaction_tag can be specified for a
+            read or query that belongs to a transaction. The value of
+            transaction_tag should be the same for all requests
+            belonging to the same transaction. If this request doesn’t
+            belong to any transaction, transaction_tag will be ignored.
+            ``transaction_tag`` must be a valid identifier of the
+            format: ``[a-zA-Z][a-zA-Z0-9_\-]{0,49}``
     """
 
     class Priority(proto.Enum):
@@ -275,6 +293,10 @@ class Priority(proto.Enum):
 
     priority = proto.Field(proto.ENUM, number=1, enum=Priority,)
 
+    request_tag = proto.Field(proto.STRING, number=2)
+
+    transaction_tag = proto.Field(proto.STRING, number=3)
+
 
 class ExecuteSqlRequest(proto.Message):
     r"""The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]
@@ -411,16 +433,17 @@ class QueryOptions(proto.Message):
                 The ``optimizer_version`` statement hint has precedence over
                 this setting.
             optimizer_statistics_package (str):
-                Query optimizer statistics package to use.
+                An option to control the selection of optimizer statistics
+                package.
 
                 This parameter allows individual queries to use a different
-                query optimizer statistics.
+                query optimizer statistics package.
 
                 Specifying ``latest`` as a value instructs Cloud Spanner to
                 use the latest generated statistics package. If not
-                specified, Cloud Spanner uses statistics package set at the
-                database level options, or latest if the database option is
-                not set.
+                specified, Cloud Spanner uses the statistics package set at
+                the database level options, or the latest package if the
+                database option is not set.
 
                 The statistics package requested by the query has to be
                 exempt from garbage collection. This can be achieved with
@@ -431,10 +454,10 @@ class QueryOptions(proto.Message):
                    ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
 
                 The list of available statistics packages can be queried
-                from ``SPANNER_SYS.OPTIMIZER_STATISTICS_PACKAGES``.
+                from ``INFORMATION_SCHEMA.SPANNER_STATISTICS``.
 
                 Executing a SQL statement with an invalid optimizer
-                statistics package or with statistics package that allows
+                statistics package or with a statistics package that allows
                 garbage collection fails with an ``INVALID_ARGUMENT`` error.
         """
 

synth.metadata

@@ -11,8 +11,8 @@
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "6598bb829c9e9a534be674649ffd1b4671a821f9",
-        "internalRef": "364449524"
+        "sha": "6ce40ff8faf68226782f507ca6b2d497a77044de",
+        "internalRef": "365498709"
       }
     },
     {