v1beta2.d.ts
47.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
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
/**
* 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 { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace cloudfunctions_v1beta2 {
interface Options extends GlobalOptions {
version: 'v1beta2';
}
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 Functions API
*
* Manages lightweight user-provided functions executed in response to events.
*
* @example
* const {google} = require('googleapis');
* const cloudfunctions = google.cloudfunctions('v1beta2');
*
* @namespace cloudfunctions
* @type {Function}
* @version v1beta2
* @variation v1beta2
* @param {object=} options Options for Cloudfunctions
*/
class Cloudfunctions {
context: APIRequestContext;
operations: Resource$Operations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request for the `CallFunction` method.
*/
interface Schema$CallFunctionRequest {
/**
* Input to be passed to the function.
*/
data?: string;
}
/**
* Response of `CallFunction` method.
*/
interface Schema$CallFunctionResponse {
/**
* Either system or user-function generated error. Set if execution was not
* successful.
*/
error?: string;
/**
* Execution id of function invocation.
*/
executionId?: string;
/**
* Result populated for successful execution of synchronous function. Will
* not be populated if function does not return a result through context.
*/
result?: string;
}
/**
* Describes a Cloud Function that contains user computation executed in
* response to an event. It encapsulate function and triggers configurations.
*/
interface Schema$CloudFunction {
/**
* The amount of memory in MB available for a function. Defaults to 256MB.
*/
availableMemoryMb?: number;
/**
* The name of the function (as defined in source code) that will be
* executed. Defaults to the resource name suffix, if not specified. For
* backward compatibility, if function with given name is not found, then
* the system will try to use function named "function". For
* Node.js this is name of a function exported by the module specified in
* `source_location`.
*/
entryPoint?: string;
/**
* Environment variables that shall be available during function execution.
*/
environmentVariables?: {
[key: string]: string;
};
/**
* A source that fires events in response to a condition in another service.
*/
eventTrigger?: Schema$EventTrigger;
/**
* An HTTPS endpoint type of source that can be triggered via URL.
*/
httpsTrigger?: Schema$HTTPSTrigger;
/**
* Labels associated with this Cloud Function.
*/
labels?: {
[key: string]: string;
};
/**
* Output only. Name of the most recent operation modifying the function. If
* the function status is `DEPLOYING` or `DELETING`, then it points to the
* active operation.
*/
latestOperation?: string;
/**
* The limit on the maximum number of function instances that may coexist at
* a given time. This feature is currently in alpha, available only for
* whitelisted users.
*/
maxInstances?: number;
/**
* A user-defined name of the function. Function names must be unique
* globally and match pattern `projects/x/locations/x/functions/x
*/
name?: string;
/**
* The VPC Network that this cloud function can connect to. It can be either
* the fully-qualified URI, or the short name of the network resource. If
* the short network name is used, the network must belong to the same
* project. Otherwise, it must belong to a project within the same
* organization. The format of this field is either
* `projects/{project}/global/networks/{network}` or `{network}`, where
* {project} is a project id where the network is defined, and {network} is
* the short name of the network. This field is mutually exclusive with
* `vpc_connector` and will be replaced by it. See [the VPC
* documentation](https://cloud.google.com/compute/docs/vpc) for more
* information on connecting Cloud projects. This feature is currently in
* alpha, available only for whitelisted users.
*/
network?: string;
/**
* The runtime in which the function is going to run. If empty, defaults to
* Node.js 6.
*/
runtime?: string;
/**
* The email of the function's service account. If empty, defaults to
* {project_id}@appspot.gserviceaccount.com.
*/
serviceAccount?: string;
/**
* The Google Cloud Storage URL, starting with gs://, pointing to the zip
* archive which contains the function.
*/
sourceArchiveUrl?: string;
/**
* The hosted repository where the function is defined.
*/
sourceRepository?: Schema$SourceRepository;
/**
* The URL pointing to the hosted repository where the function is defined.
* There are supported Cloud Source Repository URLs in the following
* formats: To refer to a specific commit:
* `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x
* To refer to a moveable alias (branch):
* `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x
* In particular, to refer to HEAD use `master` moveable alias. To refer to
* a specific fixed alias (tag):
* `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x
* You may omit `paths/x if you want to use the main directory.
*/
sourceRepositoryUrl?: string;
/**
* The Google Cloud Storage signed URL used for source uploading, generated
* by google.cloud.functions.v1beta2.GenerateUploadUrl
*/
sourceUploadUrl?: string;
/**
* Output only. Status of the function deployment.
*/
status?: string;
/**
* The function execution timeout. Execution is considered failed and can be
* terminated if the function is not completed at the end of the timeout
* period. Defaults to 60 seconds.
*/
timeout?: string;
/**
* Output only. The last update timestamp of a Cloud Function.
*/
updateTime?: string;
/**
* Output only. The version identifier of the Cloud Function. Each
* deployment attempt results in a new version of a function being created.
*/
versionId?: string;
/**
* The VPC Network Connector that this cloud function can connect to. It can
* be either the fully-qualified URI, or the short name of the network
* connector resource. The format of this field is
* `projects/x/locations/x/connectors/x This field is mutually exclusive
* with `network` field and will eventually replace it. See [the VPC
* documentation](https://cloud.google.com/compute/docs/vpc) for more
* information on connecting Cloud projects. This feature is currently in
* alpha, available only for whitelisted users.
*/
vpcConnector?: string;
}
/**
* Describes EventTrigger, used to request events be sent from another
* service.
*/
interface Schema$EventTrigger {
/**
* `event_type` names contain the service that is sending an event and the
* kind of event that was fired. Must be of the form
* `providers/x/eventTypes/x e.g. Directly handle a Message published to
* Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.
* Handle an object changing in Google Cloud Storage:
* `providers/cloud.storage/eventTypes/object.change` Handle a write to the
* Firebase Realtime Database:
* `providers/google.firebase.database/eventTypes/ref.write`
*/
eventType?: string;
/**
* Specifies policy for failed executions.
*/
failurePolicy?: Schema$FailurePolicy;
/**
* Which instance of the source's service should send events. E.g. for
* Pub/Sub this would be a Pub/Sub topic at `projects/x/topics/x. For Google
* Cloud Storage this would be a bucket at `projects/x/buckets/x. For any
* source that only supports one instance per-project, this should be the
* name of the project (`projects/x)
*/
resource?: string;
/**
* The hostname of the service that should be observed. If no string is
* provided, the default service implementing the API will be used. For
* example, `storage.googleapis.com` is the default for all event types in
* the `google.storage` namespace.
*/
service?: string;
}
/**
* Describes the policy in case of function's execution failure. If empty,
* then defaults to ignoring failures (i.e. not retrying them).
*/
interface Schema$FailurePolicy {
/**
* If specified, then the function will be retried in case of a failure.
*/
retry?: Schema$Retry;
}
/**
* Request of `GenerateDownloadUrl` method.
*/
interface Schema$GenerateDownloadUrlRequest {
/**
* The optional version of function.
*/
versionId?: string;
}
/**
* Response of `GenerateDownloadUrl` method.
*/
interface Schema$GenerateDownloadUrlResponse {
/**
* The generated Google Cloud Storage signed URL that should be used for
* function source code download.
*/
downloadUrl?: string;
}
/**
* Request of `GenerateUploadUrl` method.
*/
interface Schema$GenerateUploadUrlRequest {
}
/**
* Response of `GenerateUploadUrl` method.
*/
interface Schema$GenerateUploadUrlResponse {
/**
* The generated Google Cloud Storage signed URL that should be used for a
* function source code upload. The uploaded file should be a zip archive
* which contains a function.
*/
uploadUrl?: string;
}
/**
* Describes HTTPSTrigger, could be used to connect web hooks to function.
*/
interface Schema$HTTPSTrigger {
/**
* Output only. The deployed url for the function.
*/
url?: string;
}
/**
* Response for the `ListFunctions` method.
*/
interface Schema$ListFunctionsResponse {
/**
* The functions that match the request.
*/
functions?: Schema$CloudFunction[];
/**
* If not empty, indicates that there may be more functions that match the
* request; this value should be passed in a new
* google.cloud.functions.v1beta2.ListFunctionsRequest to get more
* functions.
*/
nextPageToken?: string;
}
/**
* The response message for Locations.ListLocations.
*/
interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string;
}
/**
* The response message for Operations.ListOperations.
*/
interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* A resource that represents Google Cloud Platform location.
*/
interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For
* example, "Tokyo".
*/
displayName?: string;
/**
* Cross-service attributes for the location. For example
* {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {
[key: string]: string;
};
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string;
/**
* Service-specific metadata. For example the available capacity at the
* given location.
*/
metadata?: {
[key: string]: any;
};
/**
* Resource name for the location, which may vary between implementations.
* For example: `"projects/example-project/locations/us-east1"`
*/
name?: string;
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
};
/**
* The server-assigned name, which is only unique within the same service
* that originally returns it. If you use the default HTTP mapping, the
* `name` should have the format of `operations/some/unique/name`.
*/
name?: string;
/**
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
};
}
/**
* Metadata describing an Operation
*/
interface Schema$OperationMetadataV1 {
/**
* The original request that started the operation.
*/
request?: {
[key: string]: any;
};
/**
* Target of the operation - for example
* projects/project-1/locations/region-1/functions/function-1
*/
target?: string;
/**
* Type of operation.
*/
type?: string;
/**
* The last update timestamp of the operation.
*/
updateTime?: string;
/**
* Version id of the function created or updated by an API call. This field
* is only populated for Create and Update operations.
*/
versionId?: string;
}
/**
* Metadata describing an Operation
*/
interface Schema$OperationMetadataV1Beta2 {
/**
* The original request that started the operation.
*/
request?: {
[key: string]: any;
};
/**
* Target of the operation - for example
* projects/project-1/locations/region-1/functions/function-1
*/
target?: string;
/**
* Type of operation.
*/
type?: string;
/**
* The last update timestamp of the operation.
*/
updateTime?: string;
/**
* Version id of the function created or updated by an API call. This field
* is only populated for Create and Update operations.
*/
versionId?: string;
}
/**
* Describes the retry policy in case of function's execution failure. A
* function execution will be retried on any failure. A failed execution will
* be retried up to 7 days with an exponential backoff (capped at 10 seconds).
* Retried execution is charged as any other execution.
*/
interface Schema$Retry {
}
/**
* Describes the location of the function source in a remote repository.
*/
interface Schema$SourceRepository {
/**
* The name of the branch from which the function should be fetched.
*/
branch?: string;
/**
* Output only. The id of the revision that was resolved at the moment of
* function creation or update. For example when a user deployed from a
* branch, it will be the revision id of the latest change on this branch at
* that time. If user deployed from revision then this value will be always
* equal to the revision specified by the user.
*/
deployedRevision?: string;
/**
* URL to the hosted repository where the function is defined. Only paths in
* https://source.developers.google.com domain are supported. The path
* should contain the name of the repository.
*/
repositoryUrl?: string;
/**
* The id of the revision that captures the state of the repository from
* which the function should be fetched.
*/
revision?: string;
/**
* The path within the repository where the function is defined. The path
* should point to the directory where Cloud Functions files are located.
* Use "/" if the function is defined directly in the root
* directory of a repository.
*/
sourcePath?: string;
/**
* The name of the tag that captures the state of the repository from which
* the function should be fetched.
*/
tag?: string;
}
/**
* The `Status` type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set
* of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}>;
/**
* A developer-facing error message, which should be in English. Any
* user-facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudfunctions.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use
* this method to poll the operation result at intervals as recommended by
* the API service.
* @alias cloudfunctions.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @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$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudfunctions.operations.list
* @desc Lists operations that match the specified filter in the request. If
* the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE:
* the `name` binding allows API services to override the binding to use
* different resource name schemes, such as `users/x/operations`. To
* override the binding, API services can add a binding such as
* `"/v1/{name=users/x}/operations"` to their service configuration. For
* backwards compatibility, the default name includes the operations
* collection id, however overriding users must ensure the name binding is
* the parent resource, without the operations collection id.
* @alias cloudfunctions.operations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter Required. A filter for matching the requested operations.<br><br> The supported formats of <b>filter</b> are:<br> To query for specific function: <code>project:*,location:*,function:*</code><br> To query for all of the latest operations for a project: <code>project:*,latest:true</code>
* @param {string=} params.name Must not be set.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @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$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
}
interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
interface Params$Resource$Operations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. A filter for matching the requested operations.<br><br> The
* supported formats of <b>filter</b> are:<br> To query for specific
* function: <code>project:*,location:*,function:*</code><br> To query for
* all of the latest operations for a project:
* <code>project:*,latest:true</code>
*/
filter?: string;
/**
* Must not be set.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext);
}
class Resource$Projects$Locations {
context: APIRequestContext;
functions: Resource$Projects$Locations$Functions;
constructor(context: APIRequestContext);
/**
* cloudfunctions.projects.locations.list
* @desc Lists information about the supported locations for this service.
* @alias cloudfunctions.projects.locations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The standard list filter.
* @param {string} params.name The resource that owns the locations collection, if applicable.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @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$Locations$List, options?: MethodOptions): GaxiosPromise<Schema$ListLocationsResponse>;
list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
}
interface Params$Resource$Projects$Locations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The standard list filter.
*/
filter?: string;
/**
* The resource that owns the locations collection, if applicable.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
class Resource$Projects$Locations$Functions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudfunctions.projects.locations.functions.call
* @desc Synchronously invokes a deployed Cloud Function. To be used for
* testing purposes as very limited traffic is allowed. For more information
* on the actual limits refer to [API Calls](
* https://cloud.google.com/functions/quotas#rate_limits).
* @alias cloudfunctions.projects.locations.functions.call
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the function to be called.
* @param {().CallFunctionRequest} 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
*/
call(params?: Params$Resource$Projects$Locations$Functions$Call, options?: MethodOptions): GaxiosPromise<Schema$CallFunctionResponse>;
call(params: Params$Resource$Projects$Locations$Functions$Call, options: MethodOptions | BodyResponseCallback<Schema$CallFunctionResponse>, callback: BodyResponseCallback<Schema$CallFunctionResponse>): void;
call(params: Params$Resource$Projects$Locations$Functions$Call, callback: BodyResponseCallback<Schema$CallFunctionResponse>): void;
call(callback: BodyResponseCallback<Schema$CallFunctionResponse>): void;
/**
* cloudfunctions.projects.locations.functions.create
* @desc Creates a new function. If a function with the given name already
* exists in the specified project, the long running operation will return
* `ALREADY_EXISTS` error.
* @alias cloudfunctions.projects.locations.functions.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.location The project and location in which the function should be created, specified in the format `projects/x/locations/x`
* @param {().CloudFunction} 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$Locations$Functions$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Functions$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Functions$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudfunctions.projects.locations.functions.delete
* @desc Deletes a function with the given name from the specified project.
* If the given function is used by some trigger, the trigger will be
* updated to remove this function.
* @alias cloudfunctions.projects.locations.functions.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the function which should be deleted.
* @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$Locations$Functions$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Functions$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Functions$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudfunctions.projects.locations.functions.generateDownloadUrl
* @desc Returns a signed URL for downloading deployed function source code.
* The URL is only valid for a limited period and should be used within
* minutes after generation. For more information about the signed URL usage
* see: https://cloud.google.com/storage/docs/access-control/signed-urls
* @alias cloudfunctions.projects.locations.functions.generateDownloadUrl
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of function for which source code Google Cloud Storage signed URL should be generated.
* @param {().GenerateDownloadUrlRequest} 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
*/
generateDownloadUrl(params?: Params$Resource$Projects$Locations$Functions$Generatedownloadurl, options?: MethodOptions): GaxiosPromise<Schema$GenerateDownloadUrlResponse>;
generateDownloadUrl(params: Params$Resource$Projects$Locations$Functions$Generatedownloadurl, options: MethodOptions | BodyResponseCallback<Schema$GenerateDownloadUrlResponse>, callback: BodyResponseCallback<Schema$GenerateDownloadUrlResponse>): void;
generateDownloadUrl(params: Params$Resource$Projects$Locations$Functions$Generatedownloadurl, callback: BodyResponseCallback<Schema$GenerateDownloadUrlResponse>): void;
generateDownloadUrl(callback: BodyResponseCallback<Schema$GenerateDownloadUrlResponse>): void;
/**
* cloudfunctions.projects.locations.functions.generateUploadUrl
* @desc Returns a signed URL for uploading a function source code. For more
* information about the signed URL usage see:
* https://cloud.google.com/storage/docs/access-control/signed-urls Once the
* function source code upload is complete, the used signed URL should be
* provided in CreateFunction or UpdateFunction request as a reference to
* the function source code. When uploading source code to the generated
* signed URL, please follow these restrictions: * Source file type should
* be a zip file. * Source file size should not exceed 100MB limit. * No
* credentials should be attached - the signed URLs provide access to the
* target bucket using internal service identity; if credentials were
* attached, the identity from the credentials would be used, but that
* identity does not have permissions to upload files to the URL. When
* making a HTTP PUT request, these two headers need to be specified: *
* `content-type: application/zip` * `x-goog-content-length-range:
* 0,104857600` And this header SHOULD NOT be specified: * `Authorization:
* Bearer YOUR_TOKEN`
* @alias cloudfunctions.projects.locations.functions.generateUploadUrl
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/x/locations/x`.
* @param {().GenerateUploadUrlRequest} 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
*/
generateUploadUrl(params?: Params$Resource$Projects$Locations$Functions$Generateuploadurl, options?: MethodOptions): GaxiosPromise<Schema$GenerateUploadUrlResponse>;
generateUploadUrl(params: Params$Resource$Projects$Locations$Functions$Generateuploadurl, options: MethodOptions | BodyResponseCallback<Schema$GenerateUploadUrlResponse>, callback: BodyResponseCallback<Schema$GenerateUploadUrlResponse>): void;
generateUploadUrl(params: Params$Resource$Projects$Locations$Functions$Generateuploadurl, callback: BodyResponseCallback<Schema$GenerateUploadUrlResponse>): void;
generateUploadUrl(callback: BodyResponseCallback<Schema$GenerateUploadUrlResponse>): void;
/**
* cloudfunctions.projects.locations.functions.get
* @desc Returns a function with the given name from the requested project.
* @alias cloudfunctions.projects.locations.functions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the function which details should be obtained.
* @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$Locations$Functions$Get, options?: MethodOptions): GaxiosPromise<Schema$CloudFunction>;
get(params: Params$Resource$Projects$Locations$Functions$Get, options: MethodOptions | BodyResponseCallback<Schema$CloudFunction>, callback: BodyResponseCallback<Schema$CloudFunction>): void;
get(params: Params$Resource$Projects$Locations$Functions$Get, callback: BodyResponseCallback<Schema$CloudFunction>): void;
get(callback: BodyResponseCallback<Schema$CloudFunction>): void;
/**
* cloudfunctions.projects.locations.functions.list
* @desc Returns a list of functions that belong to the requested project.
* @alias cloudfunctions.projects.locations.functions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.location The project and location from which the function should be listed, specified in the format `projects/x/locations/x` If you want to list functions in all locations, use "-" in place of a location.
* @param {integer=} params.pageSize Maximum number of functions to return per call.
* @param {string=} params.pageToken The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of 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
*/
list(params?: Params$Resource$Projects$Locations$Functions$List, options?: MethodOptions): GaxiosPromise<Schema$ListFunctionsResponse>;
list(params: Params$Resource$Projects$Locations$Functions$List, options: MethodOptions | BodyResponseCallback<Schema$ListFunctionsResponse>, callback: BodyResponseCallback<Schema$ListFunctionsResponse>): void;
list(params: Params$Resource$Projects$Locations$Functions$List, callback: BodyResponseCallback<Schema$ListFunctionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFunctionsResponse>): void;
/**
* cloudfunctions.projects.locations.functions.update
* @desc Updates existing function.
* @alias cloudfunctions.projects.locations.functions.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the function to be updated.
* @param {().CloudFunction} 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
*/
update(params?: Params$Resource$Projects$Locations$Functions$Update, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
update(params: Params$Resource$Projects$Locations$Functions$Update, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
update(params: Params$Resource$Projects$Locations$Functions$Update, callback: BodyResponseCallback<Schema$Operation>): void;
update(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Projects$Locations$Functions$Call extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the function to be called.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CallFunctionRequest;
}
interface Params$Resource$Projects$Locations$Functions$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project and location in which the function should be created,
* specified in the format `projects/x/locations/x`
*/
location?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CloudFunction;
}
interface Params$Resource$Projects$Locations$Functions$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the function which should be deleted.
*/
name?: string;
}
interface Params$Resource$Projects$Locations$Functions$Generatedownloadurl extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of function for which source code Google Cloud Storage signed
* URL should be generated.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GenerateDownloadUrlRequest;
}
interface Params$Resource$Projects$Locations$Functions$Generateuploadurl extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project and location in which the Google Cloud Storage signed URL
* should be generated, specified in the format `projects/x/locations/x`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GenerateUploadUrlRequest;
}
interface Params$Resource$Projects$Locations$Functions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the function which details should be obtained.
*/
name?: string;
}
interface Params$Resource$Projects$Locations$Functions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project and location from which the function should be listed,
* specified in the format `projects/x/locations/x` If you want to list
* functions in all locations, use "-" in place of a location.
*/
location?: string;
/**
* Maximum number of functions to return per call.
*/
pageSize?: number;
/**
* The value returned by the last `ListFunctionsResponse`; indicates that
* this is a continuation of a prior `ListFunctions` call, and that the
* system should return the next page of data.
*/
pageToken?: string;
}
interface Params$Resource$Projects$Locations$Functions$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the function to be updated.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CloudFunction;
}
}