@googleapis/spanner 2.0.0 → 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 +12 -0
- package/build/v1.d.ts +235 -0
- package/build/v1.js +143 -0
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +542 -0
package/v1.ts
CHANGED
|
@@ -126,6 +126,53 @@ export namespace spanner_v1 {
|
|
|
126
126
|
}
|
|
127
127
|
}
|
|
128
128
|
|
|
129
|
+
/**
|
|
130
|
+
* Autoscaling config for an instance.
|
|
131
|
+
*/
|
|
132
|
+
export interface Schema$AutoscalingConfig {
|
|
133
|
+
/**
|
|
134
|
+
* Required. Autoscaling limits for an instance.
|
|
135
|
+
*/
|
|
136
|
+
autoscalingLimits?: Schema$AutoscalingLimits;
|
|
137
|
+
/**
|
|
138
|
+
* Required. The autoscaling targets for an instance.
|
|
139
|
+
*/
|
|
140
|
+
autoscalingTargets?: Schema$AutoscalingTargets;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* 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.
|
|
144
|
+
*/
|
|
145
|
+
export interface Schema$AutoscalingLimits {
|
|
146
|
+
/**
|
|
147
|
+
* Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.
|
|
148
|
+
*/
|
|
149
|
+
maxNodes?: number | null;
|
|
150
|
+
/**
|
|
151
|
+
* 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.
|
|
152
|
+
*/
|
|
153
|
+
maxProcessingUnits?: number | null;
|
|
154
|
+
/**
|
|
155
|
+
* Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
|
|
156
|
+
*/
|
|
157
|
+
minNodes?: number | null;
|
|
158
|
+
/**
|
|
159
|
+
* Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
|
|
160
|
+
*/
|
|
161
|
+
minProcessingUnits?: number | null;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* The autoscaling targets for an instance.
|
|
165
|
+
*/
|
|
166
|
+
export interface Schema$AutoscalingTargets {
|
|
167
|
+
/**
|
|
168
|
+
* 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.
|
|
169
|
+
*/
|
|
170
|
+
highPriorityCpuUtilizationPercent?: number | null;
|
|
171
|
+
/**
|
|
172
|
+
* 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.
|
|
173
|
+
*/
|
|
174
|
+
storageUtilizationPercent?: number | null;
|
|
175
|
+
}
|
|
129
176
|
/**
|
|
130
177
|
* A backup of a Cloud Spanner database.
|
|
131
178
|
*/
|
|
@@ -684,6 +731,19 @@ export namespace spanner_v1 {
|
|
|
684
731
|
*/
|
|
685
732
|
shortMessage?: Schema$LocalizedString;
|
|
686
733
|
}
|
|
734
|
+
/**
|
|
735
|
+
* 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.
|
|
736
|
+
*/
|
|
737
|
+
export interface Schema$DirectedReadOptions {
|
|
738
|
+
/**
|
|
739
|
+
* Exclude_replicas indicates that should be excluded from serving requests. Spanner will not route requests to the replicas in this list.
|
|
740
|
+
*/
|
|
741
|
+
excludeReplicas?: Schema$ExcludeReplicas;
|
|
742
|
+
/**
|
|
743
|
+
* 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.
|
|
744
|
+
*/
|
|
745
|
+
includeReplicas?: Schema$IncludeReplicas;
|
|
746
|
+
}
|
|
687
747
|
/**
|
|
688
748
|
* 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); \}
|
|
689
749
|
*/
|
|
@@ -714,6 +774,15 @@ export namespace spanner_v1 {
|
|
|
714
774
|
*/
|
|
715
775
|
kmsKeyVersion?: string | null;
|
|
716
776
|
}
|
|
777
|
+
/**
|
|
778
|
+
* An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.
|
|
779
|
+
*/
|
|
780
|
+
export interface Schema$ExcludeReplicas {
|
|
781
|
+
/**
|
|
782
|
+
* The directed read replica selector.
|
|
783
|
+
*/
|
|
784
|
+
replicaSelections?: Schema$ReplicaSelection[];
|
|
785
|
+
}
|
|
717
786
|
/**
|
|
718
787
|
* The request for ExecuteBatchDml.
|
|
719
788
|
*/
|
|
@@ -756,6 +825,10 @@ export namespace spanner_v1 {
|
|
|
756
825
|
* 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.
|
|
757
826
|
*/
|
|
758
827
|
dataBoostEnabled?: boolean | null;
|
|
828
|
+
/**
|
|
829
|
+
* Directed read options for this request.
|
|
830
|
+
*/
|
|
831
|
+
directedReadOptions?: Schema$DirectedReadOptions;
|
|
759
832
|
/**
|
|
760
833
|
* 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.
|
|
761
834
|
*/
|
|
@@ -879,6 +952,32 @@ export namespace spanner_v1 {
|
|
|
879
952
|
*/
|
|
880
953
|
requestedPolicyVersion?: number | null;
|
|
881
954
|
}
|
|
955
|
+
/**
|
|
956
|
+
* An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.
|
|
957
|
+
*/
|
|
958
|
+
export interface Schema$IncludeReplicas {
|
|
959
|
+
/**
|
|
960
|
+
* 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`.
|
|
961
|
+
*/
|
|
962
|
+
autoFailoverDisabled?: boolean | null;
|
|
963
|
+
/**
|
|
964
|
+
* The directed read replica selector.
|
|
965
|
+
*/
|
|
966
|
+
replicaSelections?: Schema$ReplicaSelection[];
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* Recommendation to add new indexes to run queries more efficiently.
|
|
970
|
+
*/
|
|
971
|
+
export interface Schema$IndexAdvice {
|
|
972
|
+
/**
|
|
973
|
+
* Optional. DDL statements to add new indexes that will improve the query.
|
|
974
|
+
*/
|
|
975
|
+
ddl?: string[] | null;
|
|
976
|
+
/**
|
|
977
|
+
* 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.
|
|
978
|
+
*/
|
|
979
|
+
improvementFactor?: number | null;
|
|
980
|
+
}
|
|
882
981
|
/**
|
|
883
982
|
* A message representing a (sparse) collection of hot keys for specific key buckets.
|
|
884
983
|
*/
|
|
@@ -901,6 +1000,10 @@ export namespace spanner_v1 {
|
|
|
901
1000
|
* An isolated set of Cloud Spanner resources on which databases can be hosted.
|
|
902
1001
|
*/
|
|
903
1002
|
export interface Schema$Instance {
|
|
1003
|
+
/**
|
|
1004
|
+
* 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.
|
|
1005
|
+
*/
|
|
1006
|
+
autoscalingConfig?: Schema$AutoscalingConfig;
|
|
904
1007
|
/**
|
|
905
1008
|
* Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
|
|
906
1009
|
*/
|
|
@@ -1629,6 +1732,15 @@ export namespace spanner_v1 {
|
|
|
1629
1732
|
*/
|
|
1630
1733
|
word?: string | null;
|
|
1631
1734
|
}
|
|
1735
|
+
/**
|
|
1736
|
+
* Output of query advisor analysis.
|
|
1737
|
+
*/
|
|
1738
|
+
export interface Schema$QueryAdvisorResult {
|
|
1739
|
+
/**
|
|
1740
|
+
* 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.
|
|
1741
|
+
*/
|
|
1742
|
+
indexAdvice?: Schema$IndexAdvice[];
|
|
1743
|
+
}
|
|
1632
1744
|
/**
|
|
1633
1745
|
* Query optimizer configuration.
|
|
1634
1746
|
*/
|
|
@@ -1650,6 +1762,10 @@ export namespace spanner_v1 {
|
|
|
1650
1762
|
* 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`.
|
|
1651
1763
|
*/
|
|
1652
1764
|
planNodes?: Schema$PlanNode[];
|
|
1765
|
+
/**
|
|
1766
|
+
* Optional. The advices/recommendations for a query. Currently this field will be serving index recommendations for a query.
|
|
1767
|
+
*/
|
|
1768
|
+
queryAdvice?: Schema$QueryAdvisorResult;
|
|
1653
1769
|
}
|
|
1654
1770
|
/**
|
|
1655
1771
|
* Message type to initiate a read-only transaction.
|
|
@@ -1692,6 +1808,10 @@ export namespace spanner_v1 {
|
|
|
1692
1808
|
* 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.
|
|
1693
1809
|
*/
|
|
1694
1810
|
dataBoostEnabled?: boolean | null;
|
|
1811
|
+
/**
|
|
1812
|
+
* Directed read options for this request.
|
|
1813
|
+
*/
|
|
1814
|
+
directedReadOptions?: Schema$DirectedReadOptions;
|
|
1695
1815
|
/**
|
|
1696
1816
|
* 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.
|
|
1697
1817
|
*/
|
|
@@ -1748,6 +1868,19 @@ export namespace spanner_v1 {
|
|
|
1748
1868
|
*/
|
|
1749
1869
|
type?: string | null;
|
|
1750
1870
|
}
|
|
1871
|
+
/**
|
|
1872
|
+
* 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.
|
|
1873
|
+
*/
|
|
1874
|
+
export interface Schema$ReplicaSelection {
|
|
1875
|
+
/**
|
|
1876
|
+
* The location or region of the serving requests, e.g. "us-east1".
|
|
1877
|
+
*/
|
|
1878
|
+
location?: string | null;
|
|
1879
|
+
/**
|
|
1880
|
+
* The type of replica.
|
|
1881
|
+
*/
|
|
1882
|
+
type?: string | null;
|
|
1883
|
+
}
|
|
1751
1884
|
/**
|
|
1752
1885
|
* Common request options for various APIs.
|
|
1753
1886
|
*/
|
|
@@ -2469,11 +2602,15 @@ export namespace spanner_v1 {
|
|
|
2469
2602
|
export class Resource$Projects$Instanceconfigs {
|
|
2470
2603
|
context: APIRequestContext;
|
|
2471
2604
|
operations: Resource$Projects$Instanceconfigs$Operations;
|
|
2605
|
+
ssdCaches: Resource$Projects$Instanceconfigs$Ssdcaches;
|
|
2472
2606
|
constructor(context: APIRequestContext) {
|
|
2473
2607
|
this.context = context;
|
|
2474
2608
|
this.operations = new Resource$Projects$Instanceconfigs$Operations(
|
|
2475
2609
|
this.context
|
|
2476
2610
|
);
|
|
2611
|
+
this.ssdCaches = new Resource$Projects$Instanceconfigs$Ssdcaches(
|
|
2612
|
+
this.context
|
|
2613
|
+
);
|
|
2477
2614
|
}
|
|
2478
2615
|
|
|
2479
2616
|
/**
|
|
@@ -3363,6 +3500,411 @@ export namespace spanner_v1 {
|
|
|
3363
3500
|
pageToken?: string;
|
|
3364
3501
|
}
|
|
3365
3502
|
|
|
3503
|
+
export class Resource$Projects$Instanceconfigs$Ssdcaches {
|
|
3504
|
+
context: APIRequestContext;
|
|
3505
|
+
operations: Resource$Projects$Instanceconfigs$Ssdcaches$Operations;
|
|
3506
|
+
constructor(context: APIRequestContext) {
|
|
3507
|
+
this.context = context;
|
|
3508
|
+
this.operations =
|
|
3509
|
+
new Resource$Projects$Instanceconfigs$Ssdcaches$Operations(
|
|
3510
|
+
this.context
|
|
3511
|
+
);
|
|
3512
|
+
}
|
|
3513
|
+
}
|
|
3514
|
+
|
|
3515
|
+
export class Resource$Projects$Instanceconfigs$Ssdcaches$Operations {
|
|
3516
|
+
context: APIRequestContext;
|
|
3517
|
+
constructor(context: APIRequestContext) {
|
|
3518
|
+
this.context = context;
|
|
3519
|
+
}
|
|
3520
|
+
|
|
3521
|
+
/**
|
|
3522
|
+
* 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`.
|
|
3523
|
+
*
|
|
3524
|
+
* @param params - Parameters for request
|
|
3525
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3526
|
+
* @param callback - Optional callback that handles the response.
|
|
3527
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3528
|
+
*/
|
|
3529
|
+
cancel(
|
|
3530
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel,
|
|
3531
|
+
options: StreamMethodOptions
|
|
3532
|
+
): GaxiosPromise<Readable>;
|
|
3533
|
+
cancel(
|
|
3534
|
+
params?: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel,
|
|
3535
|
+
options?: MethodOptions
|
|
3536
|
+
): GaxiosPromise<Schema$Empty>;
|
|
3537
|
+
cancel(
|
|
3538
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel,
|
|
3539
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
3540
|
+
callback: BodyResponseCallback<Readable>
|
|
3541
|
+
): void;
|
|
3542
|
+
cancel(
|
|
3543
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel,
|
|
3544
|
+
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
|
|
3545
|
+
callback: BodyResponseCallback<Schema$Empty>
|
|
3546
|
+
): void;
|
|
3547
|
+
cancel(
|
|
3548
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel,
|
|
3549
|
+
callback: BodyResponseCallback<Schema$Empty>
|
|
3550
|
+
): void;
|
|
3551
|
+
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3552
|
+
cancel(
|
|
3553
|
+
paramsOrCallback?:
|
|
3554
|
+
| Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel
|
|
3555
|
+
| BodyResponseCallback<Schema$Empty>
|
|
3556
|
+
| BodyResponseCallback<Readable>,
|
|
3557
|
+
optionsOrCallback?:
|
|
3558
|
+
| MethodOptions
|
|
3559
|
+
| StreamMethodOptions
|
|
3560
|
+
| BodyResponseCallback<Schema$Empty>
|
|
3561
|
+
| BodyResponseCallback<Readable>,
|
|
3562
|
+
callback?:
|
|
3563
|
+
| BodyResponseCallback<Schema$Empty>
|
|
3564
|
+
| BodyResponseCallback<Readable>
|
|
3565
|
+
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
|
|
3566
|
+
let params = (paramsOrCallback ||
|
|
3567
|
+
{}) as Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel;
|
|
3568
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
3569
|
+
|
|
3570
|
+
if (typeof paramsOrCallback === 'function') {
|
|
3571
|
+
callback = paramsOrCallback;
|
|
3572
|
+
params =
|
|
3573
|
+
{} as Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel;
|
|
3574
|
+
options = {};
|
|
3575
|
+
}
|
|
3576
|
+
|
|
3577
|
+
if (typeof optionsOrCallback === 'function') {
|
|
3578
|
+
callback = optionsOrCallback;
|
|
3579
|
+
options = {};
|
|
3580
|
+
}
|
|
3581
|
+
|
|
3582
|
+
const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/';
|
|
3583
|
+
const parameters = {
|
|
3584
|
+
options: Object.assign(
|
|
3585
|
+
{
|
|
3586
|
+
url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'),
|
|
3587
|
+
method: 'POST',
|
|
3588
|
+
},
|
|
3589
|
+
options
|
|
3590
|
+
),
|
|
3591
|
+
params,
|
|
3592
|
+
requiredParams: ['name'],
|
|
3593
|
+
pathParams: ['name'],
|
|
3594
|
+
context: this.context,
|
|
3595
|
+
};
|
|
3596
|
+
if (callback) {
|
|
3597
|
+
createAPIRequest<Schema$Empty>(
|
|
3598
|
+
parameters,
|
|
3599
|
+
callback as BodyResponseCallback<unknown>
|
|
3600
|
+
);
|
|
3601
|
+
} else {
|
|
3602
|
+
return createAPIRequest<Schema$Empty>(parameters);
|
|
3603
|
+
}
|
|
3604
|
+
}
|
|
3605
|
+
|
|
3606
|
+
/**
|
|
3607
|
+
* 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`.
|
|
3608
|
+
*
|
|
3609
|
+
* @param params - Parameters for request
|
|
3610
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3611
|
+
* @param callback - Optional callback that handles the response.
|
|
3612
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3613
|
+
*/
|
|
3614
|
+
delete(
|
|
3615
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete,
|
|
3616
|
+
options: StreamMethodOptions
|
|
3617
|
+
): GaxiosPromise<Readable>;
|
|
3618
|
+
delete(
|
|
3619
|
+
params?: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete,
|
|
3620
|
+
options?: MethodOptions
|
|
3621
|
+
): GaxiosPromise<Schema$Empty>;
|
|
3622
|
+
delete(
|
|
3623
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete,
|
|
3624
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
3625
|
+
callback: BodyResponseCallback<Readable>
|
|
3626
|
+
): void;
|
|
3627
|
+
delete(
|
|
3628
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete,
|
|
3629
|
+
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
|
|
3630
|
+
callback: BodyResponseCallback<Schema$Empty>
|
|
3631
|
+
): void;
|
|
3632
|
+
delete(
|
|
3633
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete,
|
|
3634
|
+
callback: BodyResponseCallback<Schema$Empty>
|
|
3635
|
+
): void;
|
|
3636
|
+
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3637
|
+
delete(
|
|
3638
|
+
paramsOrCallback?:
|
|
3639
|
+
| Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete
|
|
3640
|
+
| BodyResponseCallback<Schema$Empty>
|
|
3641
|
+
| BodyResponseCallback<Readable>,
|
|
3642
|
+
optionsOrCallback?:
|
|
3643
|
+
| MethodOptions
|
|
3644
|
+
| StreamMethodOptions
|
|
3645
|
+
| BodyResponseCallback<Schema$Empty>
|
|
3646
|
+
| BodyResponseCallback<Readable>,
|
|
3647
|
+
callback?:
|
|
3648
|
+
| BodyResponseCallback<Schema$Empty>
|
|
3649
|
+
| BodyResponseCallback<Readable>
|
|
3650
|
+
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
|
|
3651
|
+
let params = (paramsOrCallback ||
|
|
3652
|
+
{}) as Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete;
|
|
3653
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
3654
|
+
|
|
3655
|
+
if (typeof paramsOrCallback === 'function') {
|
|
3656
|
+
callback = paramsOrCallback;
|
|
3657
|
+
params =
|
|
3658
|
+
{} as Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete;
|
|
3659
|
+
options = {};
|
|
3660
|
+
}
|
|
3661
|
+
|
|
3662
|
+
if (typeof optionsOrCallback === 'function') {
|
|
3663
|
+
callback = optionsOrCallback;
|
|
3664
|
+
options = {};
|
|
3665
|
+
}
|
|
3666
|
+
|
|
3667
|
+
const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/';
|
|
3668
|
+
const parameters = {
|
|
3669
|
+
options: Object.assign(
|
|
3670
|
+
{
|
|
3671
|
+
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
3672
|
+
method: 'DELETE',
|
|
3673
|
+
},
|
|
3674
|
+
options
|
|
3675
|
+
),
|
|
3676
|
+
params,
|
|
3677
|
+
requiredParams: ['name'],
|
|
3678
|
+
pathParams: ['name'],
|
|
3679
|
+
context: this.context,
|
|
3680
|
+
};
|
|
3681
|
+
if (callback) {
|
|
3682
|
+
createAPIRequest<Schema$Empty>(
|
|
3683
|
+
parameters,
|
|
3684
|
+
callback as BodyResponseCallback<unknown>
|
|
3685
|
+
);
|
|
3686
|
+
} else {
|
|
3687
|
+
return createAPIRequest<Schema$Empty>(parameters);
|
|
3688
|
+
}
|
|
3689
|
+
}
|
|
3690
|
+
|
|
3691
|
+
/**
|
|
3692
|
+
* 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.
|
|
3693
|
+
*
|
|
3694
|
+
* @param params - Parameters for request
|
|
3695
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3696
|
+
* @param callback - Optional callback that handles the response.
|
|
3697
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3698
|
+
*/
|
|
3699
|
+
get(
|
|
3700
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get,
|
|
3701
|
+
options: StreamMethodOptions
|
|
3702
|
+
): GaxiosPromise<Readable>;
|
|
3703
|
+
get(
|
|
3704
|
+
params?: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get,
|
|
3705
|
+
options?: MethodOptions
|
|
3706
|
+
): GaxiosPromise<Schema$Operation>;
|
|
3707
|
+
get(
|
|
3708
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get,
|
|
3709
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
3710
|
+
callback: BodyResponseCallback<Readable>
|
|
3711
|
+
): void;
|
|
3712
|
+
get(
|
|
3713
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get,
|
|
3714
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
3715
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
3716
|
+
): void;
|
|
3717
|
+
get(
|
|
3718
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get,
|
|
3719
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
3720
|
+
): void;
|
|
3721
|
+
get(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3722
|
+
get(
|
|
3723
|
+
paramsOrCallback?:
|
|
3724
|
+
| Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get
|
|
3725
|
+
| BodyResponseCallback<Schema$Operation>
|
|
3726
|
+
| BodyResponseCallback<Readable>,
|
|
3727
|
+
optionsOrCallback?:
|
|
3728
|
+
| MethodOptions
|
|
3729
|
+
| StreamMethodOptions
|
|
3730
|
+
| BodyResponseCallback<Schema$Operation>
|
|
3731
|
+
| BodyResponseCallback<Readable>,
|
|
3732
|
+
callback?:
|
|
3733
|
+
| BodyResponseCallback<Schema$Operation>
|
|
3734
|
+
| BodyResponseCallback<Readable>
|
|
3735
|
+
): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
|
|
3736
|
+
let params = (paramsOrCallback ||
|
|
3737
|
+
{}) as Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get;
|
|
3738
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
3739
|
+
|
|
3740
|
+
if (typeof paramsOrCallback === 'function') {
|
|
3741
|
+
callback = paramsOrCallback;
|
|
3742
|
+
params =
|
|
3743
|
+
{} as Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get;
|
|
3744
|
+
options = {};
|
|
3745
|
+
}
|
|
3746
|
+
|
|
3747
|
+
if (typeof optionsOrCallback === 'function') {
|
|
3748
|
+
callback = optionsOrCallback;
|
|
3749
|
+
options = {};
|
|
3750
|
+
}
|
|
3751
|
+
|
|
3752
|
+
const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/';
|
|
3753
|
+
const parameters = {
|
|
3754
|
+
options: Object.assign(
|
|
3755
|
+
{
|
|
3756
|
+
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
3757
|
+
method: 'GET',
|
|
3758
|
+
},
|
|
3759
|
+
options
|
|
3760
|
+
),
|
|
3761
|
+
params,
|
|
3762
|
+
requiredParams: ['name'],
|
|
3763
|
+
pathParams: ['name'],
|
|
3764
|
+
context: this.context,
|
|
3765
|
+
};
|
|
3766
|
+
if (callback) {
|
|
3767
|
+
createAPIRequest<Schema$Operation>(
|
|
3768
|
+
parameters,
|
|
3769
|
+
callback as BodyResponseCallback<unknown>
|
|
3770
|
+
);
|
|
3771
|
+
} else {
|
|
3772
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
3773
|
+
}
|
|
3774
|
+
}
|
|
3775
|
+
|
|
3776
|
+
/**
|
|
3777
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
3778
|
+
*
|
|
3779
|
+
* @param params - Parameters for request
|
|
3780
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3781
|
+
* @param callback - Optional callback that handles the response.
|
|
3782
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3783
|
+
*/
|
|
3784
|
+
list(
|
|
3785
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List,
|
|
3786
|
+
options: StreamMethodOptions
|
|
3787
|
+
): GaxiosPromise<Readable>;
|
|
3788
|
+
list(
|
|
3789
|
+
params?: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List,
|
|
3790
|
+
options?: MethodOptions
|
|
3791
|
+
): GaxiosPromise<Schema$ListOperationsResponse>;
|
|
3792
|
+
list(
|
|
3793
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List,
|
|
3794
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
3795
|
+
callback: BodyResponseCallback<Readable>
|
|
3796
|
+
): void;
|
|
3797
|
+
list(
|
|
3798
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List,
|
|
3799
|
+
options:
|
|
3800
|
+
| MethodOptions
|
|
3801
|
+
| BodyResponseCallback<Schema$ListOperationsResponse>,
|
|
3802
|
+
callback: BodyResponseCallback<Schema$ListOperationsResponse>
|
|
3803
|
+
): void;
|
|
3804
|
+
list(
|
|
3805
|
+
params: Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List,
|
|
3806
|
+
callback: BodyResponseCallback<Schema$ListOperationsResponse>
|
|
3807
|
+
): void;
|
|
3808
|
+
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
|
|
3809
|
+
list(
|
|
3810
|
+
paramsOrCallback?:
|
|
3811
|
+
| Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List
|
|
3812
|
+
| BodyResponseCallback<Schema$ListOperationsResponse>
|
|
3813
|
+
| BodyResponseCallback<Readable>,
|
|
3814
|
+
optionsOrCallback?:
|
|
3815
|
+
| MethodOptions
|
|
3816
|
+
| StreamMethodOptions
|
|
3817
|
+
| BodyResponseCallback<Schema$ListOperationsResponse>
|
|
3818
|
+
| BodyResponseCallback<Readable>,
|
|
3819
|
+
callback?:
|
|
3820
|
+
| BodyResponseCallback<Schema$ListOperationsResponse>
|
|
3821
|
+
| BodyResponseCallback<Readable>
|
|
3822
|
+
):
|
|
3823
|
+
| void
|
|
3824
|
+
| GaxiosPromise<Schema$ListOperationsResponse>
|
|
3825
|
+
| GaxiosPromise<Readable> {
|
|
3826
|
+
let params = (paramsOrCallback ||
|
|
3827
|
+
{}) as Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List;
|
|
3828
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
3829
|
+
|
|
3830
|
+
if (typeof paramsOrCallback === 'function') {
|
|
3831
|
+
callback = paramsOrCallback;
|
|
3832
|
+
params =
|
|
3833
|
+
{} as Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List;
|
|
3834
|
+
options = {};
|
|
3835
|
+
}
|
|
3836
|
+
|
|
3837
|
+
if (typeof optionsOrCallback === 'function') {
|
|
3838
|
+
callback = optionsOrCallback;
|
|
3839
|
+
options = {};
|
|
3840
|
+
}
|
|
3841
|
+
|
|
3842
|
+
const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/';
|
|
3843
|
+
const parameters = {
|
|
3844
|
+
options: Object.assign(
|
|
3845
|
+
{
|
|
3846
|
+
url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
3847
|
+
method: 'GET',
|
|
3848
|
+
},
|
|
3849
|
+
options
|
|
3850
|
+
),
|
|
3851
|
+
params,
|
|
3852
|
+
requiredParams: ['name'],
|
|
3853
|
+
pathParams: ['name'],
|
|
3854
|
+
context: this.context,
|
|
3855
|
+
};
|
|
3856
|
+
if (callback) {
|
|
3857
|
+
createAPIRequest<Schema$ListOperationsResponse>(
|
|
3858
|
+
parameters,
|
|
3859
|
+
callback as BodyResponseCallback<unknown>
|
|
3860
|
+
);
|
|
3861
|
+
} else {
|
|
3862
|
+
return createAPIRequest<Schema$ListOperationsResponse>(parameters);
|
|
3863
|
+
}
|
|
3864
|
+
}
|
|
3865
|
+
}
|
|
3866
|
+
|
|
3867
|
+
export interface Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Cancel
|
|
3868
|
+
extends StandardParameters {
|
|
3869
|
+
/**
|
|
3870
|
+
* The name of the operation resource to be cancelled.
|
|
3871
|
+
*/
|
|
3872
|
+
name?: string;
|
|
3873
|
+
}
|
|
3874
|
+
export interface Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Delete
|
|
3875
|
+
extends StandardParameters {
|
|
3876
|
+
/**
|
|
3877
|
+
* The name of the operation resource to be deleted.
|
|
3878
|
+
*/
|
|
3879
|
+
name?: string;
|
|
3880
|
+
}
|
|
3881
|
+
export interface Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$Get
|
|
3882
|
+
extends StandardParameters {
|
|
3883
|
+
/**
|
|
3884
|
+
* The name of the operation resource.
|
|
3885
|
+
*/
|
|
3886
|
+
name?: string;
|
|
3887
|
+
}
|
|
3888
|
+
export interface Params$Resource$Projects$Instanceconfigs$Ssdcaches$Operations$List
|
|
3889
|
+
extends StandardParameters {
|
|
3890
|
+
/**
|
|
3891
|
+
* The standard list filter.
|
|
3892
|
+
*/
|
|
3893
|
+
filter?: string;
|
|
3894
|
+
/**
|
|
3895
|
+
* The name of the operation's parent resource.
|
|
3896
|
+
*/
|
|
3897
|
+
name?: string;
|
|
3898
|
+
/**
|
|
3899
|
+
* The standard list page size.
|
|
3900
|
+
*/
|
|
3901
|
+
pageSize?: number;
|
|
3902
|
+
/**
|
|
3903
|
+
* The standard list page token.
|
|
3904
|
+
*/
|
|
3905
|
+
pageToken?: string;
|
|
3906
|
+
}
|
|
3907
|
+
|
|
3366
3908
|
export class Resource$Projects$Instances {
|
|
3367
3909
|
context: APIRequestContext;
|
|
3368
3910
|
backupOperations: Resource$Projects$Instances$Backupoperations;
|