-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
cloudfunctions-gen.go
3918 lines (3552 loc) · 154 KB
/
cloudfunctions-gen.go
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
// Copyright 2021 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package cloudfunctions provides access to the Cloud Functions API.
//
// For product documentation, see: https://cloud.google.com/functions
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/cloudfunctions/v1"
// ...
// ctx := context.Background()
// cloudfunctionsService, err := cloudfunctions.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for authentication.
//
// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// Other authentication options
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// cloudfunctionsService, err := cloudfunctions.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// cloudfunctionsService, err := cloudfunctions.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package cloudfunctions // import "google.golang.org/api/cloudfunctions/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
const apiId = "cloudfunctions:v1"
const apiName = "cloudfunctions"
const apiVersion = "v1"
const basePath = "https://cloudfunctions.googleapis.com/"
const mtlsBasePath = "https://cloudfunctions.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud Platform data
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := option.WithScopes(
"https://www.googleapis.com/auth/cloud-platform",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Operations = NewOperationsService(s)
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Operations *OperationsService
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewOperationsService(s *Service) *OperationsService {
rs := &OperationsService{s: s}
return rs
}
type OperationsService struct {
s *Service
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Locations = NewProjectsLocationsService(s)
return rs
}
type ProjectsService struct {
s *Service
Locations *ProjectsLocationsService
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
rs := &ProjectsLocationsService{s: s}
rs.Functions = NewProjectsLocationsFunctionsService(s)
return rs
}
type ProjectsLocationsService struct {
s *Service
Functions *ProjectsLocationsFunctionsService
}
func NewProjectsLocationsFunctionsService(s *Service) *ProjectsLocationsFunctionsService {
rs := &ProjectsLocationsFunctionsService{s: s}
return rs
}
type ProjectsLocationsFunctionsService struct {
s *Service
}
// AuditConfig: Specifies the audit configuration for a service. The
// configuration determines which permission types are logged, and what
// identities, if any, are exempted from logging. An AuditConfig must
// have one or more AuditLogConfigs. If there are AuditConfigs for both
// `allServices` and a specific service, the union of the two
// AuditConfigs is used for that service: the log_types specified in
// each AuditConfig are enabled, and the exempted_members in each
// AuditLogConfig are exempted. Example Policy with multiple
// AuditConfigs: { "audit_configs": [ { "service": "allServices",
// "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members":
// [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, {
// "log_type": "ADMIN_READ" } ] }, { "service":
// "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type":
// "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [
// "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy
// enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts
// jose@example.com from DATA_READ logging, and aliya@example.com from
// DATA_WRITE logging.
type AuditConfig struct {
// AuditLogConfigs: The configuration for logging of each type of
// permission.
AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
// Service: Specifies a service that will be enabled for audit logging.
// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
// `allServices` is a special value that covers all services.
Service string `json:"service,omitempty"`
// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AuditLogConfigs") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *AuditConfig) MarshalJSON() ([]byte, error) {
type NoMethod AuditConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AuditLogConfig: Provides the configuration for logging a type of
// permissions. Example: { "audit_log_configs": [ { "log_type":
// "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, {
// "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and
// 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ
// logging.
type AuditLogConfig struct {
// ExemptedMembers: Specifies the identities that do not cause logging
// for this type of permission. Follows the same format of
// Binding.members.
ExemptedMembers []string `json:"exemptedMembers,omitempty"`
// LogType: The log type that this config enables.
//
// Possible values:
// "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
// "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
// "DATA_WRITE" - Data writes. Example: CloudSQL Users create
// "DATA_READ" - Data reads. Example: CloudSQL Users list
LogType string `json:"logType,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExemptedMembers") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *AuditLogConfig) MarshalJSON() ([]byte, error) {
type NoMethod AuditLogConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Binding: Associates `members` with a `role`.
type Binding struct {
// Condition: The condition that is associated with this binding. If the
// condition evaluates to `true`, then this binding applies to the
// current request. If the condition evaluates to `false`, then this
// binding does not apply to the current request. However, a different
// role binding might grant the same role to one or more of the members
// in this binding. To learn which resources support conditions in their
// IAM policies, see the IAM documentation
// (https://cloud.google.com/iam/help/conditions/resource-policies).
Condition *Expr `json:"condition,omitempty"`
// Members: Specifies the identities requesting access for a Cloud
// Platform resource. `members` can have the following values: *
// `allUsers`: A special identifier that represents anyone who is on the
// internet; with or without a Google account. *
// `allAuthenticatedUsers`: A special identifier that represents anyone
// who is authenticated with a Google account or a service account. *
// `user:{emailid}`: An email address that represents a specific Google
// account. For example, `alice@example.com` . *
// `serviceAccount:{emailid}`: An email address that represents a
// service account. For example,
// `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An
// email address that represents a Google group. For example,
// `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An
// email address (plus unique identifier) representing a user that has
// been recently deleted. For example,
// `alice@example.com?uid=123456789012345678901`. If the user is
// recovered, this value reverts to `user:{emailid}` and the recovered
// user retains the role in the binding. *
// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address
// (plus unique identifier) representing a service account that has been
// recently deleted. For example,
// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
// If the service account is undeleted, this value reverts to
// `serviceAccount:{emailid}` and the undeleted service account retains
// the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`:
// An email address (plus unique identifier) representing a Google group
// that has been recently deleted. For example,
// `admins@example.com?uid=123456789012345678901`. If the group is
// recovered, this value reverts to `group:{emailid}` and the recovered
// group retains the role in the binding. * `domain:{domain}`: The G
// Suite domain (primary) that represents all the users of that domain.
// For example, `google.com` or `example.com`.
Members []string `json:"members,omitempty"`
// Role: Role that is assigned to `members`. For example,
// `roles/viewer`, `roles/editor`, or `roles/owner`.
Role string `json:"role,omitempty"`
// ForceSendFields is a list of field names (e.g. "Condition") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Condition") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Binding) MarshalJSON() ([]byte, error) {
type NoMethod Binding
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CallFunctionRequest: Request for the `CallFunction` method.
type CallFunctionRequest struct {
// Data: Required. Input to be passed to the function.
Data string `json:"data,omitempty"`
// ForceSendFields is a list of field names (e.g. "Data") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Data") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CallFunctionRequest) MarshalJSON() ([]byte, error) {
type NoMethod CallFunctionRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CallFunctionResponse: Response of `CallFunction` method.
type CallFunctionResponse struct {
// Error: Either system or user-function generated error. Set if
// execution was not successful.
Error string `json:"error,omitempty"`
// ExecutionId: Execution id of function invocation.
ExecutionId string `json:"executionId,omitempty"`
// Result: Result populated for successful execution of synchronous
// function. Will not be populated if function does not return a result
// through context.
Result string `json:"result,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Error") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Error") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CallFunctionResponse) MarshalJSON() ([]byte, error) {
type NoMethod CallFunctionResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CloudFunction: Describes a Cloud Function that contains user
// computation executed in response to an event. It encapsulate function
// and triggers configurations. Next tag: 35
type CloudFunction struct {
// AvailableMemoryMb: The amount of memory in MB available for a
// function. Defaults to 256MB.
AvailableMemoryMb int64 `json:"availableMemoryMb,omitempty"`
// BuildEnvironmentVariables: Build environment variables that shall be
// available during build time.
BuildEnvironmentVariables map[string]string `json:"buildEnvironmentVariables,omitempty"`
// BuildId: Output only. The Cloud Build ID of the latest successful
// deployment of the function.
BuildId string `json:"buildId,omitempty"`
// BuildWorkerPool: Name of the Cloud Build Custom Worker Pool that
// should be used to build the function. The format of this field is
// `projects/{project}/locations/{region}/workerPools/{workerPool}`
// where {project} and {region} are the project id and region
// respectively where the worker pool is defined and {workerPool} is the
// short name of the worker pool. If the project id is not the same as
// the function, then the Cloud Functions Service Agent
// (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted
// the role Cloud Build Custom Workers Builder
// (roles/cloudbuild.customworkers.builder) in the project.
BuildWorkerPool string `json:"buildWorkerPool,omitempty"`
// Description: User-provided description of a function.
Description string `json:"description,omitempty"`
// EntryPoint: 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 `json:"entryPoint,omitempty"`
// EnvironmentVariables: Environment variables that shall be available
// during function execution.
EnvironmentVariables map[string]string `json:"environmentVariables,omitempty"`
// EventTrigger: A source that fires events in response to a condition
// in another service.
EventTrigger *EventTrigger `json:"eventTrigger,omitempty"`
// HttpsTrigger: An HTTPS endpoint type of source that can be triggered
// via URL.
HttpsTrigger *HttpsTrigger `json:"httpsTrigger,omitempty"`
// IngressSettings: The ingress settings for the function, controlling
// what traffic can reach it.
//
// Possible values:
// "INGRESS_SETTINGS_UNSPECIFIED" - Unspecified.
// "ALLOW_ALL" - Allow HTTP traffic from public and private sources.
// "ALLOW_INTERNAL_ONLY" - Allow HTTP traffic from only private VPC
// sources.
// "ALLOW_INTERNAL_AND_GCLB" - Allow HTTP traffic from private VPC
// sources and through GCLB.
IngressSettings string `json:"ingressSettings,omitempty"`
// Labels: Labels associated with this Cloud Function.
Labels map[string]string `json:"labels,omitempty"`
// MaxInstances: The limit on the maximum number of function instances
// that may coexist at a given time. In some cases, such as rapid
// traffic surges, Cloud Functions may, for a short period of time,
// create more instances than the specified max instances limit. If your
// function cannot tolerate this temporary behavior, you may want to
// factor in a safety margin and set a lower max instances value than
// your function can tolerate. See the Max Instances
// (https://cloud.google.com/functions/docs/max-instances) Guide for
// more details.
MaxInstances int64 `json:"maxInstances,omitempty"`
// Name: A user-defined name of the function. Function names must be
// unique globally and match pattern
// `projects/*/locations/*/functions/*`
Name string `json:"name,omitempty"`
// Network: 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.
Network string `json:"network,omitempty"`
// Runtime: The runtime in which to run the function. Required when
// deploying a new function, optional when updating an existing
// function. For a complete list of possible choices, see the `gcloud`
// command reference (/sdk/gcloud/reference/functions/deploy#--runtime).
Runtime string `json:"runtime,omitempty"`
// SecretEnvironmentVariables: Secret environment variables
// configuration.
SecretEnvironmentVariables []*SecretEnvVar `json:"secretEnvironmentVariables,omitempty"`
// SecretVolumes: Secret volumes configuration.
SecretVolumes []*SecretVolume `json:"secretVolumes,omitempty"`
// ServiceAccountEmail: The email of the function's service account. If
// empty, defaults to `{project_id}@appspot.gserviceaccount.com`.
ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
// SourceArchiveUrl: The Google Cloud Storage URL, starting with gs://,
// pointing to the zip archive which contains the function.
SourceArchiveUrl string `json:"sourceArchiveUrl,omitempty"`
// SourceRepository: **Beta Feature** The source repository where a
// function is hosted.
SourceRepository *SourceRepository `json:"sourceRepository,omitempty"`
// SourceToken: Input only. An identifier for Firebase function sources.
// Disclaimer: This field is only supported for Firebase function
// deployments.
SourceToken string `json:"sourceToken,omitempty"`
// SourceUploadUrl: The Google Cloud Storage signed URL used for source
// uploading, generated by google.cloud.functions.v1.GenerateUploadUrl
SourceUploadUrl string `json:"sourceUploadUrl,omitempty"`
// Status: Output only. Status of the function deployment.
//
// Possible values:
// "CLOUD_FUNCTION_STATUS_UNSPECIFIED" - Not specified. Invalid state.
// "ACTIVE" - Function has been successfully deployed and is serving.
// "OFFLINE" - Function deployment failed and the function isn’t
// serving.
// "DEPLOY_IN_PROGRESS" - Function is being created or updated.
// "DELETE_IN_PROGRESS" - Function is being deleted.
// "UNKNOWN" - Function deployment failed and the function serving
// state is undefined. The function should be updated or deleted to move
// it out of this state.
Status string `json:"status,omitempty"`
// Timeout: 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 `json:"timeout,omitempty"`
// UpdateTime: Output only. The last update timestamp of a Cloud
// Function.
UpdateTime string `json:"updateTime,omitempty"`
// VersionId: Output only. The version identifier of the Cloud Function.
// Each deployment attempt results in a new version of a function being
// created.
VersionId int64 `json:"versionId,omitempty,string"`
// VpcConnector: 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/*/locations/*/connectors/*` 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.
VpcConnector string `json:"vpcConnector,omitempty"`
// VpcConnectorEgressSettings: The egress settings for the connector,
// controlling what traffic is diverted through it.
//
// Possible values:
// "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED" - Unspecified.
// "PRIVATE_RANGES_ONLY" - Use the VPC Access Connector only for
// private IP space from RFC1918.
// "ALL_TRAFFIC" - Force the use of VPC Access Connector for all
// egress traffic from the function.
VpcConnectorEgressSettings string `json:"vpcConnectorEgressSettings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AvailableMemoryMb")
// to unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AvailableMemoryMb") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *CloudFunction) MarshalJSON() ([]byte, error) {
type NoMethod CloudFunction
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// EventTrigger: Describes EventTrigger, used to request events be sent
// from another service.
type EventTrigger struct {
// EventType: Required. The type of event to observe. For example:
// `providers/cloud.storage/eventTypes/object.change` and
// `providers/cloud.pubsub/eventTypes/topic.publish`. Event types match
// pattern `providers/*/eventTypes/*.*`. The pattern contains: 1.
// namespace: For example, `cloud.storage` and
// `google.firebase.analytics`. 2. resource type: The type of resource
// on which event occurs. For example, the Google Cloud Storage API
// includes the type `object`. 3. action: The action that generates the
// event. For example, action for a Google Cloud Storage Object is
// 'change'. These parts are lower case.
EventType string `json:"eventType,omitempty"`
// FailurePolicy: Specifies policy for failed executions.
FailurePolicy *FailurePolicy `json:"failurePolicy,omitempty"`
// Resource: Required. The resource(s) from which to observe events, for
// example, `projects/_/buckets/myBucket`. Not all syntactically correct
// values are accepted by all services. For example: 1. The
// authorization model must support it. Google Cloud Functions only
// allows EventTriggers to be deployed that observe resources in the
// same project as the `CloudFunction`. 2. The resource type must match
// the pattern expected for an `event_type`. For example, an
// `EventTrigger` that has an `event_type` of
// "google.pubsub.topic.publish" should have a resource that matches
// Google Cloud Pub/Sub topics. Additionally, some services may support
// short names when creating an `EventTrigger`. These will always be
// returned in the normalized "long" format. See each *service's*
// documentation for supported formats.
Resource string `json:"resource,omitempty"`
// Service: 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 `json:"service,omitempty"`
// ForceSendFields is a list of field names (e.g. "EventType") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EventType") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *EventTrigger) MarshalJSON() ([]byte, error) {
type NoMethod EventTrigger
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Expr: Represents a textual expression in the Common Expression
// Language (CEL) syntax. CEL is a C-like expression language. The
// syntax and semantics of CEL are documented at
// https://github.com/google/cel-spec. Example (Comparison): title:
// "Summary size limit" description: "Determines if a summary is less
// than 100 chars" expression: "document.summary.size() < 100" Example
// (Equality): title: "Requestor is owner" description: "Determines if
// requestor is the document owner" expression: "document.owner ==
// request.auth.claims.email" Example (Logic): title: "Public documents"
// description: "Determine whether the document should be publicly
// visible" expression: "document.type != 'private' && document.type !=
// 'internal'" Example (Data Manipulation): title: "Notification string"
// description: "Create a notification string with a timestamp."
// expression: "'New message received at ' +
// string(document.create_time)" The exact variables and functions that
// may be referenced within an expression are determined by the service
// that evaluates it. See the service documentation for additional
// information.
type Expr struct {
// Description: Optional. Description of the expression. This is a
// longer text which describes the expression, e.g. when hovered over it
// in a UI.
Description string `json:"description,omitempty"`
// Expression: Textual representation of an expression in Common
// Expression Language syntax.
Expression string `json:"expression,omitempty"`
// Location: Optional. String indicating the location of the expression
// for error reporting, e.g. a file name and a position in the file.
Location string `json:"location,omitempty"`
// Title: Optional. Title for the expression, i.e. a short string
// describing its purpose. This can be used e.g. in UIs which allow to
// enter the expression.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Expr) MarshalJSON() ([]byte, error) {
type NoMethod Expr
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FailurePolicy: Describes the policy in case of function's execution
// failure. If empty, then defaults to ignoring failures (i.e. not
// retrying them).
type FailurePolicy struct {
// Retry: If specified, then the function will be retried in case of a
// failure.
Retry *Retry `json:"retry,omitempty"`
// ForceSendFields is a list of field names (e.g. "Retry") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Retry") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FailurePolicy) MarshalJSON() ([]byte, error) {
type NoMethod FailurePolicy
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GenerateDownloadUrlRequest: Request of `GenerateDownloadUrl` method.
type GenerateDownloadUrlRequest struct {
// VersionId: The optional version of function. If not set, default,
// current version is used.
VersionId uint64 `json:"versionId,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "VersionId") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "VersionId") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GenerateDownloadUrlRequest) MarshalJSON() ([]byte, error) {
type NoMethod GenerateDownloadUrlRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GenerateDownloadUrlResponse: Response of `GenerateDownloadUrl`
// method.
type GenerateDownloadUrlResponse struct {
// DownloadUrl: The generated Google Cloud Storage signed URL that
// should be used for function source code download.
DownloadUrl string `json:"downloadUrl,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DownloadUrl") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DownloadUrl") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GenerateDownloadUrlResponse) MarshalJSON() ([]byte, error) {
type NoMethod GenerateDownloadUrlResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GenerateUploadUrlRequest: Request of `GenerateSourceUploadUrl`
// method.
type GenerateUploadUrlRequest struct {
}
// GenerateUploadUrlResponse: Response of `GenerateSourceUploadUrl`
// method.
type GenerateUploadUrlResponse struct {
// UploadUrl: 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 `json:"uploadUrl,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "UploadUrl") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "UploadUrl") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GenerateUploadUrlResponse) MarshalJSON() ([]byte, error) {
type NoMethod GenerateUploadUrlResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// HttpsTrigger: Describes HttpsTrigger, could be used to connect web
// hooks to function.
type HttpsTrigger struct {
// SecurityLevel: The security level for the function.
//
// Possible values:
// "SECURITY_LEVEL_UNSPECIFIED" - Unspecified.
// "SECURE_ALWAYS" - Requests for a URL that match this handler that
// do not use HTTPS are automatically redirected to the HTTPS URL with
// the same path. Query parameters are reserved for the redirect.
// "SECURE_OPTIONAL" - Both HTTP and HTTPS requests with URLs that
// match the handler succeed without redirects. The application can
// examine the request to determine which protocol was used and respond
// accordingly.
SecurityLevel string `json:"securityLevel,omitempty"`
// Url: Output only. The deployed url for the function.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "SecurityLevel") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SecurityLevel") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *HttpsTrigger) MarshalJSON() ([]byte, error) {
type NoMethod HttpsTrigger
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListFunctionsResponse: Response for the `ListFunctions` method.
type ListFunctionsResponse struct {
// Functions: The functions that match the request.
Functions []*CloudFunction `json:"functions,omitempty"`
// NextPageToken: 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.v1.ListFunctionsRequest to get more
// functions.
NextPageToken string `json:"nextPageToken,omitempty"`
// Unreachable: Locations that could not be reached. The response does
// not include any functions from these locations.
Unreachable []string `json:"unreachable,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Functions") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Functions") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListFunctionsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListFunctionsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListLocationsResponse: The response message for
// Locations.ListLocations.
type ListLocationsResponse struct {
// Locations: A list of locations that matches the specified filter in
// the request.
Locations []*Location `json:"locations,omitempty"`
// NextPageToken: The standard List next-page token.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Locations") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Locations") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListLocationsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListLocationsResponse
raw := NoMethod(*s)