@googleapis/spanner 12.2.0 → 12.3.0

package/build/v1.d.ts

@@ -71,6 +71,23 @@ export declare namespace spanner_v1 {
         scans: Resource$Scans;
         constructor(options: GlobalOptions, google?: GoogleConfigurable);
     }
+    /**
+     * Arguments to ack operations.
+     */
+    export interface Schema$Ack {
+        /**
+         * By default, an attempt to ack a message that does not exist will fail with a `NOT_FOUND` error. With `ignore_not_found` set to true, the ack will succeed even if the message does not exist. This is useful for unconditionally acking a message, even if it is missing or has already been acked.
+         */
+        ignoreNotFound?: boolean | null;
+        /**
+         * Required. The primary key of the message to be acked.
+         */
+        key?: any[] | null;
+        /**
+         * Required. The queue where the message to be acked is stored.
+         */
+        queue?: string | null;
+    }
     /**
      * A session in the Cloud Spanner Adapter API.
      */
@@ -532,11 +549,6 @@ export declare namespace spanner_v1 {
          */
         variable?: string | null;
     }
-    /**
-     * Container for various pieces of client-owned context attached to a request.
-     */
-    export interface Schema$ClientContext {
-    }
     /**
      * Metadata for a column.
      */
@@ -621,6 +633,23 @@ export declare namespace spanner_v1 {
          */
         mutationCount?: string | null;
     }
+    /**
+     * Metadata type for the long-running operation returned by `CALL compact_all()`, which can be executed using ExecuteSql or ExecuteStreamingSql APIs.
+     */
+    export interface Schema$CompactDatabaseMetadata {
+        /**
+         * Output only. The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+         */
+        cancelTime?: string | null;
+        /**
+         * Output only. The database being compacted.
+         */
+        database?: string | null;
+        /**
+         * Output only. The progress of the compaction operation.
+         */
+        progress?: Schema$OperationProgress;
+    }
     /**
      * A message representing context for a KeyRangeInfo, including a label, value, unit, and severity.
      */
@@ -1918,7 +1947,7 @@ export declare namespace spanner_v1 {
          */
         operations?: Schema$Operation[];
         /**
-         * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+         * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
          */
         unreachable?: string[] | null;
     }
@@ -2120,6 +2149,10 @@ export declare namespace spanner_v1 {
      * A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.
      */
     export interface Schema$Mutation {
+        /**
+         * Ack a message from a queue.
+         */
+        ack?: Schema$Ack;
         /**
          * Delete rows from a table. Succeeds whether or not the named rows were present.
          */
@@ -2136,6 +2169,10 @@ export declare namespace spanner_v1 {
          * Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. In an interleaved table, if you create the child table with the `ON DELETE CASCADE` annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row.
          */
         replace?: Schema$Write;
+        /**
+         * Send a message to a queue.
+         */
+        send?: Schema$Send;
         /**
          * Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`.
          */
@@ -2694,10 +2731,6 @@ export declare namespace spanner_v1 {
      * Common request options for various APIs.
      */
     export interface Schema$RequestOptions {
-        /**
-         * Optional. Optional context that may be needed for some requests.
-         */
-        clientContext?: Schema$ClientContext;
         /**
          * Priority for the request.
          */
@@ -2901,6 +2934,27 @@ export declare namespace spanner_v1 {
          */
         startTime?: string | null;
     }
+    /**
+     * Arguments to send operations.
+     */
+    export interface Schema$Send {
+        /**
+         * The time at which Spanner will begin attempting to deliver the message. If `deliver_time` is not set, Spanner will deliver the message immediately. If `deliver_time` is in the past, Spanner will replace it with a value closer to the current time.
+         */
+        deliverTime?: string | null;
+        /**
+         * Required. The primary key of the message to be sent.
+         */
+        key?: any[] | null;
+        /**
+         * The payload of the message.
+         */
+        payload?: any | null;
+        /**
+         * Required. The queue to which the message will be sent.
+         */
+        queue?: string | null;
+    }
     /**
      * A session in the Cloud Spanner API.
      */
@@ -4134,7 +4188,7 @@ export declare namespace spanner_v1 {
          *     pageSize: 'placeholder-value',
          *     // The standard list page token.
          *     pageToken: 'placeholder-value',
-         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          *     returnPartialSuccess: 'placeholder-value',
          *   });
          *   console.log(res.data);
@@ -4202,7 +4256,7 @@ export declare namespace spanner_v1 {
          */
         pageToken?: string;
         /**
-         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          */
         returnPartialSuccess?: boolean;
     }
@@ -4447,7 +4501,7 @@ export declare namespace spanner_v1 {
          *     pageSize: 'placeholder-value',
          *     // The standard list page token.
          *     pageToken: 'placeholder-value',
-         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          *     returnPartialSuccess: 'placeholder-value',
          *   });
          *   console.log(res.data);
@@ -4515,7 +4569,7 @@ export declare namespace spanner_v1 {
          */
         pageToken?: string;
         /**
-         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          */
         returnPartialSuccess?: boolean;
     }
@@ -6445,7 +6499,7 @@ export declare namespace spanner_v1 {
          *     pageSize: 'placeholder-value',
          *     // The standard list page token.
          *     pageToken: 'placeholder-value',
-         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          *     returnPartialSuccess: 'placeholder-value',
          *   });
          *   console.log(res.data);
@@ -6513,7 +6567,7 @@ export declare namespace spanner_v1 {
          */
         pageToken?: string;
         /**
-         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          */
         returnPartialSuccess?: boolean;
     }
@@ -8878,7 +8932,7 @@ export declare namespace spanner_v1 {
          *     pageSize: 'placeholder-value',
          *     // The standard list page token.
          *     pageToken: 'placeholder-value',
-         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          *     returnPartialSuccess: 'placeholder-value',
          *   });
          *   console.log(res.data);
@@ -8946,7 +9000,7 @@ export declare namespace spanner_v1 {
          */
         pageToken?: string;
         /**
-         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          */
         returnPartialSuccess?: boolean;
     }
@@ -11283,7 +11337,7 @@ export declare namespace spanner_v1 {
          *       pageSize: 'placeholder-value',
          *       // The standard list page token.
          *       pageToken: 'placeholder-value',
-         *       // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         *       // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          *       returnPartialSuccess: 'placeholder-value',
          *     });
          *   console.log(res.data);
@@ -11351,7 +11405,7 @@ export declare namespace spanner_v1 {
          */
         pageToken?: string;
         /**
-         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          */
         returnPartialSuccess?: boolean;
     }
@@ -11589,7 +11643,7 @@ export declare namespace spanner_v1 {
          *     pageSize: 'placeholder-value',
          *     // The standard list page token.
          *     pageToken: 'placeholder-value',
-         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          *     returnPartialSuccess: 'placeholder-value',
          *   });
          *   console.log(res.data);
@@ -11657,7 +11711,7 @@ export declare namespace spanner_v1 {
          */
         pageToken?: string;
         /**
-         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
          */
         returnPartialSuccess?: boolean;
     }