@maxim_mazurok/gapi.client.cloudfunctions-v2beta 0.0.20240118 → 0.0.20240205

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +310 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://cloudfunctions.googleapis.com/$discovery/rest?version=v2beta
12
- // Revision: 20240118
12
+ // Revision: 20240205
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -28,6 +28,7 @@ declare namespace gapi.client {
28
28
  ): void;
29
29
 
30
30
  namespace cloudfunctions {
31
+ interface AbortFunctionUpgradeRequest {}
31
32
  interface AuditConfig {
32
33
  /** The configuration for logging of each type of permission. */
33
34
  auditLogConfigs?: AuditLogConfig[];
@@ -77,6 +78,7 @@ declare namespace gapi.client {
77
78
  /** 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. */
78
79
  workerPool?: string;
79
80
  }
81
+ interface CommitFunctionUpgradeRequest {}
80
82
  interface Date {
81
83
  /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
82
84
  day?: number;
@@ -126,6 +128,8 @@ declare namespace gapi.client {
126
128
  interface Function {
127
129
  /** Describes the Build step of the function that builds a container from the given source. */
128
130
  buildConfig?: BuildConfig;
131
+ /** Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions. */
132
+ createTime?: string;
129
133
  /** User-provided description of a function. */
130
134
  description?: string;
131
135
  /** Describe whether the function is 1st Gen or 2nd Gen. */
@@ -148,6 +152,8 @@ declare namespace gapi.client {
148
152
  stateMessages?: GoogleCloudFunctionsV2betaStateMessage[];
149
153
  /** Output only. The last update timestamp of a Cloud Function. */
150
154
  updateTime?: string;
155
+ /** Output only. UpgradeInfo for this Cloud Function */
156
+ upgradeInfo?: UpgradeInfo;
151
157
  /** Output only. The deployed url for the function. */
152
158
  url?: string;
153
159
  }
@@ -399,6 +405,7 @@ declare namespace gapi.client {
399
405
  /** Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
400
406
  version?: number;
401
407
  }
408
+ interface RedirectFunctionUpgradeTrafficRequest {}
402
409
  interface RepoSource {
403
410
  /** Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */
404
411
  branchName?: string;
@@ -413,6 +420,7 @@ declare namespace gapi.client {
413
420
  /** Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax */
414
421
  tagName?: string;
415
422
  }
423
+ interface RollbackFunctionUpgradeTrafficRequest {}
416
424
  interface Runtime {
417
425
  /** Decommission date for the runtime. */
418
426
  decommissionDate?: Date;
@@ -499,6 +507,7 @@ declare namespace gapi.client {
499
507
  /** OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */
500
508
  updateMask?: string;
501
509
  }
510
+ interface SetupFunctionUpgradeConfigRequest {}
502
511
  interface Source {
503
512
  /** If provided, get the source from GitHub repository. This option is valid only for GCF 1st Gen function. Example: https://github.com///blob// */
504
513
  gitUri?: string;
@@ -539,7 +548,133 @@ declare namespace gapi.client {
539
548
  /** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
540
549
  permissions?: string[];
541
550
  }
551
+ interface UpgradeInfo {
552
+ /** Describes the Build step of the function that builds a container to prepare for 2nd gen upgrade. */
553
+ buildConfig?: BuildConfig;
554
+ /** Describes the Event trigger which has been setup to prepare for 2nd gen upgrade. */
555
+ eventTrigger?: EventTrigger;
556
+ /** Describes the Cloud Run service which has been setup to prepare for 2nd gen upgrade. */
557
+ serviceConfig?: ServiceConfig;
558
+ /** UpgradeState of the function */
559
+ upgradeState?: string;
560
+ }
542
561
  interface FunctionsResource {
562
+ /** Aborts generation upgrade process for a function with the given name from the specified project. Deletes all 2nd Gen copy related configuration and resources which were created during the upgrade process. */
563
+ abortFunctionUpgrade(request: {
564
+ /** V1 error format. */
565
+ '$.xgafv'?: string;
566
+ /** OAuth access token. */
567
+ access_token?: string;
568
+ /** Data format for response. */
569
+ alt?: string;
570
+ /** JSONP */
571
+ callback?: string;
572
+ /** Selector specifying which fields to include in a partial response. */
573
+ fields?: string;
574
+ /** 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. */
575
+ key?: string;
576
+ /** Required. The name of the function for which upgrade should be aborted. */
577
+ name: string;
578
+ /** OAuth 2.0 token for the current user. */
579
+ oauth_token?: string;
580
+ /** Returns response with indentations and line breaks. */
581
+ prettyPrint?: boolean;
582
+ /** 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. */
583
+ quotaUser?: string;
584
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
585
+ upload_protocol?: string;
586
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
587
+ uploadType?: string;
588
+ /** Request body */
589
+ resource: AbortFunctionUpgradeRequest;
590
+ }): Request<Operation>;
591
+ abortFunctionUpgrade(
592
+ request: {
593
+ /** V1 error format. */
594
+ '$.xgafv'?: string;
595
+ /** OAuth access token. */
596
+ access_token?: string;
597
+ /** Data format for response. */
598
+ alt?: string;
599
+ /** JSONP */
600
+ callback?: string;
601
+ /** Selector specifying which fields to include in a partial response. */
602
+ fields?: string;
603
+ /** 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. */
604
+ key?: string;
605
+ /** Required. The name of the function for which upgrade should be aborted. */
606
+ name: string;
607
+ /** OAuth 2.0 token for the current user. */
608
+ oauth_token?: string;
609
+ /** Returns response with indentations and line breaks. */
610
+ prettyPrint?: boolean;
611
+ /** 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. */
612
+ quotaUser?: string;
613
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
614
+ upload_protocol?: string;
615
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
616
+ uploadType?: string;
617
+ },
618
+ body: AbortFunctionUpgradeRequest
619
+ ): Request<Operation>;
620
+ /** Finalizes the upgrade after which function upgrade can not be rolled back. This is the last step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Deletes all original 1st Gen related configuration and resources. */
621
+ commitFunctionUpgrade(request: {
622
+ /** V1 error format. */
623
+ '$.xgafv'?: string;
624
+ /** OAuth access token. */
625
+ access_token?: string;
626
+ /** Data format for response. */
627
+ alt?: string;
628
+ /** JSONP */
629
+ callback?: string;
630
+ /** Selector specifying which fields to include in a partial response. */
631
+ fields?: string;
632
+ /** 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. */
633
+ key?: string;
634
+ /** Required. The name of the function for which upgrade should be finalized. */
635
+ name: string;
636
+ /** OAuth 2.0 token for the current user. */
637
+ oauth_token?: string;
638
+ /** Returns response with indentations and line breaks. */
639
+ prettyPrint?: boolean;
640
+ /** 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. */
641
+ quotaUser?: string;
642
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
643
+ upload_protocol?: string;
644
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
645
+ uploadType?: string;
646
+ /** Request body */
647
+ resource: CommitFunctionUpgradeRequest;
648
+ }): Request<Operation>;
649
+ commitFunctionUpgrade(
650
+ request: {
651
+ /** V1 error format. */
652
+ '$.xgafv'?: string;
653
+ /** OAuth access token. */
654
+ access_token?: string;
655
+ /** Data format for response. */
656
+ alt?: string;
657
+ /** JSONP */
658
+ callback?: string;
659
+ /** Selector specifying which fields to include in a partial response. */
660
+ fields?: string;
661
+ /** 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. */
662
+ key?: string;
663
+ /** Required. The name of the function for which upgrade should be finalized. */
664
+ name: string;
665
+ /** OAuth 2.0 token for the current user. */
666
+ oauth_token?: string;
667
+ /** Returns response with indentations and line breaks. */
668
+ prettyPrint?: boolean;
669
+ /** 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. */
670
+ quotaUser?: string;
671
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
672
+ upload_protocol?: string;
673
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
674
+ uploadType?: string;
675
+ },
676
+ body: CommitFunctionUpgradeRequest
677
+ ): Request<Operation>;
543
678
  /** 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. */
544
679
  create(request: {
545
680
  /** V1 error format. */
@@ -905,6 +1040,122 @@ declare namespace gapi.client {
905
1040
  // eslint-disable-next-line @typescript-eslint/ban-types
906
1041
  body: Function
907
1042
  ): Request<Operation>;
1043
+ /** Changes the traffic target of a function from the original 1st Gen function to the 2nd Gen copy. This is the second step of the multi step process to upgrade 1st Gen functions to 2nd Gen. After this operation, all new traffic will be served by 2nd Gen copy. */
1044
+ redirectFunctionUpgradeTraffic(request: {
1045
+ /** V1 error format. */
1046
+ '$.xgafv'?: string;
1047
+ /** OAuth access token. */
1048
+ access_token?: string;
1049
+ /** Data format for response. */
1050
+ alt?: string;
1051
+ /** JSONP */
1052
+ callback?: string;
1053
+ /** Selector specifying which fields to include in a partial response. */
1054
+ fields?: string;
1055
+ /** 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. */
1056
+ key?: string;
1057
+ /** Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen. */
1058
+ name: string;
1059
+ /** OAuth 2.0 token for the current user. */
1060
+ oauth_token?: string;
1061
+ /** Returns response with indentations and line breaks. */
1062
+ prettyPrint?: boolean;
1063
+ /** 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. */
1064
+ quotaUser?: string;
1065
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1066
+ upload_protocol?: string;
1067
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1068
+ uploadType?: string;
1069
+ /** Request body */
1070
+ resource: RedirectFunctionUpgradeTrafficRequest;
1071
+ }): Request<Operation>;
1072
+ redirectFunctionUpgradeTraffic(
1073
+ request: {
1074
+ /** V1 error format. */
1075
+ '$.xgafv'?: string;
1076
+ /** OAuth access token. */
1077
+ access_token?: string;
1078
+ /** Data format for response. */
1079
+ alt?: string;
1080
+ /** JSONP */
1081
+ callback?: string;
1082
+ /** Selector specifying which fields to include in a partial response. */
1083
+ fields?: string;
1084
+ /** 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. */
1085
+ key?: string;
1086
+ /** Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen. */
1087
+ name: string;
1088
+ /** OAuth 2.0 token for the current user. */
1089
+ oauth_token?: string;
1090
+ /** Returns response with indentations and line breaks. */
1091
+ prettyPrint?: boolean;
1092
+ /** 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. */
1093
+ quotaUser?: string;
1094
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1095
+ upload_protocol?: string;
1096
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1097
+ uploadType?: string;
1098
+ },
1099
+ body: RedirectFunctionUpgradeTrafficRequest
1100
+ ): Request<Operation>;
1101
+ /** Reverts the traffic target of a function from the 2nd Gen copy to the original 1st Gen function. After this operation, all new traffic would be served by the 1st Gen. */
1102
+ rollbackFunctionUpgradeTraffic(request: {
1103
+ /** V1 error format. */
1104
+ '$.xgafv'?: string;
1105
+ /** OAuth access token. */
1106
+ access_token?: string;
1107
+ /** Data format for response. */
1108
+ alt?: string;
1109
+ /** JSONP */
1110
+ callback?: string;
1111
+ /** Selector specifying which fields to include in a partial response. */
1112
+ fields?: string;
1113
+ /** 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. */
1114
+ key?: string;
1115
+ /** Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen. */
1116
+ name: string;
1117
+ /** OAuth 2.0 token for the current user. */
1118
+ oauth_token?: string;
1119
+ /** Returns response with indentations and line breaks. */
1120
+ prettyPrint?: boolean;
1121
+ /** 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. */
1122
+ quotaUser?: string;
1123
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1124
+ upload_protocol?: string;
1125
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1126
+ uploadType?: string;
1127
+ /** Request body */
1128
+ resource: RollbackFunctionUpgradeTrafficRequest;
1129
+ }): Request<Operation>;
1130
+ rollbackFunctionUpgradeTraffic(
1131
+ request: {
1132
+ /** V1 error format. */
1133
+ '$.xgafv'?: string;
1134
+ /** OAuth access token. */
1135
+ access_token?: string;
1136
+ /** Data format for response. */
1137
+ alt?: string;
1138
+ /** JSONP */
1139
+ callback?: string;
1140
+ /** Selector specifying which fields to include in a partial response. */
1141
+ fields?: string;
1142
+ /** 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. */
1143
+ key?: string;
1144
+ /** Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen. */
1145
+ name: string;
1146
+ /** OAuth 2.0 token for the current user. */
1147
+ oauth_token?: string;
1148
+ /** Returns response with indentations and line breaks. */
1149
+ prettyPrint?: boolean;
1150
+ /** 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. */
1151
+ quotaUser?: string;
1152
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1153
+ upload_protocol?: string;
1154
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1155
+ uploadType?: string;
1156
+ },
1157
+ body: RollbackFunctionUpgradeTrafficRequest
1158
+ ): Request<Operation>;
908
1159
  /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
909
1160
  setIamPolicy(
910
1161
  request: {
@@ -935,6 +1186,64 @@ declare namespace gapi.client {
935
1186
  },
936
1187
  body: SetIamPolicyRequest
937
1188
  ): Request<Policy>;
1189
+ /** Creates a 2nd Gen copy of the function configuration based on the 1st Gen function with the given name. This is the first step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Only 2nd Gen configuration is setup as part of this request and traffic continues to be served by 1st Gen. */
1190
+ setupFunctionUpgradeConfig(request: {
1191
+ /** V1 error format. */
1192
+ '$.xgafv'?: string;
1193
+ /** OAuth access token. */
1194
+ access_token?: string;
1195
+ /** Data format for response. */
1196
+ alt?: string;
1197
+ /** JSONP */
1198
+ callback?: string;
1199
+ /** Selector specifying which fields to include in a partial response. */
1200
+ fields?: string;
1201
+ /** 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. */
1202
+ key?: string;
1203
+ /** Required. The name of the function which should have configuration copied for upgrade. */
1204
+ name: string;
1205
+ /** OAuth 2.0 token for the current user. */
1206
+ oauth_token?: string;
1207
+ /** Returns response with indentations and line breaks. */
1208
+ prettyPrint?: boolean;
1209
+ /** 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. */
1210
+ quotaUser?: string;
1211
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1212
+ upload_protocol?: string;
1213
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1214
+ uploadType?: string;
1215
+ /** Request body */
1216
+ resource: SetupFunctionUpgradeConfigRequest;
1217
+ }): Request<Operation>;
1218
+ setupFunctionUpgradeConfig(
1219
+ request: {
1220
+ /** V1 error format. */
1221
+ '$.xgafv'?: string;
1222
+ /** OAuth access token. */
1223
+ access_token?: string;
1224
+ /** Data format for response. */
1225
+ alt?: string;
1226
+ /** JSONP */
1227
+ callback?: string;
1228
+ /** Selector specifying which fields to include in a partial response. */
1229
+ fields?: string;
1230
+ /** 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. */
1231
+ key?: string;
1232
+ /** Required. The name of the function which should have configuration copied for upgrade. */
1233
+ name: string;
1234
+ /** OAuth 2.0 token for the current user. */
1235
+ oauth_token?: string;
1236
+ /** Returns response with indentations and line breaks. */
1237
+ prettyPrint?: boolean;
1238
+ /** 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. */
1239
+ quotaUser?: string;
1240
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1241
+ upload_protocol?: string;
1242
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1243
+ uploadType?: string;
1244
+ },
1245
+ body: SetupFunctionUpgradeConfigRequest
1246
+ ): Request<Operation>;
938
1247
  /** Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
939
1248
  testIamPermissions(
940
1249
  request: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.cloudfunctions-v2beta",
3
- "version": "0.0.20240118",
3
+ "version": "0.0.20240205",
4
4
  "description": "TypeScript typings for Cloud Functions API v2beta",
5
5
  "repository": {
6
6
  "type": "git",