@googleapis/spanner 1.1.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # Changelog
2
2
 
3
+ ## [3.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/spanner-v2.0.0...spanner-v3.0.0) (2023-11-27)
4
+
5
+
6
+ ### ⚠ BREAKING CHANGES
7
+
8
+ * This release has breaking changes.
9
+
10
+ ### Features
11
+
12
+ * run the generator ([#3371](https://github.com/googleapis/google-api-nodejs-client/issues/3371)) ([d3fd980](https://github.com/googleapis/google-api-nodejs-client/commit/d3fd980907c318048c7ee471c38033cf529a3c04))
13
+ * **spanner:** update the API ([19c8a5e](https://github.com/googleapis/google-api-nodejs-client/commit/19c8a5e40f233682de4a75d7f802e0fd7d80f8ef))
14
+
15
+ ## [2.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/spanner-v1.1.1...spanner-v2.0.0) (2023-10-11)
16
+
17
+
18
+ ### ⚠ BREAKING CHANGES
19
+
20
+ * This release has breaking changes.
21
+
22
+ ### Features
23
+
24
+ * run the generator ([#3355](https://github.com/googleapis/google-api-nodejs-client/issues/3355)) ([5504c86](https://github.com/googleapis/google-api-nodejs-client/commit/5504c86fd61740886047320e2ed70f02a164acd7))
25
+ * **spanner:** update the API ([3d046d5](https://github.com/googleapis/google-api-nodejs-client/commit/3d046d5e6193f876b4ade162c3581e43f057031f))
26
+
3
27
  ## [1.1.1](https://github.com/googleapis/google-api-nodejs-client/compare/spanner-v1.1.0...spanner-v1.1.1) (2023-08-25)
4
28
 
5
29
 
package/build/v1.d.ts CHANGED
@@ -72,6 +72,53 @@ export declare namespace spanner_v1 {
72
72
  scans: Resource$Scans;
73
73
  constructor(options: GlobalOptions, google?: GoogleConfigurable);
74
74
  }
75
+ /**
76
+ * Autoscaling config for an instance.
77
+ */
78
+ export interface Schema$AutoscalingConfig {
79
+ /**
80
+ * Required. Autoscaling limits for an instance.
81
+ */
82
+ autoscalingLimits?: Schema$AutoscalingLimits;
83
+ /**
84
+ * Required. The autoscaling targets for an instance.
85
+ */
86
+ autoscalingTargets?: Schema$AutoscalingTargets;
87
+ }
88
+ /**
89
+ * The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.
90
+ */
91
+ export interface Schema$AutoscalingLimits {
92
+ /**
93
+ * Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.
94
+ */
95
+ maxNodes?: number | null;
96
+ /**
97
+ * Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.
98
+ */
99
+ maxProcessingUnits?: number | null;
100
+ /**
101
+ * Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
102
+ */
103
+ minNodes?: number | null;
104
+ /**
105
+ * Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
106
+ */
107
+ minProcessingUnits?: number | null;
108
+ }
109
+ /**
110
+ * The autoscaling targets for an instance.
111
+ */
112
+ export interface Schema$AutoscalingTargets {
113
+ /**
114
+ * Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.
115
+ */
116
+ highPriorityCpuUtilizationPercent?: number | null;
117
+ /**
118
+ * Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 100] inclusive.
119
+ */
120
+ storageUtilizationPercent?: number | null;
121
+ }
75
122
  /**
76
123
  * A backup of a Cloud Spanner database.
77
124
  */
@@ -168,6 +215,36 @@ export declare namespace spanner_v1 {
168
215
  */
169
216
  session?: Schema$Session[];
170
217
  }
218
+ /**
219
+ * The request for BatchWrite.
220
+ */
221
+ export interface Schema$BatchWriteRequest {
222
+ /**
223
+ * Required. The groups of mutations to be applied.
224
+ */
225
+ mutationGroups?: Schema$MutationGroup[];
226
+ /**
227
+ * Common options for this request.
228
+ */
229
+ requestOptions?: Schema$RequestOptions;
230
+ }
231
+ /**
232
+ * The result of applying a batch of mutations.
233
+ */
234
+ export interface Schema$BatchWriteResponse {
235
+ /**
236
+ * The commit timestamp of the transaction that applied this batch. Present if `status` is `OK`, absent otherwise.
237
+ */
238
+ commitTimestamp?: string | null;
239
+ /**
240
+ * The mutation groups applied in this batch. The values index into the `mutation_groups` field in the corresponding `BatchWriteRequest`.
241
+ */
242
+ indexes?: number[] | null;
243
+ /**
244
+ * An `OK` status indicates success. Any other status indicates a failure.
245
+ */
246
+ status?: Schema$Status;
247
+ }
171
248
  /**
172
249
  * The request for BeginTransaction.
173
250
  */
@@ -600,6 +677,19 @@ export declare namespace spanner_v1 {
600
677
  */
601
678
  shortMessage?: Schema$LocalizedString;
602
679
  }
680
+ /**
681
+ * The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries. DirectedReadOptions may only be specified for a read-only transaction, otherwise the API will return an `INVALID_ARGUMENT` error.
682
+ */
683
+ export interface Schema$DirectedReadOptions {
684
+ /**
685
+ * Exclude_replicas indicates that should be excluded from serving requests. Spanner will not route requests to the replicas in this list.
686
+ */
687
+ excludeReplicas?: Schema$ExcludeReplicas;
688
+ /**
689
+ * Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to `DEADLINE_EXCEEDED` errors.
690
+ */
691
+ includeReplicas?: Schema$IncludeReplicas;
692
+ }
603
693
  /**
604
694
  * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
605
695
  */
@@ -631,6 +721,15 @@ export declare namespace spanner_v1 {
631
721
  */
632
722
  kmsKeyVersion?: string | null;
633
723
  }
724
+ /**
725
+ * An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.
726
+ */
727
+ export interface Schema$ExcludeReplicas {
728
+ /**
729
+ * The directed read replica selector.
730
+ */
731
+ replicaSelections?: Schema$ReplicaSelection[];
732
+ }
634
733
  /**
635
734
  * The request for ExecuteBatchDml.
636
735
  */
@@ -673,6 +772,10 @@ export declare namespace spanner_v1 {
673
772
  * If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error.
674
773
  */
675
774
  dataBoostEnabled?: boolean | null;
775
+ /**
776
+ * Directed read options for this request.
777
+ */
778
+ directedReadOptions?: Schema$DirectedReadOptions;
676
779
  /**
677
780
  * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id \> @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters.
678
781
  */
@@ -800,6 +903,32 @@ export declare namespace spanner_v1 {
800
903
  */
801
904
  requestedPolicyVersion?: number | null;
802
905
  }
906
+ /**
907
+ * An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.
908
+ */
909
+ export interface Schema$IncludeReplicas {
910
+ /**
911
+ * If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is `false`.
912
+ */
913
+ autoFailoverDisabled?: boolean | null;
914
+ /**
915
+ * The directed read replica selector.
916
+ */
917
+ replicaSelections?: Schema$ReplicaSelection[];
918
+ }
919
+ /**
920
+ * Recommendation to add new indexes to run queries more efficiently.
921
+ */
922
+ export interface Schema$IndexAdvice {
923
+ /**
924
+ * Optional. DDL statements to add new indexes that will improve the query.
925
+ */
926
+ ddl?: string[] | null;
927
+ /**
928
+ * Optional. Estimated latency improvement factor. For example if the query currently takes 500 ms to run and the estimated latency with new indexes is 100 ms this field will be 5.
929
+ */
930
+ improvementFactor?: number | null;
931
+ }
803
932
  /**
804
933
  * A message representing a (sparse) collection of hot keys for specific key buckets.
805
934
  */
@@ -826,6 +955,10 @@ export declare namespace spanner_v1 {
826
955
  * An isolated set of Cloud Spanner resources on which databases can be hosted.
827
956
  */
828
957
  export interface Schema$Instance {
958
+ /**
959
+ * Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
960
+ */
961
+ autoscalingConfig?: Schema$AutoscalingConfig;
829
962
  /**
830
963
  * Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
831
964
  */
@@ -1307,6 +1440,15 @@ export declare namespace spanner_v1 {
1307
1440
  */
1308
1441
  update?: Schema$Write;
1309
1442
  }
1443
+ /**
1444
+ * A group of mutations to be committed together. Related mutations should be placed in a group. For example, two mutations inserting rows with the same primary key prefix in both parent and child tables are related.
1445
+ */
1446
+ export interface Schema$MutationGroup {
1447
+ /**
1448
+ * Required. The mutations in this group.
1449
+ */
1450
+ mutations?: Schema$Mutation[];
1451
+ }
1310
1452
  /**
1311
1453
  * This resource represents a long-running operation that is the result of a network API call.
1312
1454
  */
@@ -1330,7 +1472,7 @@ export declare namespace spanner_v1 {
1330
1472
  */
1331
1473
  name?: string | null;
1332
1474
  /**
1333
- * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
1475
+ * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
1334
1476
  */
1335
1477
  response?: {
1336
1478
  [key: string]: any;
@@ -1439,7 +1581,7 @@ export declare namespace spanner_v1 {
1439
1581
  */
1440
1582
  partitionOptions?: Schema$PartitionOptions;
1441
1583
  /**
1442
- * Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
1584
+ * Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, the first operator in the query execution plan must be a distributed union operator. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
1443
1585
  */
1444
1586
  sql?: string | null;
1445
1587
  /**
@@ -1527,7 +1669,7 @@ export declare namespace spanner_v1 {
1527
1669
  shortRepresentation?: Schema$ShortRepresentation;
1528
1670
  }
1529
1671
  /**
1530
- * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
1672
+ * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
1531
1673
  */
1532
1674
  export interface Schema$Policy {
1533
1675
  /**
@@ -1568,6 +1710,15 @@ export declare namespace spanner_v1 {
1568
1710
  */
1569
1711
  word?: string | null;
1570
1712
  }
1713
+ /**
1714
+ * Output of query advisor analysis.
1715
+ */
1716
+ export interface Schema$QueryAdvisorResult {
1717
+ /**
1718
+ * Optional. Index Recommendation for a query. This is an optional field and the recommendation will only be available when the recommendation guarantees significant improvement in query performance.
1719
+ */
1720
+ indexAdvice?: Schema$IndexAdvice[];
1721
+ }
1571
1722
  /**
1572
1723
  * Query optimizer configuration.
1573
1724
  */
@@ -1589,6 +1740,10 @@ export declare namespace spanner_v1 {
1589
1740
  * The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's `id` corresponds to its index in `plan_nodes`.
1590
1741
  */
1591
1742
  planNodes?: Schema$PlanNode[];
1743
+ /**
1744
+ * Optional. The advices/recommendations for a query. Currently this field will be serving index recommendations for a query.
1745
+ */
1746
+ queryAdvice?: Schema$QueryAdvisorResult;
1592
1747
  }
1593
1748
  /**
1594
1749
  * Message type to initiate a read-only transaction.
@@ -1631,6 +1786,10 @@ export declare namespace spanner_v1 {
1631
1786
  * If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error.
1632
1787
  */
1633
1788
  dataBoostEnabled?: boolean | null;
1789
+ /**
1790
+ * Directed read options for this request.
1791
+ */
1792
+ directedReadOptions?: Schema$DirectedReadOptions;
1634
1793
  /**
1635
1794
  * If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.
1636
1795
  */
@@ -1687,6 +1846,19 @@ export declare namespace spanner_v1 {
1687
1846
  */
1688
1847
  type?: string | null;
1689
1848
  }
1849
+ /**
1850
+ * The directed read replica selector. Callers must provide one or more of the following fields for replica selection: * `location` - The location must be one of the regions within the multi-region configuration of your database. * `type` - The type of the replica. Some examples of using replica_selectors are: * `location:us-east1` --\> The "us-east1" replica(s) of any available type will be used to process the request. * `type:READ_ONLY` --\> The "READ_ONLY" type replica(s) in nearest . available location will be used to process the request. * `location:us-east1 type:READ_ONLY` --\> The "READ_ONLY" type replica(s) in location "us-east1" will be used to process the request.
1851
+ */
1852
+ export interface Schema$ReplicaSelection {
1853
+ /**
1854
+ * The location or region of the serving requests, e.g. "us-east1".
1855
+ */
1856
+ location?: string | null;
1857
+ /**
1858
+ * The type of replica.
1859
+ */
1860
+ type?: string | null;
1861
+ }
1690
1862
  /**
1691
1863
  * Common request options for various APIs.
1692
1864
  */
@@ -2325,6 +2497,7 @@ export declare namespace spanner_v1 {
2325
2497
  export class Resource$Projects$Instanceconfigs {
2326
2498
  context: APIRequestContext;
2327
2499
  operations: Resource$Projects$Instanceconfigs$Operations;
2500
+ ssdCaches: Resource$Projects$Instanceconfigs$Ssdcaches;
2328
2501
  constructor(context: APIRequestContext);
2329
2502
  /**
2330
2503
  * Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.
@@ -2547,6 +2720,107 @@ export declare namespace spanner_v1 {
2547
2720
  */
2548
2721
  pageToken?: string;
2549
2722
  }
2723
+ export class Resource$Projects$Instanceconfigs$Ssdcaches {
2724
+ context: APIRequestContext;
2725
+ operations: Resource$Projects$Instanceconfigs$Ssdcaches$Operations;
2726
+ constructor(context: APIRequestContext);
2727
+ }
2728
+ export class Resource$Projects$Instanceconfigs$Ssdcaches$Operations {
2729
+ context: APIRequestContext;
2730
+ constructor(context: APIRequestContext);
2731
+ /**
2732
+ * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. 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`.
2733
+ *
2734
+ * @param params - Parameters for request
2735
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2736
+ * @param callback - Optional callback that handles the response.
2737
+ * @returns A promise if used with async/await, or void if used with a callback.
2738
+ */
2739
+ cancel(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
2740
+ cancel(params?: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
2741
+ cancel(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2742
+ cancel(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
2743
+ cancel(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
2744
+ cancel(callback: BodyResponseCallback<Schema$Empty>): void;
2745
+ /**
2746
+ * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
2747
+ *
2748
+ * @param params - Parameters for request
2749
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2750
+ * @param callback - Optional callback that handles the response.
2751
+ * @returns A promise if used with async/await, or void if used with a callback.
2752
+ */
2753
+ delete(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
2754
+ delete(params?: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
2755
+ delete(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2756
+ delete(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
2757
+ delete(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
2758
+ delete(callback: BodyResponseCallback<Schema$Empty>): void;
2759
+ /**
2760
+ * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
2761
+ *
2762
+ * @param params - Parameters for request
2763
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2764
+ * @param callback - Optional callback that handles the response.
2765
+ * @returns A promise if used with async/await, or void if used with a callback.
2766
+ */
2767
+ get(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
2768
+ get(params?: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
2769
+ get(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2770
+ get(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2771
+ get(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
2772
+ get(callback: BodyResponseCallback<Schema$Operation>): void;
2773
+ /**
2774
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
2775
+ *
2776
+ * @param params - Parameters for request
2777
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2778
+ * @param callback - Optional callback that handles the response.
2779
+ * @returns A promise if used with async/await, or void if used with a callback.
2780
+ */
2781
+ list(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
2782
+ list(params?: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
2783
+ list(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2784
+ list(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
2785
+ list(params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
2786
+ list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
2787
+ }
2788
+ export interface Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel extends StandardParameters {
2789
+ /**
2790
+ * The name of the operation resource to be cancelled.
2791
+ */
2792
+ name?: string;
2793
+ }
2794
+ export interface Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete extends StandardParameters {
2795
+ /**
2796
+ * The name of the operation resource to be deleted.
2797
+ */
2798
+ name?: string;
2799
+ }
2800
+ export interface Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get extends StandardParameters {
2801
+ /**
2802
+ * The name of the operation resource.
2803
+ */
2804
+ name?: string;
2805
+ }
2806
+ export interface Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List extends StandardParameters {
2807
+ /**
2808
+ * The standard list filter.
2809
+ */
2810
+ filter?: string;
2811
+ /**
2812
+ * The name of the operation's parent resource.
2813
+ */
2814
+ name?: string;
2815
+ /**
2816
+ * The standard list page size.
2817
+ */
2818
+ pageSize?: number;
2819
+ /**
2820
+ * The standard list page token.
2821
+ */
2822
+ pageToken?: string;
2823
+ }
2550
2824
  export class Resource$Projects$Instances {
2551
2825
  context: APIRequestContext;
2552
2826
  backupOperations: Resource$Projects$Instances$Backupoperations;
@@ -3630,6 +3904,20 @@ export declare namespace spanner_v1 {
3630
3904
  batchCreate(params: Params$Resource$Projects$Instances$Databases$Sessions$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$BatchCreateSessionsResponse>, callback: BodyResponseCallback<Schema$BatchCreateSessionsResponse>): void;
3631
3905
  batchCreate(params: Params$Resource$Projects$Instances$Databases$Sessions$Batchcreate, callback: BodyResponseCallback<Schema$BatchCreateSessionsResponse>): void;
3632
3906
  batchCreate(callback: BodyResponseCallback<Schema$BatchCreateSessionsResponse>): void;
3907
+ /**
3908
+ * Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.
3909
+ *
3910
+ * @param params - Parameters for request
3911
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3912
+ * @param callback - Optional callback that handles the response.
3913
+ * @returns A promise if used with async/await, or void if used with a callback.
3914
+ */
3915
+ batchWrite(params: Params$Resource$Projects$Instances$Databases$Sessions$Batchwrite, options: StreamMethodOptions): GaxiosPromise<Readable>;
3916
+ batchWrite(params?: Params$Resource$Projects$Instances$Databases$Sessions$Batchwrite, options?: MethodOptions): GaxiosPromise<Schema$BatchWriteResponse>;
3917
+ batchWrite(params: Params$Resource$Projects$Instances$Databases$Sessions$Batchwrite, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3918
+ batchWrite(params: Params$Resource$Projects$Instances$Databases$Sessions$Batchwrite, options: MethodOptions | BodyResponseCallback<Schema$BatchWriteResponse>, callback: BodyResponseCallback<Schema$BatchWriteResponse>): void;
3919
+ batchWrite(params: Params$Resource$Projects$Instances$Databases$Sessions$Batchwrite, callback: BodyResponseCallback<Schema$BatchWriteResponse>): void;
3920
+ batchWrite(callback: BodyResponseCallback<Schema$BatchWriteResponse>): void;
3633
3921
  /**
3634
3922
  * Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.
3635
3923
  *
@@ -3837,6 +4125,16 @@ export declare namespace spanner_v1 {
3837
4125
  */
3838
4126
  requestBody?: Schema$BatchCreateSessionsRequest;
3839
4127
  }
4128
+ export interface Params$Resource$Projects$Instances$Databases$Sessions$Batchwrite extends StandardParameters {
4129
+ /**
4130
+ * Required. The session in which the batch request is to be run.
4131
+ */
4132
+ session?: string;
4133
+ /**
4134
+ * Request body metadata
4135
+ */
4136
+ requestBody?: Schema$BatchWriteRequest;
4137
+ }
3840
4138
  export interface Params$Resource$Projects$Instances$Databases$Sessions$Begintransaction extends StandardParameters {
3841
4139
  /**
3842
4140
  * Required. The session in which the transaction runs.