@googleapis/storage 22.0.0 → 22.1.1
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 +14 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +713 -4
- package/build/v1.js +200 -0
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +1184 -4
package/v1.ts
CHANGED
|
@@ -112,6 +112,7 @@ export namespace storage_v1 {
|
|
|
112
112
|
objects: Resource$Objects;
|
|
113
113
|
operations: Resource$Operations;
|
|
114
114
|
projects: Resource$Projects;
|
|
115
|
+
rapidCaches: Resource$Rapidcaches;
|
|
115
116
|
|
|
116
117
|
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
|
|
117
118
|
this.context = {
|
|
@@ -136,6 +137,7 @@ export namespace storage_v1 {
|
|
|
136
137
|
this.objects = new Resource$Objects(this.context);
|
|
137
138
|
this.operations = new Resource$Operations(this.context);
|
|
138
139
|
this.projects = new Resource$Projects(this.context);
|
|
140
|
+
this.rapidCaches = new Resource$Rapidcaches(this.context);
|
|
139
141
|
}
|
|
140
142
|
}
|
|
141
143
|
|
|
@@ -926,6 +928,10 @@ export namespace storage_v1 {
|
|
|
926
928
|
* The name of the managed folder. Required if not specified by URL parameter.
|
|
927
929
|
*/
|
|
928
930
|
name?: string | null;
|
|
931
|
+
/**
|
|
932
|
+
* The rapid cache configuration for the managed folder.
|
|
933
|
+
*/
|
|
934
|
+
rapidCacheConfig?: Schema$RapidCacheConfig;
|
|
929
935
|
/**
|
|
930
936
|
* The link to this managed folder.
|
|
931
937
|
*/
|
|
@@ -1316,6 +1322,106 @@ export namespace storage_v1 {
|
|
|
1316
1322
|
*/
|
|
1317
1323
|
version?: number | null;
|
|
1318
1324
|
}
|
|
1325
|
+
/**
|
|
1326
|
+
* A Rapid Cache instance.
|
|
1327
|
+
*/
|
|
1328
|
+
export interface Schema$RapidCache {
|
|
1329
|
+
/**
|
|
1330
|
+
* The cache-level entry admission policy.
|
|
1331
|
+
*/
|
|
1332
|
+
admissionPolicy?: string | null;
|
|
1333
|
+
/**
|
|
1334
|
+
* The name of the bucket containing this cache instance.
|
|
1335
|
+
*/
|
|
1336
|
+
bucket?: string | null;
|
|
1337
|
+
/**
|
|
1338
|
+
* The type of Rapid Cache this represents. Valid values include: "rapid-cache" and "rapid-cache-ultra".
|
|
1339
|
+
*/
|
|
1340
|
+
cacheType?: string | null;
|
|
1341
|
+
/**
|
|
1342
|
+
* The creation time of the cache instance in RFC 3339 format.
|
|
1343
|
+
*/
|
|
1344
|
+
createTime?: string | null;
|
|
1345
|
+
/**
|
|
1346
|
+
* The ID of the resource, including the project number, bucket name and rapid cache ID.
|
|
1347
|
+
*/
|
|
1348
|
+
id?: string | null;
|
|
1349
|
+
/**
|
|
1350
|
+
* Specifies whether objects are ingested into the cache upon write.
|
|
1351
|
+
*/
|
|
1352
|
+
ingestOnWrite?: boolean | null;
|
|
1353
|
+
/**
|
|
1354
|
+
* The kind of item this is. For Rapid Cache, this is always storage#rapidCache.
|
|
1355
|
+
*/
|
|
1356
|
+
kind?: string | null;
|
|
1357
|
+
/**
|
|
1358
|
+
* True if the cache instance has an active Update long-running operation.
|
|
1359
|
+
*/
|
|
1360
|
+
pendingUpdate?: boolean | null;
|
|
1361
|
+
/**
|
|
1362
|
+
* The ID of the Rapid cache instance.
|
|
1363
|
+
*/
|
|
1364
|
+
rapidCacheId?: string | null;
|
|
1365
|
+
/**
|
|
1366
|
+
* The link to this cache instance.
|
|
1367
|
+
*/
|
|
1368
|
+
selfLink?: string | null;
|
|
1369
|
+
/**
|
|
1370
|
+
* The current state of the cache instance.
|
|
1371
|
+
*/
|
|
1372
|
+
state?: string | null;
|
|
1373
|
+
/**
|
|
1374
|
+
* The TTL of all cache entries in whole seconds. e.g., "7200s".
|
|
1375
|
+
*/
|
|
1376
|
+
ttl?: string | null;
|
|
1377
|
+
/**
|
|
1378
|
+
* The modification time of the cache instance metadata in RFC 3339 format.
|
|
1379
|
+
*/
|
|
1380
|
+
updateTime?: string | null;
|
|
1381
|
+
/**
|
|
1382
|
+
* The zone in which the cache instance is running. For example, us-central1-a.
|
|
1383
|
+
*/
|
|
1384
|
+
zone?: string | null;
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* Configuration options for the rapid cache of a managed folder.
|
|
1388
|
+
*/
|
|
1389
|
+
export interface Schema$RapidCacheConfig {
|
|
1390
|
+
/**
|
|
1391
|
+
* A map of rapid cache IDs to the corresponding `RapidCachePolicy` configurations for a managed folder.
|
|
1392
|
+
*/
|
|
1393
|
+
policies?: {[key: string]: Schema$RapidCachePolicy} | null;
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* The rapid cache policy configuration for a managed folder.
|
|
1397
|
+
*/
|
|
1398
|
+
export interface Schema$RapidCachePolicy {
|
|
1399
|
+
/**
|
|
1400
|
+
* The ingest-on-write policy for objects in the managed folder. When set to `enabled`, objects are automatically ingested into the cache when they are written to the managed folder.
|
|
1401
|
+
*/
|
|
1402
|
+
ingestOnWrite?: string | null;
|
|
1403
|
+
/**
|
|
1404
|
+
* The unique identifier of the rapid cache.
|
|
1405
|
+
*/
|
|
1406
|
+
rapidCacheId?: string | null;
|
|
1407
|
+
}
|
|
1408
|
+
/**
|
|
1409
|
+
* A list of Rapid Caches.
|
|
1410
|
+
*/
|
|
1411
|
+
export interface Schema$RapidCaches {
|
|
1412
|
+
/**
|
|
1413
|
+
* The list of items.
|
|
1414
|
+
*/
|
|
1415
|
+
items?: Schema$RapidCache[];
|
|
1416
|
+
/**
|
|
1417
|
+
* The kind of item this is. For lists of Rapid Caches, this is always storage#rapidCaches.
|
|
1418
|
+
*/
|
|
1419
|
+
kind?: string | null;
|
|
1420
|
+
/**
|
|
1421
|
+
* The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
|
1422
|
+
*/
|
|
1423
|
+
nextPageToken?: string | null;
|
|
1424
|
+
}
|
|
1319
1425
|
/**
|
|
1320
1426
|
* A Relocate Bucket request.
|
|
1321
1427
|
*/
|
|
@@ -8745,6 +8851,7 @@ export namespace storage_v1 {
|
|
|
8745
8851
|
* // "kind": "my_kind",
|
|
8746
8852
|
* // "metageneration": "my_metageneration",
|
|
8747
8853
|
* // "name": "my_name",
|
|
8854
|
+
* // "rapidCacheConfig": {},
|
|
8748
8855
|
* // "selfLink": "my_selfLink",
|
|
8749
8856
|
* // "updateTime": "my_updateTime"
|
|
8750
8857
|
* // }
|
|
@@ -9044,6 +9151,7 @@ export namespace storage_v1 {
|
|
|
9044
9151
|
* // "kind": "my_kind",
|
|
9045
9152
|
* // "metageneration": "my_metageneration",
|
|
9046
9153
|
* // "name": "my_name",
|
|
9154
|
+
* // "rapidCacheConfig": {},
|
|
9047
9155
|
* // "selfLink": "my_selfLink",
|
|
9048
9156
|
* // "updateTime": "my_updateTime"
|
|
9049
9157
|
* // }
|
|
@@ -9059,6 +9167,7 @@ export namespace storage_v1 {
|
|
|
9059
9167
|
* // "kind": "my_kind",
|
|
9060
9168
|
* // "metageneration": "my_metageneration",
|
|
9061
9169
|
* // "name": "my_name",
|
|
9170
|
+
* // "rapidCacheConfig": {},
|
|
9062
9171
|
* // "selfLink": "my_selfLink",
|
|
9063
9172
|
* // "updateTime": "my_updateTime"
|
|
9064
9173
|
* // }
|
|
@@ -9621,6 +9730,176 @@ export namespace storage_v1 {
|
|
|
9621
9730
|
return createAPIRequest<Schema$TestIamPermissionsResponse>(parameters);
|
|
9622
9731
|
}
|
|
9623
9732
|
}
|
|
9733
|
+
|
|
9734
|
+
/**
|
|
9735
|
+
* Updates a managed folder using patch semantics.
|
|
9736
|
+
* @example
|
|
9737
|
+
* ```js
|
|
9738
|
+
* // Before running the sample:
|
|
9739
|
+
* // - Enable the API at:
|
|
9740
|
+
* // https://console.developers.google.com/apis/api/storage.googleapis.com
|
|
9741
|
+
* // - Login into gcloud by running:
|
|
9742
|
+
* // ```sh
|
|
9743
|
+
* // $ gcloud auth application-default login
|
|
9744
|
+
* // ```
|
|
9745
|
+
* // - Install the npm module by running:
|
|
9746
|
+
* // ```sh
|
|
9747
|
+
* // $ npm install googleapis
|
|
9748
|
+
* // ```
|
|
9749
|
+
*
|
|
9750
|
+
* const {google} = require('googleapis');
|
|
9751
|
+
* const storage = google.storage('v1');
|
|
9752
|
+
*
|
|
9753
|
+
* async function main() {
|
|
9754
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9755
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9756
|
+
* scopes: [
|
|
9757
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
9758
|
+
* 'https://www.googleapis.com/auth/devstorage.full_control',
|
|
9759
|
+
* 'https://www.googleapis.com/auth/devstorage.read_write',
|
|
9760
|
+
* ],
|
|
9761
|
+
* });
|
|
9762
|
+
*
|
|
9763
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9764
|
+
* const authClient = await auth.getClient();
|
|
9765
|
+
* google.options({auth: authClient});
|
|
9766
|
+
*
|
|
9767
|
+
* // Do the magic
|
|
9768
|
+
* const res = await storage.managedFolders.update({
|
|
9769
|
+
* // The name of the bucket containing the managed folder.
|
|
9770
|
+
* bucket: 'placeholder-value',
|
|
9771
|
+
* // Makes the operation conditional on whether the metageneration of the managed folder matches the specified value.
|
|
9772
|
+
* ifMetagenerationMatch: 'placeholder-value',
|
|
9773
|
+
* // Makes the operation conditional on whether the metageneration of the managed folder doesn't match the specified value.
|
|
9774
|
+
* ifMetagenerationNotMatch: 'placeholder-value',
|
|
9775
|
+
* // The name of the managed folder.
|
|
9776
|
+
* managedFolder: 'placeholder-value',
|
|
9777
|
+
*
|
|
9778
|
+
* // Request body metadata
|
|
9779
|
+
* requestBody: {
|
|
9780
|
+
* // request body parameters
|
|
9781
|
+
* // {
|
|
9782
|
+
* // "bucket": "my_bucket",
|
|
9783
|
+
* // "createTime": "my_createTime",
|
|
9784
|
+
* // "id": "my_id",
|
|
9785
|
+
* // "kind": "my_kind",
|
|
9786
|
+
* // "metageneration": "my_metageneration",
|
|
9787
|
+
* // "name": "my_name",
|
|
9788
|
+
* // "rapidCacheConfig": {},
|
|
9789
|
+
* // "selfLink": "my_selfLink",
|
|
9790
|
+
* // "updateTime": "my_updateTime"
|
|
9791
|
+
* // }
|
|
9792
|
+
* },
|
|
9793
|
+
* });
|
|
9794
|
+
* console.log(res.data);
|
|
9795
|
+
*
|
|
9796
|
+
* // Example response
|
|
9797
|
+
* // {
|
|
9798
|
+
* // "bucket": "my_bucket",
|
|
9799
|
+
* // "createTime": "my_createTime",
|
|
9800
|
+
* // "id": "my_id",
|
|
9801
|
+
* // "kind": "my_kind",
|
|
9802
|
+
* // "metageneration": "my_metageneration",
|
|
9803
|
+
* // "name": "my_name",
|
|
9804
|
+
* // "rapidCacheConfig": {},
|
|
9805
|
+
* // "selfLink": "my_selfLink",
|
|
9806
|
+
* // "updateTime": "my_updateTime"
|
|
9807
|
+
* // }
|
|
9808
|
+
* }
|
|
9809
|
+
*
|
|
9810
|
+
* main().catch(e => {
|
|
9811
|
+
* console.error(e);
|
|
9812
|
+
* throw e;
|
|
9813
|
+
* });
|
|
9814
|
+
*
|
|
9815
|
+
* ```
|
|
9816
|
+
*
|
|
9817
|
+
* @param params - Parameters for request
|
|
9818
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9819
|
+
* @param callback - Optional callback that handles the response.
|
|
9820
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9821
|
+
*/
|
|
9822
|
+
update(
|
|
9823
|
+
params: Params$Resource$Managedfolders$Update,
|
|
9824
|
+
options: StreamMethodOptions
|
|
9825
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
9826
|
+
update(
|
|
9827
|
+
params?: Params$Resource$Managedfolders$Update,
|
|
9828
|
+
options?: MethodOptions
|
|
9829
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$ManagedFolder>>;
|
|
9830
|
+
update(
|
|
9831
|
+
params: Params$Resource$Managedfolders$Update,
|
|
9832
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9833
|
+
callback: BodyResponseCallback<Readable>
|
|
9834
|
+
): void;
|
|
9835
|
+
update(
|
|
9836
|
+
params: Params$Resource$Managedfolders$Update,
|
|
9837
|
+
options: MethodOptions | BodyResponseCallback<Schema$ManagedFolder>,
|
|
9838
|
+
callback: BodyResponseCallback<Schema$ManagedFolder>
|
|
9839
|
+
): void;
|
|
9840
|
+
update(
|
|
9841
|
+
params: Params$Resource$Managedfolders$Update,
|
|
9842
|
+
callback: BodyResponseCallback<Schema$ManagedFolder>
|
|
9843
|
+
): void;
|
|
9844
|
+
update(callback: BodyResponseCallback<Schema$ManagedFolder>): void;
|
|
9845
|
+
update(
|
|
9846
|
+
paramsOrCallback?:
|
|
9847
|
+
| Params$Resource$Managedfolders$Update
|
|
9848
|
+
| BodyResponseCallback<Schema$ManagedFolder>
|
|
9849
|
+
| BodyResponseCallback<Readable>,
|
|
9850
|
+
optionsOrCallback?:
|
|
9851
|
+
| MethodOptions
|
|
9852
|
+
| StreamMethodOptions
|
|
9853
|
+
| BodyResponseCallback<Schema$ManagedFolder>
|
|
9854
|
+
| BodyResponseCallback<Readable>,
|
|
9855
|
+
callback?:
|
|
9856
|
+
| BodyResponseCallback<Schema$ManagedFolder>
|
|
9857
|
+
| BodyResponseCallback<Readable>
|
|
9858
|
+
):
|
|
9859
|
+
| void
|
|
9860
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$ManagedFolder>>
|
|
9861
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
9862
|
+
let params = (paramsOrCallback ||
|
|
9863
|
+
{}) as Params$Resource$Managedfolders$Update;
|
|
9864
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9865
|
+
|
|
9866
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9867
|
+
callback = paramsOrCallback;
|
|
9868
|
+
params = {} as Params$Resource$Managedfolders$Update;
|
|
9869
|
+
options = {};
|
|
9870
|
+
}
|
|
9871
|
+
|
|
9872
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9873
|
+
callback = optionsOrCallback;
|
|
9874
|
+
options = {};
|
|
9875
|
+
}
|
|
9876
|
+
|
|
9877
|
+
const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
|
|
9878
|
+
const parameters = {
|
|
9879
|
+
options: Object.assign(
|
|
9880
|
+
{
|
|
9881
|
+
url: (
|
|
9882
|
+
rootUrl + '/storage/v1/b/{bucket}/managedFolders/{managedFolder}'
|
|
9883
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
9884
|
+
method: 'PATCH',
|
|
9885
|
+
apiVersion: '',
|
|
9886
|
+
},
|
|
9887
|
+
options
|
|
9888
|
+
),
|
|
9889
|
+
params,
|
|
9890
|
+
requiredParams: ['bucket', 'managedFolder'],
|
|
9891
|
+
pathParams: ['bucket', 'managedFolder'],
|
|
9892
|
+
context: this.context,
|
|
9893
|
+
};
|
|
9894
|
+
if (callback) {
|
|
9895
|
+
createAPIRequest<Schema$ManagedFolder>(
|
|
9896
|
+
parameters,
|
|
9897
|
+
callback as BodyResponseCallback<unknown>
|
|
9898
|
+
);
|
|
9899
|
+
} else {
|
|
9900
|
+
return createAPIRequest<Schema$ManagedFolder>(parameters);
|
|
9901
|
+
}
|
|
9902
|
+
}
|
|
9624
9903
|
}
|
|
9625
9904
|
|
|
9626
9905
|
export interface Params$Resource$Managedfolders$Delete extends StandardParameters {
|
|
@@ -9747,6 +10026,29 @@ export namespace storage_v1 {
|
|
|
9747
10026
|
*/
|
|
9748
10027
|
userProject?: string;
|
|
9749
10028
|
}
|
|
10029
|
+
export interface Params$Resource$Managedfolders$Update extends StandardParameters {
|
|
10030
|
+
/**
|
|
10031
|
+
* The name of the bucket containing the managed folder.
|
|
10032
|
+
*/
|
|
10033
|
+
bucket?: string;
|
|
10034
|
+
/**
|
|
10035
|
+
* Makes the operation conditional on whether the metageneration of the managed folder matches the specified value.
|
|
10036
|
+
*/
|
|
10037
|
+
ifMetagenerationMatch?: string;
|
|
10038
|
+
/**
|
|
10039
|
+
* Makes the operation conditional on whether the metageneration of the managed folder doesn't match the specified value.
|
|
10040
|
+
*/
|
|
10041
|
+
ifMetagenerationNotMatch?: string;
|
|
10042
|
+
/**
|
|
10043
|
+
* The name of the managed folder.
|
|
10044
|
+
*/
|
|
10045
|
+
managedFolder?: string;
|
|
10046
|
+
|
|
10047
|
+
/**
|
|
10048
|
+
* Request body metadata
|
|
10049
|
+
*/
|
|
10050
|
+
requestBody?: Schema$ManagedFolder;
|
|
10051
|
+
}
|
|
9750
10052
|
|
|
9751
10053
|
export class Resource$Notifications {
|
|
9752
10054
|
context: APIRequestContext;
|
|
@@ -11754,7 +12056,10 @@ export namespace storage_v1 {
|
|
|
11754
12056
|
* destinationObject: 'placeholder-value',
|
|
11755
12057
|
* // Apply a predefined set of access controls to the destination object.
|
|
11756
12058
|
* destinationPredefinedAcl: 'placeholder-value',
|
|
11757
|
-
* // Specifies which groups
|
|
12059
|
+
* // Specifies which object context groups to drop from the source object(s) during a compose operation. The accepted value is 'custom'.
|
|
12060
|
+
* // Destination contexts behave as follows:
|
|
12061
|
+
* // - When request body contexts are provided, they override all source contexts.
|
|
12062
|
+
* // - When no request body contexts are provided, source contexts are preserved unless 'dropContextGroups' contains 'custom', in which case all contexts are dropped.
|
|
11758
12063
|
* dropContextGroups: 'placeholder-value',
|
|
11759
12064
|
* // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
11760
12065
|
* ifGenerationMatch: 'placeholder-value',
|
|
@@ -13772,7 +14077,10 @@ export namespace storage_v1 {
|
|
|
13772
14077
|
* destinationObject: 'placeholder-value',
|
|
13773
14078
|
* // Apply a predefined set of access controls to the destination object.
|
|
13774
14079
|
* destinationPredefinedAcl: 'placeholder-value',
|
|
13775
|
-
* // Specifies which groups
|
|
14080
|
+
* // Specifies which object context groups to drop from the source object during a copy operation. The accepted value is 'custom'.
|
|
14081
|
+
* // Destination contexts behave as follows:
|
|
14082
|
+
* // - When request body contexts are provided, they override all source contexts.
|
|
14083
|
+
* // - When no request body contexts are provided, source contexts are preserved unless 'dropContextGroups' contains 'custom', in which case all contexts are dropped.
|
|
13776
14084
|
* dropContextGroups: 'placeholder-value',
|
|
13777
14085
|
* // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
13778
14086
|
* ifGenerationMatch: 'placeholder-value',
|
|
@@ -14549,7 +14857,10 @@ export namespace storage_v1 {
|
|
|
14549
14857
|
*/
|
|
14550
14858
|
destinationPredefinedAcl?: string;
|
|
14551
14859
|
/**
|
|
14552
|
-
* Specifies which groups
|
|
14860
|
+
* Specifies which object context groups to drop from the source object(s) during a compose operation. The accepted value is 'custom'.
|
|
14861
|
+
* Destination contexts behave as follows:
|
|
14862
|
+
* - When request body contexts are provided, they override all source contexts.
|
|
14863
|
+
* - When no request body contexts are provided, source contexts are preserved unless 'dropContextGroups' contains 'custom', in which case all contexts are dropped.
|
|
14553
14864
|
*/
|
|
14554
14865
|
dropContextGroups?: string[];
|
|
14555
14866
|
/**
|
|
@@ -15044,7 +15355,10 @@ export namespace storage_v1 {
|
|
|
15044
15355
|
*/
|
|
15045
15356
|
destinationPredefinedAcl?: string;
|
|
15046
15357
|
/**
|
|
15047
|
-
* Specifies which groups
|
|
15358
|
+
* Specifies which object context groups to drop from the source object during a copy operation. The accepted value is 'custom'.
|
|
15359
|
+
* Destination contexts behave as follows:
|
|
15360
|
+
* - When request body contexts are provided, they override all source contexts.
|
|
15361
|
+
* - When no request body contexts are provided, source contexts are preserved unless 'dropContextGroups' contains 'custom', in which case all contexts are dropped.
|
|
15048
15362
|
*/
|
|
15049
15363
|
dropContextGroups?: string[];
|
|
15050
15364
|
/**
|
|
@@ -16888,4 +17202,870 @@ export namespace storage_v1 {
|
|
|
16888
17202
|
*/
|
|
16889
17203
|
userProject?: string;
|
|
16890
17204
|
}
|
|
17205
|
+
|
|
17206
|
+
export class Resource$Rapidcaches {
|
|
17207
|
+
context: APIRequestContext;
|
|
17208
|
+
constructor(context: APIRequestContext) {
|
|
17209
|
+
this.context = context;
|
|
17210
|
+
}
|
|
17211
|
+
|
|
17212
|
+
/**
|
|
17213
|
+
* Disables a Rapid Cache instance.
|
|
17214
|
+
* @example
|
|
17215
|
+
* ```js
|
|
17216
|
+
* // Before running the sample:
|
|
17217
|
+
* // - Enable the API at:
|
|
17218
|
+
* // https://console.developers.google.com/apis/api/storage.googleapis.com
|
|
17219
|
+
* // - Login into gcloud by running:
|
|
17220
|
+
* // ```sh
|
|
17221
|
+
* // $ gcloud auth application-default login
|
|
17222
|
+
* // ```
|
|
17223
|
+
* // - Install the npm module by running:
|
|
17224
|
+
* // ```sh
|
|
17225
|
+
* // $ npm install googleapis
|
|
17226
|
+
* // ```
|
|
17227
|
+
*
|
|
17228
|
+
* const {google} = require('googleapis');
|
|
17229
|
+
* const storage = google.storage('v1');
|
|
17230
|
+
*
|
|
17231
|
+
* async function main() {
|
|
17232
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17233
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17234
|
+
* scopes: [
|
|
17235
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17236
|
+
* 'https://www.googleapis.com/auth/devstorage.full_control',
|
|
17237
|
+
* 'https://www.googleapis.com/auth/devstorage.read_write',
|
|
17238
|
+
* ],
|
|
17239
|
+
* });
|
|
17240
|
+
*
|
|
17241
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17242
|
+
* const authClient = await auth.getClient();
|
|
17243
|
+
* google.options({auth: authClient});
|
|
17244
|
+
*
|
|
17245
|
+
* // Do the magic
|
|
17246
|
+
* const res = await storage.rapidCaches.disable({
|
|
17247
|
+
* // Name of the parent bucket.
|
|
17248
|
+
* bucket: 'placeholder-value',
|
|
17249
|
+
* // The ID of the requested Rapid Cache instance.
|
|
17250
|
+
* rapidCacheId: 'placeholder-value',
|
|
17251
|
+
* });
|
|
17252
|
+
* console.log(res.data);
|
|
17253
|
+
*
|
|
17254
|
+
* // Example response
|
|
17255
|
+
* // {
|
|
17256
|
+
* // "done": false,
|
|
17257
|
+
* // "error": {},
|
|
17258
|
+
* // "kind": "my_kind",
|
|
17259
|
+
* // "metadata": {},
|
|
17260
|
+
* // "name": "my_name",
|
|
17261
|
+
* // "response": {},
|
|
17262
|
+
* // "selfLink": "my_selfLink"
|
|
17263
|
+
* // }
|
|
17264
|
+
* }
|
|
17265
|
+
*
|
|
17266
|
+
* main().catch(e => {
|
|
17267
|
+
* console.error(e);
|
|
17268
|
+
* throw e;
|
|
17269
|
+
* });
|
|
17270
|
+
*
|
|
17271
|
+
* ```
|
|
17272
|
+
*
|
|
17273
|
+
* @param params - Parameters for request
|
|
17274
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17275
|
+
* @param callback - Optional callback that handles the response.
|
|
17276
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17277
|
+
*/
|
|
17278
|
+
disable(
|
|
17279
|
+
params: Params$Resource$Rapidcaches$Disable,
|
|
17280
|
+
options: StreamMethodOptions
|
|
17281
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17282
|
+
disable(
|
|
17283
|
+
params?: Params$Resource$Rapidcaches$Disable,
|
|
17284
|
+
options?: MethodOptions
|
|
17285
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
17286
|
+
disable(
|
|
17287
|
+
params: Params$Resource$Rapidcaches$Disable,
|
|
17288
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
17289
|
+
callback: BodyResponseCallback<Readable>
|
|
17290
|
+
): void;
|
|
17291
|
+
disable(
|
|
17292
|
+
params: Params$Resource$Rapidcaches$Disable,
|
|
17293
|
+
options:
|
|
17294
|
+
MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
17295
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17296
|
+
): void;
|
|
17297
|
+
disable(
|
|
17298
|
+
params: Params$Resource$Rapidcaches$Disable,
|
|
17299
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17300
|
+
): void;
|
|
17301
|
+
disable(
|
|
17302
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17303
|
+
): void;
|
|
17304
|
+
disable(
|
|
17305
|
+
paramsOrCallback?:
|
|
17306
|
+
| Params$Resource$Rapidcaches$Disable
|
|
17307
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17308
|
+
| BodyResponseCallback<Readable>,
|
|
17309
|
+
optionsOrCallback?:
|
|
17310
|
+
| MethodOptions
|
|
17311
|
+
| StreamMethodOptions
|
|
17312
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17313
|
+
| BodyResponseCallback<Readable>,
|
|
17314
|
+
callback?:
|
|
17315
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17316
|
+
| BodyResponseCallback<Readable>
|
|
17317
|
+
):
|
|
17318
|
+
| void
|
|
17319
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
|
|
17320
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
17321
|
+
let params = (paramsOrCallback ||
|
|
17322
|
+
{}) as Params$Resource$Rapidcaches$Disable;
|
|
17323
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
17324
|
+
|
|
17325
|
+
if (typeof paramsOrCallback === 'function') {
|
|
17326
|
+
callback = paramsOrCallback;
|
|
17327
|
+
params = {} as Params$Resource$Rapidcaches$Disable;
|
|
17328
|
+
options = {};
|
|
17329
|
+
}
|
|
17330
|
+
|
|
17331
|
+
if (typeof optionsOrCallback === 'function') {
|
|
17332
|
+
callback = optionsOrCallback;
|
|
17333
|
+
options = {};
|
|
17334
|
+
}
|
|
17335
|
+
|
|
17336
|
+
const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
|
|
17337
|
+
const parameters = {
|
|
17338
|
+
options: Object.assign(
|
|
17339
|
+
{
|
|
17340
|
+
url: (
|
|
17341
|
+
rootUrl +
|
|
17342
|
+
'/storage/v1/b/{bucket}/rapidCaches/{rapidCacheId}/disable'
|
|
17343
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
17344
|
+
method: 'POST',
|
|
17345
|
+
apiVersion: '',
|
|
17346
|
+
},
|
|
17347
|
+
options
|
|
17348
|
+
),
|
|
17349
|
+
params,
|
|
17350
|
+
requiredParams: ['bucket', 'rapidCacheId'],
|
|
17351
|
+
pathParams: ['bucket', 'rapidCacheId'],
|
|
17352
|
+
context: this.context,
|
|
17353
|
+
};
|
|
17354
|
+
if (callback) {
|
|
17355
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
17356
|
+
parameters,
|
|
17357
|
+
callback as BodyResponseCallback<unknown>
|
|
17358
|
+
);
|
|
17359
|
+
} else {
|
|
17360
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
17361
|
+
}
|
|
17362
|
+
}
|
|
17363
|
+
|
|
17364
|
+
/**
|
|
17365
|
+
* Returns the metadata of a Rapid Cache instance.
|
|
17366
|
+
* @example
|
|
17367
|
+
* ```js
|
|
17368
|
+
* // Before running the sample:
|
|
17369
|
+
* // - Enable the API at:
|
|
17370
|
+
* // https://console.developers.google.com/apis/api/storage.googleapis.com
|
|
17371
|
+
* // - Login into gcloud by running:
|
|
17372
|
+
* // ```sh
|
|
17373
|
+
* // $ gcloud auth application-default login
|
|
17374
|
+
* // ```
|
|
17375
|
+
* // - Install the npm module by running:
|
|
17376
|
+
* // ```sh
|
|
17377
|
+
* // $ npm install googleapis
|
|
17378
|
+
* // ```
|
|
17379
|
+
*
|
|
17380
|
+
* const {google} = require('googleapis');
|
|
17381
|
+
* const storage = google.storage('v1');
|
|
17382
|
+
*
|
|
17383
|
+
* async function main() {
|
|
17384
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17385
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17386
|
+
* scopes: [
|
|
17387
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17388
|
+
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
17389
|
+
* 'https://www.googleapis.com/auth/devstorage.full_control',
|
|
17390
|
+
* 'https://www.googleapis.com/auth/devstorage.read_only',
|
|
17391
|
+
* 'https://www.googleapis.com/auth/devstorage.read_write',
|
|
17392
|
+
* ],
|
|
17393
|
+
* });
|
|
17394
|
+
*
|
|
17395
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17396
|
+
* const authClient = await auth.getClient();
|
|
17397
|
+
* google.options({auth: authClient});
|
|
17398
|
+
*
|
|
17399
|
+
* // Do the magic
|
|
17400
|
+
* const res = await storage.rapidCaches.get({
|
|
17401
|
+
* // Name of the parent bucket.
|
|
17402
|
+
* bucket: 'placeholder-value',
|
|
17403
|
+
* // The ID of the requested Rapid Cache instance.
|
|
17404
|
+
* rapidCacheId: 'placeholder-value',
|
|
17405
|
+
* });
|
|
17406
|
+
* console.log(res.data);
|
|
17407
|
+
*
|
|
17408
|
+
* // Example response
|
|
17409
|
+
* // {
|
|
17410
|
+
* // "admissionPolicy": "my_admissionPolicy",
|
|
17411
|
+
* // "bucket": "my_bucket",
|
|
17412
|
+
* // "cacheType": "my_cacheType",
|
|
17413
|
+
* // "createTime": "my_createTime",
|
|
17414
|
+
* // "id": "my_id",
|
|
17415
|
+
* // "ingestOnWrite": false,
|
|
17416
|
+
* // "kind": "my_kind",
|
|
17417
|
+
* // "pendingUpdate": false,
|
|
17418
|
+
* // "rapidCacheId": "my_rapidCacheId",
|
|
17419
|
+
* // "selfLink": "my_selfLink",
|
|
17420
|
+
* // "state": "my_state",
|
|
17421
|
+
* // "ttl": "my_ttl",
|
|
17422
|
+
* // "updateTime": "my_updateTime",
|
|
17423
|
+
* // "zone": "my_zone"
|
|
17424
|
+
* // }
|
|
17425
|
+
* }
|
|
17426
|
+
*
|
|
17427
|
+
* main().catch(e => {
|
|
17428
|
+
* console.error(e);
|
|
17429
|
+
* throw e;
|
|
17430
|
+
* });
|
|
17431
|
+
*
|
|
17432
|
+
* ```
|
|
17433
|
+
*
|
|
17434
|
+
* @param params - Parameters for request
|
|
17435
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17436
|
+
* @param callback - Optional callback that handles the response.
|
|
17437
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17438
|
+
*/
|
|
17439
|
+
get(
|
|
17440
|
+
params: Params$Resource$Rapidcaches$Get,
|
|
17441
|
+
options: StreamMethodOptions
|
|
17442
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17443
|
+
get(
|
|
17444
|
+
params?: Params$Resource$Rapidcaches$Get,
|
|
17445
|
+
options?: MethodOptions
|
|
17446
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$RapidCache>>;
|
|
17447
|
+
get(
|
|
17448
|
+
params: Params$Resource$Rapidcaches$Get,
|
|
17449
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
17450
|
+
callback: BodyResponseCallback<Readable>
|
|
17451
|
+
): void;
|
|
17452
|
+
get(
|
|
17453
|
+
params: Params$Resource$Rapidcaches$Get,
|
|
17454
|
+
options: MethodOptions | BodyResponseCallback<Schema$RapidCache>,
|
|
17455
|
+
callback: BodyResponseCallback<Schema$RapidCache>
|
|
17456
|
+
): void;
|
|
17457
|
+
get(
|
|
17458
|
+
params: Params$Resource$Rapidcaches$Get,
|
|
17459
|
+
callback: BodyResponseCallback<Schema$RapidCache>
|
|
17460
|
+
): void;
|
|
17461
|
+
get(callback: BodyResponseCallback<Schema$RapidCache>): void;
|
|
17462
|
+
get(
|
|
17463
|
+
paramsOrCallback?:
|
|
17464
|
+
| Params$Resource$Rapidcaches$Get
|
|
17465
|
+
| BodyResponseCallback<Schema$RapidCache>
|
|
17466
|
+
| BodyResponseCallback<Readable>,
|
|
17467
|
+
optionsOrCallback?:
|
|
17468
|
+
| MethodOptions
|
|
17469
|
+
| StreamMethodOptions
|
|
17470
|
+
| BodyResponseCallback<Schema$RapidCache>
|
|
17471
|
+
| BodyResponseCallback<Readable>,
|
|
17472
|
+
callback?:
|
|
17473
|
+
BodyResponseCallback<Schema$RapidCache> | BodyResponseCallback<Readable>
|
|
17474
|
+
):
|
|
17475
|
+
| void
|
|
17476
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$RapidCache>>
|
|
17477
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
17478
|
+
let params = (paramsOrCallback || {}) as Params$Resource$Rapidcaches$Get;
|
|
17479
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
17480
|
+
|
|
17481
|
+
if (typeof paramsOrCallback === 'function') {
|
|
17482
|
+
callback = paramsOrCallback;
|
|
17483
|
+
params = {} as Params$Resource$Rapidcaches$Get;
|
|
17484
|
+
options = {};
|
|
17485
|
+
}
|
|
17486
|
+
|
|
17487
|
+
if (typeof optionsOrCallback === 'function') {
|
|
17488
|
+
callback = optionsOrCallback;
|
|
17489
|
+
options = {};
|
|
17490
|
+
}
|
|
17491
|
+
|
|
17492
|
+
const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
|
|
17493
|
+
const parameters = {
|
|
17494
|
+
options: Object.assign(
|
|
17495
|
+
{
|
|
17496
|
+
url: (
|
|
17497
|
+
rootUrl + '/storage/v1/b/{bucket}/rapidCaches/{rapidCacheId}'
|
|
17498
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
17499
|
+
method: 'GET',
|
|
17500
|
+
apiVersion: '',
|
|
17501
|
+
},
|
|
17502
|
+
options
|
|
17503
|
+
),
|
|
17504
|
+
params,
|
|
17505
|
+
requiredParams: ['bucket', 'rapidCacheId'],
|
|
17506
|
+
pathParams: ['bucket', 'rapidCacheId'],
|
|
17507
|
+
context: this.context,
|
|
17508
|
+
};
|
|
17509
|
+
if (callback) {
|
|
17510
|
+
createAPIRequest<Schema$RapidCache>(
|
|
17511
|
+
parameters,
|
|
17512
|
+
callback as BodyResponseCallback<unknown>
|
|
17513
|
+
);
|
|
17514
|
+
} else {
|
|
17515
|
+
return createAPIRequest<Schema$RapidCache>(parameters);
|
|
17516
|
+
}
|
|
17517
|
+
}
|
|
17518
|
+
|
|
17519
|
+
/**
|
|
17520
|
+
* Creates a Rapid Cache instance.
|
|
17521
|
+
* @example
|
|
17522
|
+
* ```js
|
|
17523
|
+
* // Before running the sample:
|
|
17524
|
+
* // - Enable the API at:
|
|
17525
|
+
* // https://console.developers.google.com/apis/api/storage.googleapis.com
|
|
17526
|
+
* // - Login into gcloud by running:
|
|
17527
|
+
* // ```sh
|
|
17528
|
+
* // $ gcloud auth application-default login
|
|
17529
|
+
* // ```
|
|
17530
|
+
* // - Install the npm module by running:
|
|
17531
|
+
* // ```sh
|
|
17532
|
+
* // $ npm install googleapis
|
|
17533
|
+
* // ```
|
|
17534
|
+
*
|
|
17535
|
+
* const {google} = require('googleapis');
|
|
17536
|
+
* const storage = google.storage('v1');
|
|
17537
|
+
*
|
|
17538
|
+
* async function main() {
|
|
17539
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17540
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17541
|
+
* scopes: [
|
|
17542
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17543
|
+
* 'https://www.googleapis.com/auth/devstorage.full_control',
|
|
17544
|
+
* 'https://www.googleapis.com/auth/devstorage.read_write',
|
|
17545
|
+
* ],
|
|
17546
|
+
* });
|
|
17547
|
+
*
|
|
17548
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17549
|
+
* const authClient = await auth.getClient();
|
|
17550
|
+
* google.options({auth: authClient});
|
|
17551
|
+
*
|
|
17552
|
+
* // Do the magic
|
|
17553
|
+
* const res = await storage.rapidCaches.insert({
|
|
17554
|
+
* // Name of the parent bucket.
|
|
17555
|
+
* bucket: 'placeholder-value',
|
|
17556
|
+
*
|
|
17557
|
+
* // Request body metadata
|
|
17558
|
+
* requestBody: {
|
|
17559
|
+
* // request body parameters
|
|
17560
|
+
* // {
|
|
17561
|
+
* // "admissionPolicy": "my_admissionPolicy",
|
|
17562
|
+
* // "bucket": "my_bucket",
|
|
17563
|
+
* // "cacheType": "my_cacheType",
|
|
17564
|
+
* // "createTime": "my_createTime",
|
|
17565
|
+
* // "id": "my_id",
|
|
17566
|
+
* // "ingestOnWrite": false,
|
|
17567
|
+
* // "kind": "my_kind",
|
|
17568
|
+
* // "pendingUpdate": false,
|
|
17569
|
+
* // "rapidCacheId": "my_rapidCacheId",
|
|
17570
|
+
* // "selfLink": "my_selfLink",
|
|
17571
|
+
* // "state": "my_state",
|
|
17572
|
+
* // "ttl": "my_ttl",
|
|
17573
|
+
* // "updateTime": "my_updateTime",
|
|
17574
|
+
* // "zone": "my_zone"
|
|
17575
|
+
* // }
|
|
17576
|
+
* },
|
|
17577
|
+
* });
|
|
17578
|
+
* console.log(res.data);
|
|
17579
|
+
*
|
|
17580
|
+
* // Example response
|
|
17581
|
+
* // {
|
|
17582
|
+
* // "done": false,
|
|
17583
|
+
* // "error": {},
|
|
17584
|
+
* // "kind": "my_kind",
|
|
17585
|
+
* // "metadata": {},
|
|
17586
|
+
* // "name": "my_name",
|
|
17587
|
+
* // "response": {},
|
|
17588
|
+
* // "selfLink": "my_selfLink"
|
|
17589
|
+
* // }
|
|
17590
|
+
* }
|
|
17591
|
+
*
|
|
17592
|
+
* main().catch(e => {
|
|
17593
|
+
* console.error(e);
|
|
17594
|
+
* throw e;
|
|
17595
|
+
* });
|
|
17596
|
+
*
|
|
17597
|
+
* ```
|
|
17598
|
+
*
|
|
17599
|
+
* @param params - Parameters for request
|
|
17600
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17601
|
+
* @param callback - Optional callback that handles the response.
|
|
17602
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17603
|
+
*/
|
|
17604
|
+
insert(
|
|
17605
|
+
params: Params$Resource$Rapidcaches$Insert,
|
|
17606
|
+
options: StreamMethodOptions
|
|
17607
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17608
|
+
insert(
|
|
17609
|
+
params?: Params$Resource$Rapidcaches$Insert,
|
|
17610
|
+
options?: MethodOptions
|
|
17611
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
17612
|
+
insert(
|
|
17613
|
+
params: Params$Resource$Rapidcaches$Insert,
|
|
17614
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
17615
|
+
callback: BodyResponseCallback<Readable>
|
|
17616
|
+
): void;
|
|
17617
|
+
insert(
|
|
17618
|
+
params: Params$Resource$Rapidcaches$Insert,
|
|
17619
|
+
options:
|
|
17620
|
+
MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
17621
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17622
|
+
): void;
|
|
17623
|
+
insert(
|
|
17624
|
+
params: Params$Resource$Rapidcaches$Insert,
|
|
17625
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17626
|
+
): void;
|
|
17627
|
+
insert(
|
|
17628
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17629
|
+
): void;
|
|
17630
|
+
insert(
|
|
17631
|
+
paramsOrCallback?:
|
|
17632
|
+
| Params$Resource$Rapidcaches$Insert
|
|
17633
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17634
|
+
| BodyResponseCallback<Readable>,
|
|
17635
|
+
optionsOrCallback?:
|
|
17636
|
+
| MethodOptions
|
|
17637
|
+
| StreamMethodOptions
|
|
17638
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17639
|
+
| BodyResponseCallback<Readable>,
|
|
17640
|
+
callback?:
|
|
17641
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17642
|
+
| BodyResponseCallback<Readable>
|
|
17643
|
+
):
|
|
17644
|
+
| void
|
|
17645
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
|
|
17646
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
17647
|
+
let params = (paramsOrCallback ||
|
|
17648
|
+
{}) as Params$Resource$Rapidcaches$Insert;
|
|
17649
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
17650
|
+
|
|
17651
|
+
if (typeof paramsOrCallback === 'function') {
|
|
17652
|
+
callback = paramsOrCallback;
|
|
17653
|
+
params = {} as Params$Resource$Rapidcaches$Insert;
|
|
17654
|
+
options = {};
|
|
17655
|
+
}
|
|
17656
|
+
|
|
17657
|
+
if (typeof optionsOrCallback === 'function') {
|
|
17658
|
+
callback = optionsOrCallback;
|
|
17659
|
+
options = {};
|
|
17660
|
+
}
|
|
17661
|
+
|
|
17662
|
+
const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
|
|
17663
|
+
const parameters = {
|
|
17664
|
+
options: Object.assign(
|
|
17665
|
+
{
|
|
17666
|
+
url: (rootUrl + '/storage/v1/b/{bucket}/rapidCaches').replace(
|
|
17667
|
+
/([^:]\/)\/+/g,
|
|
17668
|
+
'$1'
|
|
17669
|
+
),
|
|
17670
|
+
method: 'POST',
|
|
17671
|
+
apiVersion: '',
|
|
17672
|
+
},
|
|
17673
|
+
options
|
|
17674
|
+
),
|
|
17675
|
+
params,
|
|
17676
|
+
requiredParams: ['bucket'],
|
|
17677
|
+
pathParams: ['bucket'],
|
|
17678
|
+
context: this.context,
|
|
17679
|
+
};
|
|
17680
|
+
if (callback) {
|
|
17681
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
17682
|
+
parameters,
|
|
17683
|
+
callback as BodyResponseCallback<unknown>
|
|
17684
|
+
);
|
|
17685
|
+
} else {
|
|
17686
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
17687
|
+
}
|
|
17688
|
+
}
|
|
17689
|
+
|
|
17690
|
+
/**
|
|
17691
|
+
* Returns a list of Rapid Cache instances of the bucket.
|
|
17692
|
+
* @example
|
|
17693
|
+
* ```js
|
|
17694
|
+
* // Before running the sample:
|
|
17695
|
+
* // - Enable the API at:
|
|
17696
|
+
* // https://console.developers.google.com/apis/api/storage.googleapis.com
|
|
17697
|
+
* // - Login into gcloud by running:
|
|
17698
|
+
* // ```sh
|
|
17699
|
+
* // $ gcloud auth application-default login
|
|
17700
|
+
* // ```
|
|
17701
|
+
* // - Install the npm module by running:
|
|
17702
|
+
* // ```sh
|
|
17703
|
+
* // $ npm install googleapis
|
|
17704
|
+
* // ```
|
|
17705
|
+
*
|
|
17706
|
+
* const {google} = require('googleapis');
|
|
17707
|
+
* const storage = google.storage('v1');
|
|
17708
|
+
*
|
|
17709
|
+
* async function main() {
|
|
17710
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17711
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17712
|
+
* scopes: [
|
|
17713
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17714
|
+
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
17715
|
+
* 'https://www.googleapis.com/auth/devstorage.full_control',
|
|
17716
|
+
* 'https://www.googleapis.com/auth/devstorage.read_only',
|
|
17717
|
+
* 'https://www.googleapis.com/auth/devstorage.read_write',
|
|
17718
|
+
* ],
|
|
17719
|
+
* });
|
|
17720
|
+
*
|
|
17721
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17722
|
+
* const authClient = await auth.getClient();
|
|
17723
|
+
* google.options({auth: authClient});
|
|
17724
|
+
*
|
|
17725
|
+
* // Do the magic
|
|
17726
|
+
* const res = await storage.rapidCaches.list({
|
|
17727
|
+
* // Name of the parent bucket.
|
|
17728
|
+
* bucket: 'placeholder-value',
|
|
17729
|
+
* // Maximum number of items to return in a single page of responses.
|
|
17730
|
+
* pageSize: 'placeholder-value',
|
|
17731
|
+
* // A previously-returned page token representing part of the larger set of results to view.
|
|
17732
|
+
* pageToken: 'placeholder-value',
|
|
17733
|
+
* });
|
|
17734
|
+
* console.log(res.data);
|
|
17735
|
+
*
|
|
17736
|
+
* // Example response
|
|
17737
|
+
* // {
|
|
17738
|
+
* // "items": [],
|
|
17739
|
+
* // "kind": "my_kind",
|
|
17740
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
17741
|
+
* // }
|
|
17742
|
+
* }
|
|
17743
|
+
*
|
|
17744
|
+
* main().catch(e => {
|
|
17745
|
+
* console.error(e);
|
|
17746
|
+
* throw e;
|
|
17747
|
+
* });
|
|
17748
|
+
*
|
|
17749
|
+
* ```
|
|
17750
|
+
*
|
|
17751
|
+
* @param params - Parameters for request
|
|
17752
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17753
|
+
* @param callback - Optional callback that handles the response.
|
|
17754
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17755
|
+
*/
|
|
17756
|
+
list(
|
|
17757
|
+
params: Params$Resource$Rapidcaches$List,
|
|
17758
|
+
options: StreamMethodOptions
|
|
17759
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17760
|
+
list(
|
|
17761
|
+
params?: Params$Resource$Rapidcaches$List,
|
|
17762
|
+
options?: MethodOptions
|
|
17763
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$RapidCaches>>;
|
|
17764
|
+
list(
|
|
17765
|
+
params: Params$Resource$Rapidcaches$List,
|
|
17766
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
17767
|
+
callback: BodyResponseCallback<Readable>
|
|
17768
|
+
): void;
|
|
17769
|
+
list(
|
|
17770
|
+
params: Params$Resource$Rapidcaches$List,
|
|
17771
|
+
options: MethodOptions | BodyResponseCallback<Schema$RapidCaches>,
|
|
17772
|
+
callback: BodyResponseCallback<Schema$RapidCaches>
|
|
17773
|
+
): void;
|
|
17774
|
+
list(
|
|
17775
|
+
params: Params$Resource$Rapidcaches$List,
|
|
17776
|
+
callback: BodyResponseCallback<Schema$RapidCaches>
|
|
17777
|
+
): void;
|
|
17778
|
+
list(callback: BodyResponseCallback<Schema$RapidCaches>): void;
|
|
17779
|
+
list(
|
|
17780
|
+
paramsOrCallback?:
|
|
17781
|
+
| Params$Resource$Rapidcaches$List
|
|
17782
|
+
| BodyResponseCallback<Schema$RapidCaches>
|
|
17783
|
+
| BodyResponseCallback<Readable>,
|
|
17784
|
+
optionsOrCallback?:
|
|
17785
|
+
| MethodOptions
|
|
17786
|
+
| StreamMethodOptions
|
|
17787
|
+
| BodyResponseCallback<Schema$RapidCaches>
|
|
17788
|
+
| BodyResponseCallback<Readable>,
|
|
17789
|
+
callback?:
|
|
17790
|
+
| BodyResponseCallback<Schema$RapidCaches>
|
|
17791
|
+
| BodyResponseCallback<Readable>
|
|
17792
|
+
):
|
|
17793
|
+
| void
|
|
17794
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$RapidCaches>>
|
|
17795
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
17796
|
+
let params = (paramsOrCallback || {}) as Params$Resource$Rapidcaches$List;
|
|
17797
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
17798
|
+
|
|
17799
|
+
if (typeof paramsOrCallback === 'function') {
|
|
17800
|
+
callback = paramsOrCallback;
|
|
17801
|
+
params = {} as Params$Resource$Rapidcaches$List;
|
|
17802
|
+
options = {};
|
|
17803
|
+
}
|
|
17804
|
+
|
|
17805
|
+
if (typeof optionsOrCallback === 'function') {
|
|
17806
|
+
callback = optionsOrCallback;
|
|
17807
|
+
options = {};
|
|
17808
|
+
}
|
|
17809
|
+
|
|
17810
|
+
const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
|
|
17811
|
+
const parameters = {
|
|
17812
|
+
options: Object.assign(
|
|
17813
|
+
{
|
|
17814
|
+
url: (rootUrl + '/storage/v1/b/{bucket}/rapidCaches').replace(
|
|
17815
|
+
/([^:]\/)\/+/g,
|
|
17816
|
+
'$1'
|
|
17817
|
+
),
|
|
17818
|
+
method: 'GET',
|
|
17819
|
+
apiVersion: '',
|
|
17820
|
+
},
|
|
17821
|
+
options
|
|
17822
|
+
),
|
|
17823
|
+
params,
|
|
17824
|
+
requiredParams: ['bucket'],
|
|
17825
|
+
pathParams: ['bucket'],
|
|
17826
|
+
context: this.context,
|
|
17827
|
+
};
|
|
17828
|
+
if (callback) {
|
|
17829
|
+
createAPIRequest<Schema$RapidCaches>(
|
|
17830
|
+
parameters,
|
|
17831
|
+
callback as BodyResponseCallback<unknown>
|
|
17832
|
+
);
|
|
17833
|
+
} else {
|
|
17834
|
+
return createAPIRequest<Schema$RapidCaches>(parameters);
|
|
17835
|
+
}
|
|
17836
|
+
}
|
|
17837
|
+
|
|
17838
|
+
/**
|
|
17839
|
+
* Updates the configuration of a Rapid Cache instance.
|
|
17840
|
+
* @example
|
|
17841
|
+
* ```js
|
|
17842
|
+
* // Before running the sample:
|
|
17843
|
+
* // - Enable the API at:
|
|
17844
|
+
* // https://console.developers.google.com/apis/api/storage.googleapis.com
|
|
17845
|
+
* // - Login into gcloud by running:
|
|
17846
|
+
* // ```sh
|
|
17847
|
+
* // $ gcloud auth application-default login
|
|
17848
|
+
* // ```
|
|
17849
|
+
* // - Install the npm module by running:
|
|
17850
|
+
* // ```sh
|
|
17851
|
+
* // $ npm install googleapis
|
|
17852
|
+
* // ```
|
|
17853
|
+
*
|
|
17854
|
+
* const {google} = require('googleapis');
|
|
17855
|
+
* const storage = google.storage('v1');
|
|
17856
|
+
*
|
|
17857
|
+
* async function main() {
|
|
17858
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17859
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17860
|
+
* scopes: [
|
|
17861
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17862
|
+
* 'https://www.googleapis.com/auth/devstorage.full_control',
|
|
17863
|
+
* 'https://www.googleapis.com/auth/devstorage.read_write',
|
|
17864
|
+
* ],
|
|
17865
|
+
* });
|
|
17866
|
+
*
|
|
17867
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17868
|
+
* const authClient = await auth.getClient();
|
|
17869
|
+
* google.options({auth: authClient});
|
|
17870
|
+
*
|
|
17871
|
+
* // Do the magic
|
|
17872
|
+
* const res = await storage.rapidCaches.update({
|
|
17873
|
+
* // Name of the parent bucket.
|
|
17874
|
+
* bucket: 'placeholder-value',
|
|
17875
|
+
* // The ID of the requested Rapid Cache instance.
|
|
17876
|
+
* rapidCacheId: 'placeholder-value',
|
|
17877
|
+
*
|
|
17878
|
+
* // Request body metadata
|
|
17879
|
+
* requestBody: {
|
|
17880
|
+
* // request body parameters
|
|
17881
|
+
* // {
|
|
17882
|
+
* // "admissionPolicy": "my_admissionPolicy",
|
|
17883
|
+
* // "bucket": "my_bucket",
|
|
17884
|
+
* // "cacheType": "my_cacheType",
|
|
17885
|
+
* // "createTime": "my_createTime",
|
|
17886
|
+
* // "id": "my_id",
|
|
17887
|
+
* // "ingestOnWrite": false,
|
|
17888
|
+
* // "kind": "my_kind",
|
|
17889
|
+
* // "pendingUpdate": false,
|
|
17890
|
+
* // "rapidCacheId": "my_rapidCacheId",
|
|
17891
|
+
* // "selfLink": "my_selfLink",
|
|
17892
|
+
* // "state": "my_state",
|
|
17893
|
+
* // "ttl": "my_ttl",
|
|
17894
|
+
* // "updateTime": "my_updateTime",
|
|
17895
|
+
* // "zone": "my_zone"
|
|
17896
|
+
* // }
|
|
17897
|
+
* },
|
|
17898
|
+
* });
|
|
17899
|
+
* console.log(res.data);
|
|
17900
|
+
*
|
|
17901
|
+
* // Example response
|
|
17902
|
+
* // {
|
|
17903
|
+
* // "done": false,
|
|
17904
|
+
* // "error": {},
|
|
17905
|
+
* // "kind": "my_kind",
|
|
17906
|
+
* // "metadata": {},
|
|
17907
|
+
* // "name": "my_name",
|
|
17908
|
+
* // "response": {},
|
|
17909
|
+
* // "selfLink": "my_selfLink"
|
|
17910
|
+
* // }
|
|
17911
|
+
* }
|
|
17912
|
+
*
|
|
17913
|
+
* main().catch(e => {
|
|
17914
|
+
* console.error(e);
|
|
17915
|
+
* throw e;
|
|
17916
|
+
* });
|
|
17917
|
+
*
|
|
17918
|
+
* ```
|
|
17919
|
+
*
|
|
17920
|
+
* @param params - Parameters for request
|
|
17921
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
17922
|
+
* @param callback - Optional callback that handles the response.
|
|
17923
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
17924
|
+
*/
|
|
17925
|
+
update(
|
|
17926
|
+
params: Params$Resource$Rapidcaches$Update,
|
|
17927
|
+
options: StreamMethodOptions
|
|
17928
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
17929
|
+
update(
|
|
17930
|
+
params?: Params$Resource$Rapidcaches$Update,
|
|
17931
|
+
options?: MethodOptions
|
|
17932
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
17933
|
+
update(
|
|
17934
|
+
params: Params$Resource$Rapidcaches$Update,
|
|
17935
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
17936
|
+
callback: BodyResponseCallback<Readable>
|
|
17937
|
+
): void;
|
|
17938
|
+
update(
|
|
17939
|
+
params: Params$Resource$Rapidcaches$Update,
|
|
17940
|
+
options:
|
|
17941
|
+
MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
17942
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17943
|
+
): void;
|
|
17944
|
+
update(
|
|
17945
|
+
params: Params$Resource$Rapidcaches$Update,
|
|
17946
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17947
|
+
): void;
|
|
17948
|
+
update(
|
|
17949
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17950
|
+
): void;
|
|
17951
|
+
update(
|
|
17952
|
+
paramsOrCallback?:
|
|
17953
|
+
| Params$Resource$Rapidcaches$Update
|
|
17954
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17955
|
+
| BodyResponseCallback<Readable>,
|
|
17956
|
+
optionsOrCallback?:
|
|
17957
|
+
| MethodOptions
|
|
17958
|
+
| StreamMethodOptions
|
|
17959
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17960
|
+
| BodyResponseCallback<Readable>,
|
|
17961
|
+
callback?:
|
|
17962
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
17963
|
+
| BodyResponseCallback<Readable>
|
|
17964
|
+
):
|
|
17965
|
+
| void
|
|
17966
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
|
|
17967
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
17968
|
+
let params = (paramsOrCallback ||
|
|
17969
|
+
{}) as Params$Resource$Rapidcaches$Update;
|
|
17970
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
17971
|
+
|
|
17972
|
+
if (typeof paramsOrCallback === 'function') {
|
|
17973
|
+
callback = paramsOrCallback;
|
|
17974
|
+
params = {} as Params$Resource$Rapidcaches$Update;
|
|
17975
|
+
options = {};
|
|
17976
|
+
}
|
|
17977
|
+
|
|
17978
|
+
if (typeof optionsOrCallback === 'function') {
|
|
17979
|
+
callback = optionsOrCallback;
|
|
17980
|
+
options = {};
|
|
17981
|
+
}
|
|
17982
|
+
|
|
17983
|
+
const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
|
|
17984
|
+
const parameters = {
|
|
17985
|
+
options: Object.assign(
|
|
17986
|
+
{
|
|
17987
|
+
url: (
|
|
17988
|
+
rootUrl + '/storage/v1/b/{bucket}/rapidCaches/{rapidCacheId}'
|
|
17989
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
17990
|
+
method: 'PATCH',
|
|
17991
|
+
apiVersion: '',
|
|
17992
|
+
},
|
|
17993
|
+
options
|
|
17994
|
+
),
|
|
17995
|
+
params,
|
|
17996
|
+
requiredParams: ['bucket', 'rapidCacheId'],
|
|
17997
|
+
pathParams: ['bucket', 'rapidCacheId'],
|
|
17998
|
+
context: this.context,
|
|
17999
|
+
};
|
|
18000
|
+
if (callback) {
|
|
18001
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
18002
|
+
parameters,
|
|
18003
|
+
callback as BodyResponseCallback<unknown>
|
|
18004
|
+
);
|
|
18005
|
+
} else {
|
|
18006
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
18007
|
+
}
|
|
18008
|
+
}
|
|
18009
|
+
}
|
|
18010
|
+
|
|
18011
|
+
export interface Params$Resource$Rapidcaches$Disable extends StandardParameters {
|
|
18012
|
+
/**
|
|
18013
|
+
* Name of the parent bucket.
|
|
18014
|
+
*/
|
|
18015
|
+
bucket?: string;
|
|
18016
|
+
/**
|
|
18017
|
+
* The ID of the requested Rapid Cache instance.
|
|
18018
|
+
*/
|
|
18019
|
+
rapidCacheId?: string;
|
|
18020
|
+
}
|
|
18021
|
+
export interface Params$Resource$Rapidcaches$Get extends StandardParameters {
|
|
18022
|
+
/**
|
|
18023
|
+
* Name of the parent bucket.
|
|
18024
|
+
*/
|
|
18025
|
+
bucket?: string;
|
|
18026
|
+
/**
|
|
18027
|
+
* The ID of the requested Rapid Cache instance.
|
|
18028
|
+
*/
|
|
18029
|
+
rapidCacheId?: string;
|
|
18030
|
+
}
|
|
18031
|
+
export interface Params$Resource$Rapidcaches$Insert extends StandardParameters {
|
|
18032
|
+
/**
|
|
18033
|
+
* Name of the parent bucket.
|
|
18034
|
+
*/
|
|
18035
|
+
bucket?: string;
|
|
18036
|
+
|
|
18037
|
+
/**
|
|
18038
|
+
* Request body metadata
|
|
18039
|
+
*/
|
|
18040
|
+
requestBody?: Schema$RapidCache;
|
|
18041
|
+
}
|
|
18042
|
+
export interface Params$Resource$Rapidcaches$List extends StandardParameters {
|
|
18043
|
+
/**
|
|
18044
|
+
* Name of the parent bucket.
|
|
18045
|
+
*/
|
|
18046
|
+
bucket?: string;
|
|
18047
|
+
/**
|
|
18048
|
+
* Maximum number of items to return in a single page of responses.
|
|
18049
|
+
*/
|
|
18050
|
+
pageSize?: number;
|
|
18051
|
+
/**
|
|
18052
|
+
* A previously-returned page token representing part of the larger set of results to view.
|
|
18053
|
+
*/
|
|
18054
|
+
pageToken?: string;
|
|
18055
|
+
}
|
|
18056
|
+
export interface Params$Resource$Rapidcaches$Update extends StandardParameters {
|
|
18057
|
+
/**
|
|
18058
|
+
* Name of the parent bucket.
|
|
18059
|
+
*/
|
|
18060
|
+
bucket?: string;
|
|
18061
|
+
/**
|
|
18062
|
+
* The ID of the requested Rapid Cache instance.
|
|
18063
|
+
*/
|
|
18064
|
+
rapidCacheId?: string;
|
|
18065
|
+
|
|
18066
|
+
/**
|
|
18067
|
+
* Request body metadata
|
|
18068
|
+
*/
|
|
18069
|
+
requestBody?: Schema$RapidCache;
|
|
18070
|
+
}
|
|
16891
18071
|
}
|