@maxim_mazurok/gapi.client.cloudfunctions-v2beta 0.0.20250111 → 0.0.20250124
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.
- package/index.d.ts +77 -16
- package/package.json +1 -1
- package/readme.md +2 -2
package/index.d.ts
CHANGED
|
@@ -9,14 +9,14 @@
|
|
|
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:
|
|
12
|
+
// Revision: 20250124
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
16
16
|
declare namespace gapi.client {
|
|
17
17
|
/** Load Cloud Functions API v2beta */
|
|
18
18
|
function load(
|
|
19
|
-
urlOrObject: 'https://cloudfunctions.googleapis.com/$discovery/rest?version=v2beta'
|
|
19
|
+
urlOrObject: 'https://cloudfunctions.googleapis.com/$discovery/rest?version=v2beta',
|
|
20
20
|
): Promise<void>;
|
|
21
21
|
/** @deprecated Please load APIs with discovery documents. */
|
|
22
22
|
function load(name: 'cloudfunctions', version: 'v2beta'): Promise<void>;
|
|
@@ -24,7 +24,7 @@ declare namespace gapi.client {
|
|
|
24
24
|
function load(
|
|
25
25
|
name: 'cloudfunctions',
|
|
26
26
|
version: 'v2beta',
|
|
27
|
-
callback: () => any
|
|
27
|
+
callback: () => any,
|
|
28
28
|
): void;
|
|
29
29
|
|
|
30
30
|
namespace cloudfunctions {
|
|
@@ -54,7 +54,7 @@ declare namespace gapi.client {
|
|
|
54
54
|
automaticUpdatePolicy?: any;
|
|
55
55
|
/** Output only. The Cloud Build name of the latest successful deployment of the function. */
|
|
56
56
|
build?: string;
|
|
57
|
-
/** Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */
|
|
57
|
+
/** Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`. */
|
|
58
58
|
dockerRegistry?: string;
|
|
59
59
|
/** Repository in Artifact Registry to which the function docker image will be pushed after it is built by Cloud Build. If specified by user, it is created and managed by user with a customer managed encryption key. Otherwise, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. Repository format must be 'DOCKER'. */
|
|
60
60
|
dockerRepository?: string;
|
|
@@ -85,6 +85,7 @@ declare namespace gapi.client {
|
|
|
85
85
|
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
86
86
|
year?: number;
|
|
87
87
|
}
|
|
88
|
+
interface DetachFunctionRequest {}
|
|
88
89
|
interface EventFilter {
|
|
89
90
|
/** Required. The name of a CloudEvents attribute. */
|
|
90
91
|
attribute?: string;
|
|
@@ -141,6 +142,8 @@ declare namespace gapi.client {
|
|
|
141
142
|
/** A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*` */
|
|
142
143
|
name?: string;
|
|
143
144
|
/** Output only. Reserved for future use. */
|
|
145
|
+
satisfiesPzi?: boolean;
|
|
146
|
+
/** Output only. Reserved for future use. */
|
|
144
147
|
satisfiesPzs?: boolean;
|
|
145
148
|
/** Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed). */
|
|
146
149
|
serviceConfig?: ServiceConfig;
|
|
@@ -519,7 +522,7 @@ declare namespace gapi.client {
|
|
|
519
522
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
520
523
|
uploadType?: string;
|
|
521
524
|
},
|
|
522
|
-
body: AbortFunctionUpgradeRequest
|
|
525
|
+
body: AbortFunctionUpgradeRequest,
|
|
523
526
|
): Request<Operation>;
|
|
524
527
|
/** 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. */
|
|
525
528
|
commitFunctionUpgrade(request: {
|
|
@@ -577,7 +580,7 @@ declare namespace gapi.client {
|
|
|
577
580
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
578
581
|
uploadType?: string;
|
|
579
582
|
},
|
|
580
|
-
body: CommitFunctionUpgradeRequest
|
|
583
|
+
body: CommitFunctionUpgradeRequest,
|
|
581
584
|
): Request<Operation>;
|
|
582
585
|
/** 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. */
|
|
583
586
|
create(request: {
|
|
@@ -641,7 +644,7 @@ declare namespace gapi.client {
|
|
|
641
644
|
uploadType?: string;
|
|
642
645
|
},
|
|
643
646
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
644
|
-
body: Function
|
|
647
|
+
body: Function,
|
|
645
648
|
): Request<Operation>;
|
|
646
649
|
/** 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. */
|
|
647
650
|
delete(request?: {
|
|
@@ -670,6 +673,64 @@ declare namespace gapi.client {
|
|
|
670
673
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
671
674
|
uploadType?: string;
|
|
672
675
|
}): Request<Operation>;
|
|
676
|
+
/** Detaches 2nd Gen function to Cloud Run function. */
|
|
677
|
+
detachFunction(request: {
|
|
678
|
+
/** V1 error format. */
|
|
679
|
+
'$.xgafv'?: string;
|
|
680
|
+
/** OAuth access token. */
|
|
681
|
+
access_token?: string;
|
|
682
|
+
/** Data format for response. */
|
|
683
|
+
alt?: string;
|
|
684
|
+
/** JSONP */
|
|
685
|
+
callback?: string;
|
|
686
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
687
|
+
fields?: string;
|
|
688
|
+
/** 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. */
|
|
689
|
+
key?: string;
|
|
690
|
+
/** Required. The name of the function for which should be detached. */
|
|
691
|
+
name: string;
|
|
692
|
+
/** OAuth 2.0 token for the current user. */
|
|
693
|
+
oauth_token?: string;
|
|
694
|
+
/** Returns response with indentations and line breaks. */
|
|
695
|
+
prettyPrint?: boolean;
|
|
696
|
+
/** 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. */
|
|
697
|
+
quotaUser?: string;
|
|
698
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
699
|
+
upload_protocol?: string;
|
|
700
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
701
|
+
uploadType?: string;
|
|
702
|
+
/** Request body */
|
|
703
|
+
resource: DetachFunctionRequest;
|
|
704
|
+
}): Request<Operation>;
|
|
705
|
+
detachFunction(
|
|
706
|
+
request: {
|
|
707
|
+
/** V1 error format. */
|
|
708
|
+
'$.xgafv'?: string;
|
|
709
|
+
/** OAuth access token. */
|
|
710
|
+
access_token?: string;
|
|
711
|
+
/** Data format for response. */
|
|
712
|
+
alt?: string;
|
|
713
|
+
/** JSONP */
|
|
714
|
+
callback?: string;
|
|
715
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
716
|
+
fields?: string;
|
|
717
|
+
/** 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. */
|
|
718
|
+
key?: string;
|
|
719
|
+
/** Required. The name of the function for which should be detached. */
|
|
720
|
+
name: string;
|
|
721
|
+
/** OAuth 2.0 token for the current user. */
|
|
722
|
+
oauth_token?: string;
|
|
723
|
+
/** Returns response with indentations and line breaks. */
|
|
724
|
+
prettyPrint?: boolean;
|
|
725
|
+
/** 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. */
|
|
726
|
+
quotaUser?: string;
|
|
727
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
728
|
+
upload_protocol?: string;
|
|
729
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
730
|
+
uploadType?: string;
|
|
731
|
+
},
|
|
732
|
+
body: DetachFunctionRequest,
|
|
733
|
+
): Request<Operation>;
|
|
673
734
|
/** Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls */
|
|
674
735
|
generateDownloadUrl(request: {
|
|
675
736
|
/** V1 error format. */
|
|
@@ -726,7 +787,7 @@ declare namespace gapi.client {
|
|
|
726
787
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
727
788
|
uploadType?: string;
|
|
728
789
|
},
|
|
729
|
-
body: GenerateDownloadUrlRequest
|
|
790
|
+
body: GenerateDownloadUrlRequest,
|
|
730
791
|
): Request<GenerateDownloadUrlResponse>;
|
|
731
792
|
/** 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. * 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, specify this header: * `content-type: application/zip` Do not specify this header: * `Authorization: Bearer YOUR_TOKEN` */
|
|
732
793
|
generateUploadUrl(request: {
|
|
@@ -784,7 +845,7 @@ declare namespace gapi.client {
|
|
|
784
845
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
785
846
|
uploadType?: string;
|
|
786
847
|
},
|
|
787
|
-
body: GenerateUploadUrlRequest
|
|
848
|
+
body: GenerateUploadUrlRequest,
|
|
788
849
|
): Request<GenerateUploadUrlResponse>;
|
|
789
850
|
/** Returns a function with the given name from the requested project. */
|
|
790
851
|
get(
|
|
@@ -815,7 +876,7 @@ declare namespace gapi.client {
|
|
|
815
876
|
upload_protocol?: string;
|
|
816
877
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
817
878
|
uploadType?: string;
|
|
818
|
-
}
|
|
879
|
+
},
|
|
819
880
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
820
881
|
): Request<Function>;
|
|
821
882
|
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
@@ -944,7 +1005,7 @@ declare namespace gapi.client {
|
|
|
944
1005
|
uploadType?: string;
|
|
945
1006
|
},
|
|
946
1007
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
947
|
-
body: Function
|
|
1008
|
+
body: Function,
|
|
948
1009
|
): Request<Operation>;
|
|
949
1010
|
/** 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. */
|
|
950
1011
|
redirectFunctionUpgradeTraffic(request: {
|
|
@@ -1002,7 +1063,7 @@ declare namespace gapi.client {
|
|
|
1002
1063
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1003
1064
|
uploadType?: string;
|
|
1004
1065
|
},
|
|
1005
|
-
body: RedirectFunctionUpgradeTrafficRequest
|
|
1066
|
+
body: RedirectFunctionUpgradeTrafficRequest,
|
|
1006
1067
|
): Request<Operation>;
|
|
1007
1068
|
/** 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. */
|
|
1008
1069
|
rollbackFunctionUpgradeTraffic(request: {
|
|
@@ -1060,7 +1121,7 @@ declare namespace gapi.client {
|
|
|
1060
1121
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1061
1122
|
uploadType?: string;
|
|
1062
1123
|
},
|
|
1063
|
-
body: RollbackFunctionUpgradeTrafficRequest
|
|
1124
|
+
body: RollbackFunctionUpgradeTrafficRequest,
|
|
1064
1125
|
): Request<Operation>;
|
|
1065
1126
|
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
1066
1127
|
setIamPolicy(
|
|
@@ -1090,7 +1151,7 @@ declare namespace gapi.client {
|
|
|
1090
1151
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1091
1152
|
uploadType?: string;
|
|
1092
1153
|
},
|
|
1093
|
-
body: SetIamPolicyRequest
|
|
1154
|
+
body: SetIamPolicyRequest,
|
|
1094
1155
|
): Request<Policy>;
|
|
1095
1156
|
/** 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. */
|
|
1096
1157
|
setupFunctionUpgradeConfig(request: {
|
|
@@ -1148,7 +1209,7 @@ declare namespace gapi.client {
|
|
|
1148
1209
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1149
1210
|
uploadType?: string;
|
|
1150
1211
|
},
|
|
1151
|
-
body: SetupFunctionUpgradeConfigRequest
|
|
1212
|
+
body: SetupFunctionUpgradeConfigRequest,
|
|
1152
1213
|
): Request<Operation>;
|
|
1153
1214
|
/** 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. */
|
|
1154
1215
|
testIamPermissions(
|
|
@@ -1178,7 +1239,7 @@ declare namespace gapi.client {
|
|
|
1178
1239
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1179
1240
|
uploadType?: string;
|
|
1180
1241
|
},
|
|
1181
|
-
body: TestIamPermissionsRequest
|
|
1242
|
+
body: TestIamPermissionsRequest,
|
|
1182
1243
|
): Request<TestIamPermissionsResponse>;
|
|
1183
1244
|
}
|
|
1184
1245
|
interface OperationsResource {
|
package/package.json
CHANGED
package/readme.md
CHANGED