v1.d.ts
36.4 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
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace billingbudgets_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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 Billing Budget API
*
* The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan.
*
* @example
* ```js
* const {google} = require('googleapis');
* const billingbudgets = google.billingbudgets('v1');
* ```
*/
export class Billingbudgets {
context: APIRequestContext;
billingAccounts: Resource$Billingaccounts;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.
*/
export interface Schema$GoogleCloudBillingBudgetsV1Budget {
/**
* Required. Budgeted amount.
*/
amount?: Schema$GoogleCloudBillingBudgetsV1BudgetAmount;
/**
* Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.
*/
budgetFilter?: Schema$GoogleCloudBillingBudgetsV1Filter;
/**
* User data for display name in UI. The name must be less than or equal to 60 characters.
*/
displayName?: string | null;
/**
* Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.
*/
etag?: string | null;
/**
* Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId\}/budgets/{budgetId\}`.
*/
name?: string | null;
/**
* Optional. Rules to apply to notifications sent based on budget spend and thresholds.
*/
notificationsRule?: Schema$GoogleCloudBillingBudgetsV1NotificationsRule;
/**
* Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.
*/
thresholdRules?: Schema$GoogleCloudBillingBudgetsV1ThresholdRule[];
}
/**
* The budgeted amount for each usage period.
*/
export interface Schema$GoogleCloudBillingBudgetsV1BudgetAmount {
/**
* Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period.
*/
lastPeriodAmount?: Schema$GoogleCloudBillingBudgetsV1LastPeriodAmount;
/**
* A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output.
*/
specifiedAmount?: Schema$GoogleTypeMoney;
}
/**
* All date times begin at 12 AM US and Canadian Pacific Time (UTC-8).
*/
export interface Schema$GoogleCloudBillingBudgetsV1CustomPeriod {
/**
* Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date.
*/
endDate?: Schema$GoogleTypeDate;
/**
* Required. The start date must be after January 1, 2017.
*/
startDate?: Schema$GoogleTypeDate;
}
/**
* A filter for a budget, limiting the scope of the cost to calculate.
*/
export interface Schema$GoogleCloudBillingBudgetsV1Filter {
/**
* Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
*/
calendarPeriod?: string | null;
/**
* Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.
*/
creditTypes?: string[] | null;
/**
* Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
*/
creditTypesTreatment?: string | null;
/**
* Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.
*/
customPeriod?: Schema$GoogleCloudBillingBudgetsV1CustomPeriod;
/**
* Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. Currently, multiple entries or multiple values per entry are not allowed. If omitted, the report will include all labeled and unlabeled usage.
*/
labels?: {
[key: string]: any[];
} | null;
/**
* Optional. A set of projects of the form `projects/{project\}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on. Only zero or one project can be specified currently.
*/
projects?: string[] | null;
/**
* Optional. A set of services of the form `services/{service_id\}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.
*/
services?: string[] | null;
/**
* Optional. A set of subaccounts of the form `billingAccounts/{account_id\}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If the field is omitted, the report will include usage from the parent account and all subaccounts, if they exist.
*/
subaccounts?: string[] | null;
}
/**
* Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. Future configuration options will be described here (for example, configuring a percentage of last period's spend). LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period.
*/
export interface Schema$GoogleCloudBillingBudgetsV1LastPeriodAmount {
}
/**
* Response for ListBudgets
*/
export interface Schema$GoogleCloudBillingBudgetsV1ListBudgetsResponse {
/**
* List of the budgets owned by the requested billing account.
*/
budgets?: Schema$GoogleCloudBillingBudgetsV1Budget[];
/**
* If not empty, indicates that there may be more budgets that match the request; this value should be passed in a new `ListBudgetsRequest`.
*/
nextPageToken?: string | null;
}
/**
* NotificationsRule defines notifications that are sent based on budget spend and thresholds.
*/
export interface Schema$GoogleCloudBillingBudgetsV1NotificationsRule {
/**
* Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.
*/
disableDefaultIamRecipients?: boolean | null;
/**
* Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form `projects/{project_id\}/notificationChannels/{channel_id\}`. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.
*/
monitoringNotificationChannels?: string[] | null;
/**
* Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form `projects/{project_id\}/topics/{topic_id\}`. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications for more details. Caller is expected to have `pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details on Pub/Sub roles and permissions.
*/
pubsubTopic?: string | null;
/**
* Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
*/
schemaVersion?: string | null;
}
/**
* ThresholdRule contains a definition of a threshold which triggers an alert (a notification of a threshold being crossed) to be sent when spend goes above the specified amount. Alerts are automatically e-mailed to users with the Billing Account Administrator role or the Billing Account User role. The thresholds here have no effect on notifications sent to anything configured under `Budget.all_updates_rule`.
*/
export interface Schema$GoogleCloudBillingBudgetsV1ThresholdRule {
/**
* Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.
*/
spendBasis?: string | null;
/**
* Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.
*/
thresholdPercent?: number | null;
}
/**
* 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); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$GoogleProtobufEmpty {
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$GoogleTypeDate {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* Represents an amount of money with its currency type.
*/
export interface Schema$GoogleTypeMoney {
/**
* The three-letter currency code defined in ISO 4217.
*/
currencyCode?: string | null;
/**
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number | null;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string | null;
}
export class Resource$Billingaccounts {
context: APIRequestContext;
budgets: Resource$Billingaccounts$Budgets;
constructor(context: APIRequestContext);
}
export class Resource$Billingaccounts$Budgets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/billingbudgets.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const billingbudgets = google.billingbudgets('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-billing',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await billingbudgets.billingAccounts.budgets.create({
* // Required. The name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId\}`.
* parent: 'billingAccounts/my-billingAccount',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "amount": {},
* // "budgetFilter": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "name": "my_name",
* // "notificationsRule": {},
* // "thresholdRules": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "amount": {},
* // "budgetFilter": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "name": "my_name",
* // "notificationsRule": {},
* // "thresholdRules": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Billingaccounts$Budgets$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Billingaccounts$Budgets$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudBillingBudgetsV1Budget>;
create(params: Params$Resource$Billingaccounts$Budgets$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Billingaccounts$Budgets$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>, callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
create(params: Params$Resource$Billingaccounts$Budgets$Create, callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
create(callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
/**
* Deletes a budget. Returns successfully if already deleted.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/billingbudgets.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const billingbudgets = google.billingbudgets('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-billing',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await billingbudgets.billingAccounts.budgets.delete({
* // Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId\}/budgets/{budgetId\}`.
* name: 'billingAccounts/my-billingAccount/budgets/my-budget',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Billingaccounts$Budgets$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Billingaccounts$Budgets$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleProtobufEmpty>;
delete(params: Params$Resource$Billingaccounts$Budgets$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Billingaccounts$Budgets$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(params: Params$Resource$Billingaccounts$Budgets$Delete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
/**
* Returns a budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/billingbudgets.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const billingbudgets = google.billingbudgets('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-billing',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await billingbudgets.billingAccounts.budgets.get({
* // Required. Name of budget to get. Values are of the form `billingAccounts/{billingAccountId\}/budgets/{budgetId\}`.
* name: 'billingAccounts/my-billingAccount/budgets/my-budget',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "amount": {},
* // "budgetFilter": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "name": "my_name",
* // "notificationsRule": {},
* // "thresholdRules": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Billingaccounts$Budgets$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Billingaccounts$Budgets$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudBillingBudgetsV1Budget>;
get(params: Params$Resource$Billingaccounts$Budgets$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Billingaccounts$Budgets$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>, callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
get(params: Params$Resource$Billingaccounts$Budgets$Get, callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
get(callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
/**
* Returns a list of budgets for a billing account. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/billingbudgets.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const billingbudgets = google.billingbudgets('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-billing',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await billingbudgets.billingAccounts.budgets.list({
* // Optional. The maximum number of budgets to return per page. The default and maximum value are 100.
* pageSize: 'placeholder-value',
* // Optional. The value returned by the last `ListBudgetsResponse` which indicates that this is a continuation of a prior `ListBudgets` call, and that the system should return the next page of data.
* pageToken: 'placeholder-value',
* // Required. Name of billing account to list budgets under. Values are of the form `billingAccounts/{billingAccountId\}`.
* parent: 'billingAccounts/my-billingAccount',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "budgets": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Billingaccounts$Budgets$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Billingaccounts$Budgets$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudBillingBudgetsV1ListBudgetsResponse>;
list(params: Params$Resource$Billingaccounts$Budgets$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Billingaccounts$Budgets$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1ListBudgetsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1ListBudgetsResponse>): void;
list(params: Params$Resource$Billingaccounts$Budgets$List, callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1ListBudgetsResponse>): void;
list(callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1ListBudgetsResponse>): void;
/**
* Updates a budget and returns the updated budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/billingbudgets.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const billingbudgets = google.billingbudgets('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-billing',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await billingbudgets.billingAccounts.budgets.patch({
* // Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId\}/budgets/{budgetId\}`.
* name: 'billingAccounts/my-billingAccount/budgets/my-budget',
* // Optional. Indicates which fields in the provided budget to update. Read-only fields (such as `name`) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See https://developers.google.com/protocol-buffers/docs/proto3#default for more details about default values.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "amount": {},
* // "budgetFilter": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "name": "my_name",
* // "notificationsRule": {},
* // "thresholdRules": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "amount": {},
* // "budgetFilter": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "name": "my_name",
* // "notificationsRule": {},
* // "thresholdRules": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Billingaccounts$Budgets$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Billingaccounts$Budgets$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudBillingBudgetsV1Budget>;
patch(params: Params$Resource$Billingaccounts$Budgets$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Billingaccounts$Budgets$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>, callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
patch(params: Params$Resource$Billingaccounts$Budgets$Patch, callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
patch(callback: BodyResponseCallback<Schema$GoogleCloudBillingBudgetsV1Budget>): void;
}
export interface Params$Resource$Billingaccounts$Budgets$Create extends StandardParameters {
/**
* Required. The name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId\}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudBillingBudgetsV1Budget;
}
export interface Params$Resource$Billingaccounts$Budgets$Delete extends StandardParameters {
/**
* Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId\}/budgets/{budgetId\}`.
*/
name?: string;
}
export interface Params$Resource$Billingaccounts$Budgets$Get extends StandardParameters {
/**
* Required. Name of budget to get. Values are of the form `billingAccounts/{billingAccountId\}/budgets/{budgetId\}`.
*/
name?: string;
}
export interface Params$Resource$Billingaccounts$Budgets$List extends StandardParameters {
/**
* Optional. The maximum number of budgets to return per page. The default and maximum value are 100.
*/
pageSize?: number;
/**
* Optional. The value returned by the last `ListBudgetsResponse` which indicates that this is a continuation of a prior `ListBudgets` call, and that the system should return the next page of data.
*/
pageToken?: string;
/**
* Required. Name of billing account to list budgets under. Values are of the form `billingAccounts/{billingAccountId\}`.
*/
parent?: string;
}
export interface Params$Resource$Billingaccounts$Budgets$Patch extends StandardParameters {
/**
* Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId\}/budgets/{budgetId\}`.
*/
name?: string;
/**
* Optional. Indicates which fields in the provided budget to update. Read-only fields (such as `name`) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See https://developers.google.com/protocol-buffers/docs/proto3#default for more details about default values.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GoogleCloudBillingBudgetsV1Budget;
}
export {};
}