v1.d.ts
42.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
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
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
/**
* 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 firebaserules_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
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;
}
/**
* Firebase Rules API
*
* Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.
*
* @example
* const {google} = require('googleapis');
* const firebaserules = google.firebaserules('v1');
*
* @namespace firebaserules
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Firebaserules
*/
export class Firebaserules {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Arg matchers for the mock function.
*/
export interface Schema$Arg {
/**
* Argument matches any value provided.
*/
anyValue?: Schema$Empty;
/**
* Argument exactly matches value provided.
*/
exactValue?: any | 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$Empty {
}
/**
* `File` containing source content.
*/
export interface Schema$File {
/**
* Textual Content.
*/
content?: string | null;
/**
* Fingerprint (e.g. github sha) associated with the `File`.
*/
fingerprint?: string | null;
/**
* File name.
*/
name?: string | null;
}
/**
* Represents a service-defined function call that was invoked during test execution.
*/
export interface Schema$FunctionCall {
/**
* The arguments that were provided to the function.
*/
args?: any[] | null;
/**
* Name of the function invoked.
*/
function?: string | null;
}
/**
* Mock function definition. Mocks must refer to a function declared by the target service. The type of the function args and result will be inferred at test time. If either the arg or result values are not compatible with function type declaration, the request will be considered invalid. More than one `FunctionMock` may be provided for a given function name so long as the `Arg` matchers are distinct. There may be only one function for a given overload where all `Arg` values are `Arg.any_value`.
*/
export interface Schema$FunctionMock {
/**
* The list of `Arg` values to match. The order in which the arguments are provided is the order in which they must appear in the function invocation.
*/
args?: Schema$Arg[];
/**
* The name of the function. The function name must match one provided by a service declaration.
*/
function?: string | null;
/**
* The mock result of the function call.
*/
result?: Schema$Result;
}
/**
* The response for FirebaseRulesService.GetReleaseExecutable
*/
export interface Schema$GetReleaseExecutableResponse {
/**
* Executable view of the `Ruleset` referenced by the `Release`.
*/
executable?: string | null;
/**
* The Rules runtime version of the executable.
*/
executableVersion?: string | null;
/**
* `Language` used to generate the executable bytes.
*/
language?: string | null;
/**
* `Ruleset` name associated with the `Release` executable.
*/
rulesetName?: string | null;
/**
* Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the sync_time (inclusive).
*/
syncTime?: string | null;
/**
* Timestamp for the most recent `Release.update_time`.
*/
updateTime?: string | null;
}
/**
* Issues include warnings, errors, and deprecation notices.
*/
export interface Schema$Issue {
/**
* Short error description.
*/
description?: string | null;
/**
* The severity of the issue.
*/
severity?: string | null;
/**
* Position of the issue in the `Source`.
*/
sourcePosition?: Schema$SourcePosition;
}
/**
* The response for FirebaseRulesService.ListReleases.
*/
export interface Schema$ListReleasesResponse {
/**
* The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
*/
nextPageToken?: string | null;
/**
* List of `Release` instances.
*/
releases?: Schema$Release[];
}
/**
* The response for FirebaseRulesService.ListRulesets.
*/
export interface Schema$ListRulesetsResponse {
/**
* The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
*/
nextPageToken?: string | null;
/**
* List of `Ruleset` instances.
*/
rulesets?: Schema$Ruleset[];
}
/**
* `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
*/
export interface Schema$Release {
/**
* Time the release was created. Output only.
*/
createTime?: string | null;
/**
* Resource name for the `Release`. `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2` which affords developers a great deal of flexibility in mapping the name to the style that best fits their existing development practices. For example, a name could refer to an environment, an app, a version, or some combination of three. In the table below, for the project name `projects/foo`, the following relative release paths show how flat and structured names might be chosen to match a desired development / deployment strategy. Use Case | Flat Name | Structured Name -------------|---------------------|---------------- Environments | releases/qa | releases/qa Apps | releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa | releases/app1/v2/qa The delimiter between the release name path elements can be almost anything and it should work equally well with the release name list filter, but in many ways the structured paths provide a clearer picture of the relationship between `Release` instances. Format: `projects/{project_id}/releases/{release_id}`
*/
name?: string | null;
/**
* Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
*/
rulesetName?: string | null;
/**
* Time the release was updated. Output only.
*/
updateTime?: string | null;
}
/**
* Possible result values from the function mock invocation.
*/
export interface Schema$Result {
/**
* The result is undefined, meaning the result could not be computed.
*/
undefined?: Schema$Empty;
/**
* The result is an actual value. The type of the value must match that of the type declared by the service.
*/
value?: any | null;
}
/**
* `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
*/
export interface Schema$Ruleset {
/**
* Time the `Ruleset` was created. Output only.
*/
createTime?: string | null;
/**
* Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only.
*/
name?: string | null;
/**
* `Source` for the `Ruleset`.
*/
source?: Schema$Source;
}
/**
* `Source` is one or more `File` messages comprising a logical set of rules.
*/
export interface Schema$Source {
/**
* `File` set constituting the `Source` bundle.
*/
files?: Schema$File[];
}
/**
* Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes.
*/
export interface Schema$SourcePosition {
/**
* First column on the source line associated with the source fragment.
*/
column?: number | null;
/**
* Name of the `File`.
*/
fileName?: string | null;
/**
* Line number of the source fragment. 1-based.
*/
line?: number | null;
}
/**
* `TestCase` messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the `request`, `resource`, and `function_mocks` to mock a function call to a service-provided function. The `request` object represents context present at request-time. The `resource` is the value of the target resource as it appears in persistent storage before the request is executed.
*/
export interface Schema$TestCase {
/**
* Test expectation.
*/
expectation?: string | null;
/**
* Optional function mocks for service-defined functions. If not set, any service defined function is expected to return an error, which may or may not influence the test outcome.
*/
functionMocks?: Schema$FunctionMock[];
/**
* Specifies whether paths (such as request.path) are encoded and how.
*/
pathEncoding?: string | null;
/**
* Request context. The exact format of the request context is service-dependent. See the appropriate service documentation for information about the supported fields and types on the request. Minimally, all services support the following fields and types: Request field | Type ---------------|----------------- auth.uid | `string` auth.token | `map<string, string>` headers | `map<string, string>` method | `string` params | `map<string, string>` path | `string` time | `google.protobuf.Timestamp` If the request value is not well-formed for the service, the request will be rejected as an invalid argument.
*/
request?: any | null;
/**
* Optional resource value as it appears in persistent storage before the request is fulfilled. The resource type depends on the `request.path` value.
*/
resource?: any | null;
}
/**
* Test result message containing the state of the test as well as a description and source position for test failures.
*/
export interface Schema$TestResult {
/**
* Debug messages related to test execution issues encountered during evaluation. Debug messages may be related to too many or too few invocations of function mocks or to runtime errors that occur during evaluation. For example: ```Unable to read variable [name: "resource"]```
*/
debugMessages?: string[] | null;
/**
* Position in the `Source` or `Ruleset` where the principle runtime error occurs. Evaluation of an expression may result in an error. Rules are deny by default, so a `DENY` expectation when an error is generated is valid. When there is a `DENY` with an error, the `SourcePosition` is returned. E.g. `error_position { line: 19 column: 37 }`
*/
errorPosition?: Schema$SourcePosition;
/**
* The set of function calls made to service-defined methods. Function calls are included in the order in which they are encountered during evaluation, are provided for both mocked and unmocked functions, and included on the response regardless of the test `state`.
*/
functionCalls?: Schema$FunctionCall[];
/**
* State of the test.
*/
state?: string | null;
/**
* The set of visited permission expressions for a given test. This returns the positions and evaluation results of all visited permission expressions which were relevant to the test case, e.g. ``` match /path { allow read if: <expr> } ``` For a detailed report of the intermediate evaluation states, see the `expression_reports` field
*/
visitedExpressions?: Schema$VisitedExpression[];
}
/**
* The request for FirebaseRulesService.TestRuleset.
*/
export interface Schema$TestRulesetRequest {
/**
* Optional `Source` to be checked for correctness. This field must not be set when the resource name refers to a `Ruleset`.
*/
source?: Schema$Source;
/**
* Inline `TestSuite` to run.
*/
testSuite?: Schema$TestSuite;
}
/**
* The response for FirebaseRulesService.TestRuleset.
*/
export interface Schema$TestRulesetResponse {
/**
* Syntactic and semantic `Source` issues of varying severity. Issues of `ERROR` severity will prevent tests from executing.
*/
issues?: Schema$Issue[];
/**
* The set of test results given the test cases in the `TestSuite`. The results will appear in the same order as the test cases appear in the `TestSuite`.
*/
testResults?: Schema$TestResult[];
}
/**
* `TestSuite` is a collection of `TestCase` instances that validate the logical correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a `TestRuleset` invocation or as part of a `Release` object as a pre-release check.
*/
export interface Schema$TestSuite {
/**
* Collection of test cases associated with the `TestSuite`.
*/
testCases?: Schema$TestCase[];
}
/**
* The request for FirebaseRulesService.UpdateReleasePatch.
*/
export interface Schema$UpdateReleaseRequest {
/**
* `Release` to update.
*/
release?: Schema$Release;
/**
* Specifies which fields to update.
*/
updateMask?: string | null;
}
/**
* Store the position and access outcome for an expression visited in rules.
*/
export interface Schema$VisitedExpression {
/**
* Position in the `Source` or `Ruleset` where an expression was visited.
*/
sourcePosition?: Schema$SourcePosition;
/**
* The evaluated value for the visited expression, e.g. true/false
*/
value?: any | null;
}
export class Resource$Projects {
context: APIRequestContext;
releases: Resource$Projects$Releases;
rulesets: Resource$Projects$Rulesets;
constructor(context: APIRequestContext);
/**
* firebaserules.projects.test
* @desc Test `Source` for syntactic and semantic correctness. Issues present, if any, will be returned to the caller with a description, severity, and source location. The test method may be executed with `Source` or a `Ruleset` name. Passing `Source` is useful for unit testing new rules. Passing a `Ruleset` name is useful for regression testing an existing rule. The following is an example of `Source` that permits users to upload images to a bucket bearing their user id and matching the correct metadata: _*Example*_ // Users are allowed to subscribe and unsubscribe to the blog. service firebase.storage { match /users/{userId}/images/{imageName} { allow write: if userId == request.auth.uid && (imageName.matches('*.png$') || imageName.matches('*.jpg$')) && resource.mimeType.matches('^image/') } }
* @alias firebaserules.projects.test
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Tests may either provide `source` or a `Ruleset` resource name. For tests against `source`, the resource name must refer to the project: Format: `projects/{project_id}` For tests against a `Ruleset`, this must be the `Ruleset` resource name: Format: `projects/{project_id}/rulesets/{ruleset_id}`
* @param {().TestRulesetRequest} params.resource Request body data
* @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
*/
test(params?: Params$Resource$Projects$Test, options?: MethodOptions): GaxiosPromise<Schema$TestRulesetResponse>;
test(params: Params$Resource$Projects$Test, options: MethodOptions | BodyResponseCallback<Schema$TestRulesetResponse>, callback: BodyResponseCallback<Schema$TestRulesetResponse>): void;
test(params: Params$Resource$Projects$Test, callback: BodyResponseCallback<Schema$TestRulesetResponse>): void;
test(callback: BodyResponseCallback<Schema$TestRulesetResponse>): void;
}
export interface Params$Resource$Projects$Test extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Tests may either provide `source` or a `Ruleset` resource name. For tests against `source`, the resource name must refer to the project: Format: `projects/{project_id}` For tests against a `Ruleset`, this must be the `Ruleset` resource name: Format: `projects/{project_id}/rulesets/{ruleset_id}`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestRulesetRequest;
}
export class Resource$Projects$Releases {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* firebaserules.projects.releases.create
* @desc Create a `Release`. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a `Release` refers to a `Ruleset`, the rules can be enforced by Firebase Rules-enabled services. More than one `Release` may be 'live' concurrently. Consider the following three `Release` names for `projects/foo` and the `Ruleset` to which they refer. Release Name | Ruleset Name --------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/uuid123 projects/foo/releases/prod/beta | projects/foo/rulesets/uuid123 projects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456 The table reflects the `Ruleset` rollout in progress. The `prod` and `prod/beta` releases refer to the same `Ruleset`. However, `prod/v23` refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be updated using the UpdateRelease method.
* @alias firebaserules.projects.releases.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for the project which owns this `Release`. Format: `projects/{project_id}`
* @param {().Release} params.resource Request body data
* @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
*/
create(params?: Params$Resource$Projects$Releases$Create, options?: MethodOptions): GaxiosPromise<Schema$Release>;
create(params: Params$Resource$Projects$Releases$Create, options: MethodOptions | BodyResponseCallback<Schema$Release>, callback: BodyResponseCallback<Schema$Release>): void;
create(params: Params$Resource$Projects$Releases$Create, callback: BodyResponseCallback<Schema$Release>): void;
create(callback: BodyResponseCallback<Schema$Release>): void;
/**
* firebaserules.projects.releases.delete
* @desc Delete a `Release` by resource name.
* @alias firebaserules.projects.releases.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for the `Release` to delete. Format: `projects/{project_id}/releases/{release_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
*/
delete(params?: Params$Resource$Projects$Releases$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Releases$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Releases$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* firebaserules.projects.releases.get
* @desc Get a `Release` by name.
* @alias firebaserules.projects.releases.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_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
*/
get(params?: Params$Resource$Projects$Releases$Get, options?: MethodOptions): GaxiosPromise<Schema$Release>;
get(params: Params$Resource$Projects$Releases$Get, options: MethodOptions | BodyResponseCallback<Schema$Release>, callback: BodyResponseCallback<Schema$Release>): void;
get(params: Params$Resource$Projects$Releases$Get, callback: BodyResponseCallback<Schema$Release>): void;
get(callback: BodyResponseCallback<Schema$Release>): void;
/**
* firebaserules.projects.releases.getExecutable
* @desc Get the `Release` executable to use when enforcing rules.
* @alias firebaserules.projects.releases.getExecutable
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.executableVersion The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.
* @param {string} params.name Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_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
*/
getExecutable(params?: Params$Resource$Projects$Releases$Getexecutable, options?: MethodOptions): GaxiosPromise<Schema$GetReleaseExecutableResponse>;
getExecutable(params: Params$Resource$Projects$Releases$Getexecutable, options: MethodOptions | BodyResponseCallback<Schema$GetReleaseExecutableResponse>, callback: BodyResponseCallback<Schema$GetReleaseExecutableResponse>): void;
getExecutable(params: Params$Resource$Projects$Releases$Getexecutable, callback: BodyResponseCallback<Schema$GetReleaseExecutableResponse>): void;
getExecutable(callback: BodyResponseCallback<Schema$GetReleaseExecutableResponse>): void;
/**
* firebaserules.projects.releases.list
* @desc List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof.
* @alias firebaserules.projects.releases.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter `Release` filter. The list method supports filters with restrictions on the `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used. e.g. `test_suite_name=projects/foo/testsuites/uuid1`
* @param {string} params.name Resource name for the project. Format: `projects/{project_id}`
* @param {integer=} params.pageSize Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.
* @param {string=} params.pageToken Next page token for the next batch of `Release` instances.
* @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
*/
list(params?: Params$Resource$Projects$Releases$List, options?: MethodOptions): GaxiosPromise<Schema$ListReleasesResponse>;
list(params: Params$Resource$Projects$Releases$List, options: MethodOptions | BodyResponseCallback<Schema$ListReleasesResponse>, callback: BodyResponseCallback<Schema$ListReleasesResponse>): void;
list(params: Params$Resource$Projects$Releases$List, callback: BodyResponseCallback<Schema$ListReleasesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListReleasesResponse>): void;
/**
* firebaserules.projects.releases.patch
* @desc Update a `Release` via PATCH. Only updates to the `ruleset_name` and `test_suite_name` fields will be honored. `Release` rename is not supported. To create a `Release` use the CreateRelease method.
* @alias firebaserules.projects.releases.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for the project which owns this `Release`. Format: `projects/{project_id}`
* @param {().UpdateReleaseRequest} params.resource Request body data
* @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
*/
patch(params?: Params$Resource$Projects$Releases$Patch, options?: MethodOptions): GaxiosPromise<Schema$Release>;
patch(params: Params$Resource$Projects$Releases$Patch, options: MethodOptions | BodyResponseCallback<Schema$Release>, callback: BodyResponseCallback<Schema$Release>): void;
patch(params: Params$Resource$Projects$Releases$Patch, callback: BodyResponseCallback<Schema$Release>): void;
patch(callback: BodyResponseCallback<Schema$Release>): void;
}
export interface Params$Resource$Projects$Releases$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name for the project which owns this `Release`. Format: `projects/{project_id}`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Release;
}
export interface Params$Resource$Projects$Releases$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name for the `Release` to delete. Format: `projects/{project_id}/releases/{release_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Releases$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Releases$Getexecutable extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.
*/
executableVersion?: string;
/**
* Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Releases$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* `Release` filter. The list method supports filters with restrictions on the `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used. e.g. `test_suite_name=projects/foo/testsuites/uuid1`
*/
filter?: string;
/**
* Resource name for the project. Format: `projects/{project_id}`
*/
name?: string;
/**
* Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.
*/
pageSize?: number;
/**
* Next page token for the next batch of `Release` instances.
*/
pageToken?: string;
}
export interface Params$Resource$Projects$Releases$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name for the project which owns this `Release`. Format: `projects/{project_id}`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateReleaseRequest;
}
export class Resource$Projects$Rulesets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* firebaserules.projects.rulesets.create
* @desc Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset.
* @alias firebaserules.projects.rulesets.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}`
* @param {().Ruleset} params.resource Request body data
* @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
*/
create(params?: Params$Resource$Projects$Rulesets$Create, options?: MethodOptions): GaxiosPromise<Schema$Ruleset>;
create(params: Params$Resource$Projects$Rulesets$Create, options: MethodOptions | BodyResponseCallback<Schema$Ruleset>, callback: BodyResponseCallback<Schema$Ruleset>): void;
create(params: Params$Resource$Projects$Rulesets$Create, callback: BodyResponseCallback<Schema$Ruleset>): void;
create(callback: BodyResponseCallback<Schema$Ruleset>): void;
/**
* firebaserules.projects.rulesets.delete
* @desc Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.
* @alias firebaserules.projects.rulesets.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_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
*/
delete(params?: Params$Resource$Projects$Rulesets$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Rulesets$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Rulesets$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* firebaserules.projects.rulesets.get
* @desc Get a `Ruleset` by name including the full `Source` contents.
* @alias firebaserules.projects.rulesets.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_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
*/
get(params?: Params$Resource$Projects$Rulesets$Get, options?: MethodOptions): GaxiosPromise<Schema$Ruleset>;
get(params: Params$Resource$Projects$Rulesets$Get, options: MethodOptions | BodyResponseCallback<Schema$Ruleset>, callback: BodyResponseCallback<Schema$Ruleset>): void;
get(params: Params$Resource$Projects$Rulesets$Get, callback: BodyResponseCallback<Schema$Ruleset>): void;
get(callback: BodyResponseCallback<Schema$Ruleset>): void;
/**
* firebaserules.projects.rulesets.list
* @desc List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset.
* @alias firebaserules.projects.rulesets.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`
* @param {string} params.name Resource name for the project. Format: `projects/{project_id}`
* @param {integer=} params.pageSize Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.
* @param {string=} params.pageToken Next page token for loading the next batch of `Ruleset` instances.
* @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
*/
list(params?: Params$Resource$Projects$Rulesets$List, options?: MethodOptions): GaxiosPromise<Schema$ListRulesetsResponse>;
list(params: Params$Resource$Projects$Rulesets$List, options: MethodOptions | BodyResponseCallback<Schema$ListRulesetsResponse>, callback: BodyResponseCallback<Schema$ListRulesetsResponse>): void;
list(params: Params$Resource$Projects$Rulesets$List, callback: BodyResponseCallback<Schema$ListRulesetsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListRulesetsResponse>): void;
}
export interface Params$Resource$Projects$Rulesets$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Ruleset;
}
export interface Params$Resource$Projects$Rulesets$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Rulesets$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_id}`
*/
name?: string;
}
export interface Params$Resource$Projects$Rulesets$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`
*/
filter?: string;
/**
* Resource name for the project. Format: `projects/{project_id}`
*/
name?: string;
/**
* Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.
*/
pageSize?: number;
/**
* Next page token for loading the next batch of `Ruleset` instances.
*/
pageToken?: string;
}
export {};
}