v1beta1.d.ts
38.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace cloudprivatecatalog_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Private Catalog API
*
* Enable cloud users to discover enterprise catalogs and products in their organizations.
*
* @example
* const {google} = require('googleapis');
* const cloudprivatecatalog = google.cloudprivatecatalog('v1beta1');
*
* @namespace cloudprivatecatalog
* @type {Function}
* @version v1beta1
* @variation v1beta1
* @param {object=} options Options for Cloudprivatecatalog
*/
export class Cloudprivatecatalog {
context: APIRequestContext;
folders: Resource$Folders;
organizations: Resource$Organizations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* The readonly representation of a catalog computed with a given resource context.
*/
export interface Schema$GoogleCloudPrivatecatalogV1beta1Catalog {
/**
* Output only. The time when the catalog was created.
*/
createTime?: string | null;
/**
* Output only. The description of the catalog.
*/
description?: string | null;
/**
* Output only. The descriptive name of the catalog as it appears in UIs.
*/
displayName?: string | null;
/**
* Output only. The resource name of the target catalog, in the format of `catalogs/{catalog_id}'.
*/
name?: string | null;
/**
* Output only. The time when the catalog was last updated.
*/
updateTime?: string | null;
}
/**
* The readonly representation of a product computed with a given resource context.
*/
export interface Schema$GoogleCloudPrivatecatalogV1beta1Product {
/**
* Output only. The type of the product asset. It can be one of the following values: * `google.deploymentmanager.Template` * `google.cloudprivatecatalog.ListingOnly`
*/
assetType?: string | null;
/**
* Output only. The time when the product was created.
*/
createTime?: string | null;
/**
* Output only. The display metadata to describe the product. The JSON schema of the metadata differs by Product.asset_type. When the type is `google.deploymentmanager.Template`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 required: - name - description additionalProperties: false ``` When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema is as follows: ``` "$schema": http://json-schema.org/draft-04/schema# type: object properties: name: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 tagline: type: string minLength: 1 maxLength: 100 support_info: type: string minLength: 1 maxLength: 2048 creator: type: string minLength: 1 maxLength: 100 documentation: type: array items: type: object properties: url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" title: type: string minLength: 1 maxLength: 64 description: type: string minLength: 1 maxLength: 2048 signup_url: type: string pattern: "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" required: - name - description - signup_url additionalProperties: false ```
*/
displayMetadata?: {
[key: string]: any;
} | null;
/**
* Output only. The icon URI of the product.
*/
iconUri?: string | null;
/**
* Output only. The resource name of the target product, in the format of `products/a-z*[a-z0-9]'. A unique identifier for the product under a catalog.
*/
name?: string | null;
/**
* Output only. The time when the product was last updated.
*/
updateTime?: string | null;
}
/**
* Response message for PrivateCatalog.SearchCatalogs.
*/
export interface Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse {
/**
* The `Catalog`s computed from the resource context.
*/
catalogs?: Schema$GoogleCloudPrivatecatalogV1beta1Catalog[];
/**
* A pagination token returned from a previous call to SearchCatalogs that indicates from where listing should continue. This field is optional.
*/
nextPageToken?: string | null;
}
/**
* Response message for PrivateCatalog.SearchProducts.
*/
export interface Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse {
/**
* A pagination token returned from a previous call to SearchProducts that indicates from where listing should continue. This field is optional.
*/
nextPageToken?: string | null;
/**
* The `Product` resources computed from the resource context.
*/
products?: Schema$GoogleCloudPrivatecatalogV1beta1Product[];
}
/**
* Response message for PrivateCatalog.SearchVersions.
*/
export interface Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse {
/**
* A pagination token returned from a previous call to SearchVersions that indicates from where the listing should continue. This field is optional.
*/
nextPageToken?: string | null;
/**
* The `Version` resources computed from the resource context.
*/
versions?: Schema$GoogleCloudPrivatecatalogV1beta1Version[];
}
/**
* The consumer representation of a version which is a child resource under a `Product` with asset data.
*/
export interface Schema$GoogleCloudPrivatecatalogV1beta1Version {
/**
* Output only. The asset which has been validated and is ready to be provisioned. See google.cloud.privatecatalogproducer.v1beta.Version.asset for details.
*/
asset?: {
[key: string]: any;
} | null;
/**
* Output only. The time when the version was created.
*/
createTime?: string | null;
/**
* Output only. The user-supplied description of the version. Maximum of 256 characters.
*/
description?: string | null;
/**
* Output only. The resource name of the version, in the format `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0-9]'. A unique identifier for the version under a product.
*/
name?: string | null;
/**
* Output only. The time when the version was last updated.
*/
updateTime?: string | null;
}
export class Resource$Folders {
context: APIRequestContext;
catalogs: Resource$Folders$Catalogs;
products: Resource$Folders$Products;
versions: Resource$Folders$Versions;
constructor(context: APIRequestContext);
}
export class Resource$Folders$Catalogs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.folders.catalogs.search
* @desc Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.folders.catalogs.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}`
* @param {string} params.resource_ Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Folders$Catalogs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>;
search(params: Params$Resource$Folders$Catalogs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
search(params: Params$Resource$Folders$Catalogs$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
}
export interface Params$Resource$Folders$Catalogs$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}`
*/
query?: string;
/**
* Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`
*/
resource?: string;
}
export class Resource$Folders$Products {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.folders.products.search
* @desc Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.folders.products.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`
* @param {string} params.resource_ Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Folders$Products$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>;
search(params: Params$Resource$Folders$Products$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
search(params: Params$Resource$Folders$Products$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
}
export interface Params$Resource$Folders$Products$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`
*/
query?: string;
/**
* Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
*/
resource?: string;
}
export class Resource$Folders$Versions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.folders.versions.search
* @desc Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.folders.versions.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`
* @param {string} params.resource_ Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Folders$Versions$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>;
search(params: Params$Resource$Folders$Versions$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
search(params: Params$Resource$Folders$Versions$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
}
export interface Params$Resource$Folders$Versions$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`
*/
query?: string;
/**
* Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
*/
resource?: string;
}
export class Resource$Organizations {
context: APIRequestContext;
catalogs: Resource$Organizations$Catalogs;
products: Resource$Organizations$Products;
versions: Resource$Organizations$Versions;
constructor(context: APIRequestContext);
}
export class Resource$Organizations$Catalogs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.organizations.catalogs.search
* @desc Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.organizations.catalogs.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}`
* @param {string} params.resource_ Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Organizations$Catalogs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>;
search(params: Params$Resource$Organizations$Catalogs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
search(params: Params$Resource$Organizations$Catalogs$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
}
export interface Params$Resource$Organizations$Catalogs$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}`
*/
query?: string;
/**
* Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`
*/
resource?: string;
}
export class Resource$Organizations$Products {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.organizations.products.search
* @desc Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.organizations.products.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`
* @param {string} params.resource_ Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Organizations$Products$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>;
search(params: Params$Resource$Organizations$Products$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
search(params: Params$Resource$Organizations$Products$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
}
export interface Params$Resource$Organizations$Products$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`
*/
query?: string;
/**
* Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
*/
resource?: string;
}
export class Resource$Organizations$Versions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.organizations.versions.search
* @desc Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.organizations.versions.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`
* @param {string} params.resource_ Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Organizations$Versions$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>;
search(params: Params$Resource$Organizations$Versions$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
search(params: Params$Resource$Organizations$Versions$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
}
export interface Params$Resource$Organizations$Versions$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`
*/
query?: string;
/**
* Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
*/
resource?: string;
}
export class Resource$Projects {
context: APIRequestContext;
catalogs: Resource$Projects$Catalogs;
products: Resource$Projects$Products;
versions: Resource$Projects$Versions;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Catalogs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.projects.catalogs.search
* @desc Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.projects.catalogs.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}`
* @param {string} params.resource_ Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Projects$Catalogs$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>;
search(params: Params$Resource$Projects$Catalogs$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
search(params: Params$Resource$Projects$Catalogs$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse>): void;
}
export interface Params$Resource$Projects$Catalogs$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the catalogs. The supported queries are: * Get a single catalog: `name=catalogs/{catalog_id}`
*/
query?: string;
/**
* Required. The name of the resource context. It can be in following formats: * `projects/{project_id}` * `folders/{folder_id}` * `organizations/{organization_id}`
*/
resource?: string;
}
export class Resource$Projects$Products {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.projects.products.search
* @desc Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.projects.products.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`
* @param {string} params.resource_ Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Projects$Products$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>;
search(params: Params$Resource$Projects$Products$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
search(params: Params$Resource$Projects$Products$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchProductsResponse>): void;
}
export interface Params$Resource$Projects$Products$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the products. The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`
*/
query?: string;
/**
* Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
*/
resource?: string;
}
export class Resource$Projects$Versions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudprivatecatalog.projects.versions.search
* @desc Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.
* @alias cloudprivatecatalog.projects.versions.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of entries that are requested.
* @param {string=} params.pageToken A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.
* @param {string=} params.query The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`
* @param {string} params.resource_ Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Projects$Versions$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>;
search(params: Params$Resource$Projects$Versions$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
search(params: Params$Resource$Projects$Versions$Search, callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse>): void;
}
export interface Params$Resource$Projects$Versions$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of entries that are requested.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.
*/
pageToken?: string;
/**
* The query to filter the versions. Required. The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{version_id}`
*/
query?: string;
/**
* Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
*/
resource?: string;
}
export {};
}