@mochabug/adapt-sdk 0.1.1
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/LICENSE +201 -0
- package/README.md +873 -0
- package/dist/api.d.ts +1605 -0
- package/dist/api.d.ts.map +1 -0
- package/dist/api.spec.d.ts +2 -0
- package/dist/api.spec.d.ts.map +1 -0
- package/dist/cjs/api.cjs +2 -0
- package/dist/cjs/api.cjs.map +7 -0
- package/dist/cjs/frontend.cjs +2 -0
- package/dist/cjs/frontend.cjs.map +7 -0
- package/dist/cjs/mime.cjs +2 -0
- package/dist/cjs/mime.cjs.map +7 -0
- package/dist/cjs/router.cjs +2 -0
- package/dist/cjs/router.cjs.map +7 -0
- package/dist/cjs/types.cjs +2 -0
- package/dist/cjs/types.cjs.map +7 -0
- package/dist/esm/api.mjs +2 -0
- package/dist/esm/api.mjs.map +7 -0
- package/dist/esm/frontend.mjs +2 -0
- package/dist/esm/frontend.mjs.map +7 -0
- package/dist/esm/mime.mjs +2 -0
- package/dist/esm/mime.mjs.map +7 -0
- package/dist/esm/router.mjs +2 -0
- package/dist/esm/router.mjs.map +7 -0
- package/dist/esm/types.mjs +1 -0
- package/dist/esm/types.mjs.map +7 -0
- package/dist/frontend.d.ts +10 -0
- package/dist/frontend.d.ts.map +1 -0
- package/dist/genproto/buf/validate/validate_pb.d.ts +8491 -0
- package/dist/genproto/buf/validate/validate_pb.d.ts.map +1 -0
- package/dist/genproto/google/api/annotations_pb.d.ts +14 -0
- package/dist/genproto/google/api/annotations_pb.d.ts.map +1 -0
- package/dist/genproto/google/api/client_pb.d.ts +1432 -0
- package/dist/genproto/google/api/client_pb.d.ts.map +1 -0
- package/dist/genproto/google/api/http_pb.d.ts +843 -0
- package/dist/genproto/google/api/http_pb.d.ts.map +1 -0
- package/dist/genproto/google/api/launch_stage_pb.d.ts +94 -0
- package/dist/genproto/google/api/launch_stage_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/automations/v1/automations_pb.d.ts +1006 -0
- package/dist/genproto/mochabugapis/adapt/automations/v1/automations_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/exchange_pb.d.ts +77 -0
- package/dist/genproto/mochabugapis/adapt/graph/exchange_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/jtd_schema_pb.d.ts +401 -0
- package/dist/genproto/mochabugapis/adapt/graph/jtd_schema_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/receiver_pb.d.ts +69 -0
- package/dist/genproto/mochabugapis/adapt/graph/receiver_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_binding_pb.d.ts +430 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_binding_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_data_pb.d.ts +198 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_data_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_descriptor_pb.d.ts +161 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_descriptor_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_format_pb.d.ts +305 -0
- package/dist/genproto/mochabugapis/adapt/graph/signal_format_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/transceiver_pb.d.ts +77 -0
- package/dist/genproto/mochabugapis/adapt/graph/transceiver_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/transmitter_pb.d.ts +120 -0
- package/dist/genproto/mochabugapis/adapt/graph/transmitter_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/graph/vertex_metadata_pb.d.ts +99 -0
- package/dist/genproto/mochabugapis/adapt/graph/vertex_metadata_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/compound_services_pb.d.ts +347 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/compound_services_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/file_pb.d.ts +64 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/file_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/http_proxy_service_pb.d.ts +1282 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/http_proxy_service_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/manifest_pb.d.ts +388 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/manifest_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/oauth2_service_pb.d.ts +805 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/oauth2_service_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/plugins_pb.d.ts +238 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/plugins_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/service_definition_pb.d.ts +241 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/service_definition_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/service_settings_pb.d.ts +539 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/service_settings_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.d.ts +190 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/variable_service_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.d.ts +269 -0
- package/dist/genproto/mochabugapis/adapt/plugins/v1/vertex_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/incoming_pb.d.ts +339 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/incoming_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/runtime_pb.d.ts +2721 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/runtime_pb.d.ts.map +1 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/store_pb.d.ts +872 -0
- package/dist/genproto/mochabugapis/adapt/runtime/v1/store_pb.d.ts.map +1 -0
- package/dist/grpcweb.d.ts +8 -0
- package/dist/grpcweb.d.ts.map +1 -0
- package/dist/mime.d.ts +11 -0
- package/dist/mime.d.ts.map +1 -0
- package/dist/router.d.ts +503 -0
- package/dist/router.d.ts.map +1 -0
- package/dist/router.spec.d.ts +2 -0
- package/dist/router.spec.d.ts.map +1 -0
- package/dist/signal-api.spec.d.ts +17 -0
- package/dist/signal-api.spec.d.ts.map +1 -0
- package/dist/types.d.ts +149 -0
- package/dist/types.d.ts.map +1 -0
- package/package.json +80 -0
|
@@ -0,0 +1,1432 @@
|
|
|
1
|
+
import type { GenEnum, GenExtension, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
|
|
2
|
+
import type { LaunchStage, LaunchStageJson } from "./launch_stage_pb";
|
|
3
|
+
import type { Duration, DurationJson, MethodOptions, ServiceOptions } from "@bufbuild/protobuf/wkt";
|
|
4
|
+
import type { Message } from "@bufbuild/protobuf";
|
|
5
|
+
/**
|
|
6
|
+
* Describes the file google/api/client.proto.
|
|
7
|
+
*/
|
|
8
|
+
export declare const file_google_api_client: GenFile;
|
|
9
|
+
/**
|
|
10
|
+
* Required information for every language.
|
|
11
|
+
*
|
|
12
|
+
* @generated from message google.api.CommonLanguageSettings
|
|
13
|
+
*/
|
|
14
|
+
export type CommonLanguageSettings = Message<"google.api.CommonLanguageSettings"> & {
|
|
15
|
+
/**
|
|
16
|
+
* Link to automatically generated reference documentation. Example:
|
|
17
|
+
* https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
18
|
+
*
|
|
19
|
+
* @generated from field: string reference_docs_uri = 1 [deprecated = true];
|
|
20
|
+
* @deprecated
|
|
21
|
+
*/
|
|
22
|
+
referenceDocsUri: string;
|
|
23
|
+
/**
|
|
24
|
+
* The destination where API teams want this client library to be published.
|
|
25
|
+
*
|
|
26
|
+
* @generated from field: repeated google.api.ClientLibraryDestination destinations = 2;
|
|
27
|
+
*/
|
|
28
|
+
destinations: ClientLibraryDestination[];
|
|
29
|
+
/**
|
|
30
|
+
* Configuration for which RPCs should be generated in the GAPIC client.
|
|
31
|
+
*
|
|
32
|
+
* @generated from field: google.api.SelectiveGapicGeneration selective_gapic_generation = 3;
|
|
33
|
+
*/
|
|
34
|
+
selectiveGapicGeneration?: SelectiveGapicGeneration;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Required information for every language.
|
|
38
|
+
*
|
|
39
|
+
* @generated from message google.api.CommonLanguageSettings
|
|
40
|
+
*/
|
|
41
|
+
export type CommonLanguageSettingsJson = {
|
|
42
|
+
/**
|
|
43
|
+
* Link to automatically generated reference documentation. Example:
|
|
44
|
+
* https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
45
|
+
*
|
|
46
|
+
* @generated from field: string reference_docs_uri = 1 [deprecated = true];
|
|
47
|
+
* @deprecated
|
|
48
|
+
*/
|
|
49
|
+
referenceDocsUri?: string;
|
|
50
|
+
/**
|
|
51
|
+
* The destination where API teams want this client library to be published.
|
|
52
|
+
*
|
|
53
|
+
* @generated from field: repeated google.api.ClientLibraryDestination destinations = 2;
|
|
54
|
+
*/
|
|
55
|
+
destinations?: ClientLibraryDestinationJson[];
|
|
56
|
+
/**
|
|
57
|
+
* Configuration for which RPCs should be generated in the GAPIC client.
|
|
58
|
+
*
|
|
59
|
+
* @generated from field: google.api.SelectiveGapicGeneration selective_gapic_generation = 3;
|
|
60
|
+
*/
|
|
61
|
+
selectiveGapicGeneration?: SelectiveGapicGenerationJson;
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
* Describes the message google.api.CommonLanguageSettings.
|
|
65
|
+
* Use `create(CommonLanguageSettingsSchema)` to create a new message.
|
|
66
|
+
*/
|
|
67
|
+
export declare const CommonLanguageSettingsSchema: GenMessage<CommonLanguageSettings, {
|
|
68
|
+
jsonType: CommonLanguageSettingsJson;
|
|
69
|
+
}>;
|
|
70
|
+
/**
|
|
71
|
+
* Details about how and where to publish client libraries.
|
|
72
|
+
*
|
|
73
|
+
* @generated from message google.api.ClientLibrarySettings
|
|
74
|
+
*/
|
|
75
|
+
export type ClientLibrarySettings = Message<"google.api.ClientLibrarySettings"> & {
|
|
76
|
+
/**
|
|
77
|
+
* Version of the API to apply these settings to. This is the full protobuf
|
|
78
|
+
* package for the API, ending in the version element.
|
|
79
|
+
* Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
|
80
|
+
*
|
|
81
|
+
* @generated from field: string version = 1;
|
|
82
|
+
*/
|
|
83
|
+
version: string;
|
|
84
|
+
/**
|
|
85
|
+
* Launch stage of this version of the API.
|
|
86
|
+
*
|
|
87
|
+
* @generated from field: google.api.LaunchStage launch_stage = 2;
|
|
88
|
+
*/
|
|
89
|
+
launchStage: LaunchStage;
|
|
90
|
+
/**
|
|
91
|
+
* When using transport=rest, the client request will encode enums as
|
|
92
|
+
* numbers rather than strings.
|
|
93
|
+
*
|
|
94
|
+
* @generated from field: bool rest_numeric_enums = 3;
|
|
95
|
+
*/
|
|
96
|
+
restNumericEnums: boolean;
|
|
97
|
+
/**
|
|
98
|
+
* Settings for legacy Java features, supported in the Service YAML.
|
|
99
|
+
*
|
|
100
|
+
* @generated from field: google.api.JavaSettings java_settings = 21;
|
|
101
|
+
*/
|
|
102
|
+
javaSettings?: JavaSettings;
|
|
103
|
+
/**
|
|
104
|
+
* Settings for C++ client libraries.
|
|
105
|
+
*
|
|
106
|
+
* @generated from field: google.api.CppSettings cpp_settings = 22;
|
|
107
|
+
*/
|
|
108
|
+
cppSettings?: CppSettings;
|
|
109
|
+
/**
|
|
110
|
+
* Settings for PHP client libraries.
|
|
111
|
+
*
|
|
112
|
+
* @generated from field: google.api.PhpSettings php_settings = 23;
|
|
113
|
+
*/
|
|
114
|
+
phpSettings?: PhpSettings;
|
|
115
|
+
/**
|
|
116
|
+
* Settings for Python client libraries.
|
|
117
|
+
*
|
|
118
|
+
* @generated from field: google.api.PythonSettings python_settings = 24;
|
|
119
|
+
*/
|
|
120
|
+
pythonSettings?: PythonSettings;
|
|
121
|
+
/**
|
|
122
|
+
* Settings for Node client libraries.
|
|
123
|
+
*
|
|
124
|
+
* @generated from field: google.api.NodeSettings node_settings = 25;
|
|
125
|
+
*/
|
|
126
|
+
nodeSettings?: NodeSettings;
|
|
127
|
+
/**
|
|
128
|
+
* Settings for .NET client libraries.
|
|
129
|
+
*
|
|
130
|
+
* @generated from field: google.api.DotnetSettings dotnet_settings = 26;
|
|
131
|
+
*/
|
|
132
|
+
dotnetSettings?: DotnetSettings;
|
|
133
|
+
/**
|
|
134
|
+
* Settings for Ruby client libraries.
|
|
135
|
+
*
|
|
136
|
+
* @generated from field: google.api.RubySettings ruby_settings = 27;
|
|
137
|
+
*/
|
|
138
|
+
rubySettings?: RubySettings;
|
|
139
|
+
/**
|
|
140
|
+
* Settings for Go client libraries.
|
|
141
|
+
*
|
|
142
|
+
* @generated from field: google.api.GoSettings go_settings = 28;
|
|
143
|
+
*/
|
|
144
|
+
goSettings?: GoSettings;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* Details about how and where to publish client libraries.
|
|
148
|
+
*
|
|
149
|
+
* @generated from message google.api.ClientLibrarySettings
|
|
150
|
+
*/
|
|
151
|
+
export type ClientLibrarySettingsJson = {
|
|
152
|
+
/**
|
|
153
|
+
* Version of the API to apply these settings to. This is the full protobuf
|
|
154
|
+
* package for the API, ending in the version element.
|
|
155
|
+
* Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
|
156
|
+
*
|
|
157
|
+
* @generated from field: string version = 1;
|
|
158
|
+
*/
|
|
159
|
+
version?: string;
|
|
160
|
+
/**
|
|
161
|
+
* Launch stage of this version of the API.
|
|
162
|
+
*
|
|
163
|
+
* @generated from field: google.api.LaunchStage launch_stage = 2;
|
|
164
|
+
*/
|
|
165
|
+
launchStage?: LaunchStageJson;
|
|
166
|
+
/**
|
|
167
|
+
* When using transport=rest, the client request will encode enums as
|
|
168
|
+
* numbers rather than strings.
|
|
169
|
+
*
|
|
170
|
+
* @generated from field: bool rest_numeric_enums = 3;
|
|
171
|
+
*/
|
|
172
|
+
restNumericEnums?: boolean;
|
|
173
|
+
/**
|
|
174
|
+
* Settings for legacy Java features, supported in the Service YAML.
|
|
175
|
+
*
|
|
176
|
+
* @generated from field: google.api.JavaSettings java_settings = 21;
|
|
177
|
+
*/
|
|
178
|
+
javaSettings?: JavaSettingsJson;
|
|
179
|
+
/**
|
|
180
|
+
* Settings for C++ client libraries.
|
|
181
|
+
*
|
|
182
|
+
* @generated from field: google.api.CppSettings cpp_settings = 22;
|
|
183
|
+
*/
|
|
184
|
+
cppSettings?: CppSettingsJson;
|
|
185
|
+
/**
|
|
186
|
+
* Settings for PHP client libraries.
|
|
187
|
+
*
|
|
188
|
+
* @generated from field: google.api.PhpSettings php_settings = 23;
|
|
189
|
+
*/
|
|
190
|
+
phpSettings?: PhpSettingsJson;
|
|
191
|
+
/**
|
|
192
|
+
* Settings for Python client libraries.
|
|
193
|
+
*
|
|
194
|
+
* @generated from field: google.api.PythonSettings python_settings = 24;
|
|
195
|
+
*/
|
|
196
|
+
pythonSettings?: PythonSettingsJson;
|
|
197
|
+
/**
|
|
198
|
+
* Settings for Node client libraries.
|
|
199
|
+
*
|
|
200
|
+
* @generated from field: google.api.NodeSettings node_settings = 25;
|
|
201
|
+
*/
|
|
202
|
+
nodeSettings?: NodeSettingsJson;
|
|
203
|
+
/**
|
|
204
|
+
* Settings for .NET client libraries.
|
|
205
|
+
*
|
|
206
|
+
* @generated from field: google.api.DotnetSettings dotnet_settings = 26;
|
|
207
|
+
*/
|
|
208
|
+
dotnetSettings?: DotnetSettingsJson;
|
|
209
|
+
/**
|
|
210
|
+
* Settings for Ruby client libraries.
|
|
211
|
+
*
|
|
212
|
+
* @generated from field: google.api.RubySettings ruby_settings = 27;
|
|
213
|
+
*/
|
|
214
|
+
rubySettings?: RubySettingsJson;
|
|
215
|
+
/**
|
|
216
|
+
* Settings for Go client libraries.
|
|
217
|
+
*
|
|
218
|
+
* @generated from field: google.api.GoSettings go_settings = 28;
|
|
219
|
+
*/
|
|
220
|
+
goSettings?: GoSettingsJson;
|
|
221
|
+
};
|
|
222
|
+
/**
|
|
223
|
+
* Describes the message google.api.ClientLibrarySettings.
|
|
224
|
+
* Use `create(ClientLibrarySettingsSchema)` to create a new message.
|
|
225
|
+
*/
|
|
226
|
+
export declare const ClientLibrarySettingsSchema: GenMessage<ClientLibrarySettings, {
|
|
227
|
+
jsonType: ClientLibrarySettingsJson;
|
|
228
|
+
}>;
|
|
229
|
+
/**
|
|
230
|
+
* This message configures the settings for publishing [Google Cloud Client
|
|
231
|
+
* libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
|
232
|
+
* generated from the service config.
|
|
233
|
+
*
|
|
234
|
+
* @generated from message google.api.Publishing
|
|
235
|
+
*/
|
|
236
|
+
export type Publishing = Message<"google.api.Publishing"> & {
|
|
237
|
+
/**
|
|
238
|
+
* A list of API method settings, e.g. the behavior for methods that use the
|
|
239
|
+
* long-running operation pattern.
|
|
240
|
+
*
|
|
241
|
+
* @generated from field: repeated google.api.MethodSettings method_settings = 2;
|
|
242
|
+
*/
|
|
243
|
+
methodSettings: MethodSettings[];
|
|
244
|
+
/**
|
|
245
|
+
* Link to a *public* URI where users can report issues. Example:
|
|
246
|
+
* https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
|
247
|
+
*
|
|
248
|
+
* @generated from field: string new_issue_uri = 101;
|
|
249
|
+
*/
|
|
250
|
+
newIssueUri: string;
|
|
251
|
+
/**
|
|
252
|
+
* Link to product home page. Example:
|
|
253
|
+
* https://cloud.google.com/asset-inventory/docs/overview
|
|
254
|
+
*
|
|
255
|
+
* @generated from field: string documentation_uri = 102;
|
|
256
|
+
*/
|
|
257
|
+
documentationUri: string;
|
|
258
|
+
/**
|
|
259
|
+
* Used as a tracking tag when collecting data about the APIs developer
|
|
260
|
+
* relations artifacts like docs, packages delivered to package managers,
|
|
261
|
+
* etc. Example: "speech".
|
|
262
|
+
*
|
|
263
|
+
* @generated from field: string api_short_name = 103;
|
|
264
|
+
*/
|
|
265
|
+
apiShortName: string;
|
|
266
|
+
/**
|
|
267
|
+
* GitHub label to apply to issues and pull requests opened for this API.
|
|
268
|
+
*
|
|
269
|
+
* @generated from field: string github_label = 104;
|
|
270
|
+
*/
|
|
271
|
+
githubLabel: string;
|
|
272
|
+
/**
|
|
273
|
+
* GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
|
274
|
+
* containing source code for the client libraries for this API.
|
|
275
|
+
*
|
|
276
|
+
* @generated from field: repeated string codeowner_github_teams = 105;
|
|
277
|
+
*/
|
|
278
|
+
codeownerGithubTeams: string[];
|
|
279
|
+
/**
|
|
280
|
+
* A prefix used in sample code when demarking regions to be included in
|
|
281
|
+
* documentation.
|
|
282
|
+
*
|
|
283
|
+
* @generated from field: string doc_tag_prefix = 106;
|
|
284
|
+
*/
|
|
285
|
+
docTagPrefix: string;
|
|
286
|
+
/**
|
|
287
|
+
* For whom the client library is being published.
|
|
288
|
+
*
|
|
289
|
+
* @generated from field: google.api.ClientLibraryOrganization organization = 107;
|
|
290
|
+
*/
|
|
291
|
+
organization: ClientLibraryOrganization;
|
|
292
|
+
/**
|
|
293
|
+
* Client library settings. If the same version string appears multiple
|
|
294
|
+
* times in this list, then the last one wins. Settings from earlier
|
|
295
|
+
* settings with the same version string are discarded.
|
|
296
|
+
*
|
|
297
|
+
* @generated from field: repeated google.api.ClientLibrarySettings library_settings = 109;
|
|
298
|
+
*/
|
|
299
|
+
librarySettings: ClientLibrarySettings[];
|
|
300
|
+
/**
|
|
301
|
+
* Optional link to proto reference documentation. Example:
|
|
302
|
+
* https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
|
303
|
+
*
|
|
304
|
+
* @generated from field: string proto_reference_documentation_uri = 110;
|
|
305
|
+
*/
|
|
306
|
+
protoReferenceDocumentationUri: string;
|
|
307
|
+
/**
|
|
308
|
+
* Optional link to REST reference documentation. Example:
|
|
309
|
+
* https://cloud.google.com/pubsub/lite/docs/reference/rest
|
|
310
|
+
*
|
|
311
|
+
* @generated from field: string rest_reference_documentation_uri = 111;
|
|
312
|
+
*/
|
|
313
|
+
restReferenceDocumentationUri: string;
|
|
314
|
+
};
|
|
315
|
+
/**
|
|
316
|
+
* This message configures the settings for publishing [Google Cloud Client
|
|
317
|
+
* libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
|
318
|
+
* generated from the service config.
|
|
319
|
+
*
|
|
320
|
+
* @generated from message google.api.Publishing
|
|
321
|
+
*/
|
|
322
|
+
export type PublishingJson = {
|
|
323
|
+
/**
|
|
324
|
+
* A list of API method settings, e.g. the behavior for methods that use the
|
|
325
|
+
* long-running operation pattern.
|
|
326
|
+
*
|
|
327
|
+
* @generated from field: repeated google.api.MethodSettings method_settings = 2;
|
|
328
|
+
*/
|
|
329
|
+
methodSettings?: MethodSettingsJson[];
|
|
330
|
+
/**
|
|
331
|
+
* Link to a *public* URI where users can report issues. Example:
|
|
332
|
+
* https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
|
333
|
+
*
|
|
334
|
+
* @generated from field: string new_issue_uri = 101;
|
|
335
|
+
*/
|
|
336
|
+
newIssueUri?: string;
|
|
337
|
+
/**
|
|
338
|
+
* Link to product home page. Example:
|
|
339
|
+
* https://cloud.google.com/asset-inventory/docs/overview
|
|
340
|
+
*
|
|
341
|
+
* @generated from field: string documentation_uri = 102;
|
|
342
|
+
*/
|
|
343
|
+
documentationUri?: string;
|
|
344
|
+
/**
|
|
345
|
+
* Used as a tracking tag when collecting data about the APIs developer
|
|
346
|
+
* relations artifacts like docs, packages delivered to package managers,
|
|
347
|
+
* etc. Example: "speech".
|
|
348
|
+
*
|
|
349
|
+
* @generated from field: string api_short_name = 103;
|
|
350
|
+
*/
|
|
351
|
+
apiShortName?: string;
|
|
352
|
+
/**
|
|
353
|
+
* GitHub label to apply to issues and pull requests opened for this API.
|
|
354
|
+
*
|
|
355
|
+
* @generated from field: string github_label = 104;
|
|
356
|
+
*/
|
|
357
|
+
githubLabel?: string;
|
|
358
|
+
/**
|
|
359
|
+
* GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
|
360
|
+
* containing source code for the client libraries for this API.
|
|
361
|
+
*
|
|
362
|
+
* @generated from field: repeated string codeowner_github_teams = 105;
|
|
363
|
+
*/
|
|
364
|
+
codeownerGithubTeams?: string[];
|
|
365
|
+
/**
|
|
366
|
+
* A prefix used in sample code when demarking regions to be included in
|
|
367
|
+
* documentation.
|
|
368
|
+
*
|
|
369
|
+
* @generated from field: string doc_tag_prefix = 106;
|
|
370
|
+
*/
|
|
371
|
+
docTagPrefix?: string;
|
|
372
|
+
/**
|
|
373
|
+
* For whom the client library is being published.
|
|
374
|
+
*
|
|
375
|
+
* @generated from field: google.api.ClientLibraryOrganization organization = 107;
|
|
376
|
+
*/
|
|
377
|
+
organization?: ClientLibraryOrganizationJson;
|
|
378
|
+
/**
|
|
379
|
+
* Client library settings. If the same version string appears multiple
|
|
380
|
+
* times in this list, then the last one wins. Settings from earlier
|
|
381
|
+
* settings with the same version string are discarded.
|
|
382
|
+
*
|
|
383
|
+
* @generated from field: repeated google.api.ClientLibrarySettings library_settings = 109;
|
|
384
|
+
*/
|
|
385
|
+
librarySettings?: ClientLibrarySettingsJson[];
|
|
386
|
+
/**
|
|
387
|
+
* Optional link to proto reference documentation. Example:
|
|
388
|
+
* https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
|
389
|
+
*
|
|
390
|
+
* @generated from field: string proto_reference_documentation_uri = 110;
|
|
391
|
+
*/
|
|
392
|
+
protoReferenceDocumentationUri?: string;
|
|
393
|
+
/**
|
|
394
|
+
* Optional link to REST reference documentation. Example:
|
|
395
|
+
* https://cloud.google.com/pubsub/lite/docs/reference/rest
|
|
396
|
+
*
|
|
397
|
+
* @generated from field: string rest_reference_documentation_uri = 111;
|
|
398
|
+
*/
|
|
399
|
+
restReferenceDocumentationUri?: string;
|
|
400
|
+
};
|
|
401
|
+
/**
|
|
402
|
+
* Describes the message google.api.Publishing.
|
|
403
|
+
* Use `create(PublishingSchema)` to create a new message.
|
|
404
|
+
*/
|
|
405
|
+
export declare const PublishingSchema: GenMessage<Publishing, {
|
|
406
|
+
jsonType: PublishingJson;
|
|
407
|
+
}>;
|
|
408
|
+
/**
|
|
409
|
+
* Settings for Java client libraries.
|
|
410
|
+
*
|
|
411
|
+
* @generated from message google.api.JavaSettings
|
|
412
|
+
*/
|
|
413
|
+
export type JavaSettings = Message<"google.api.JavaSettings"> & {
|
|
414
|
+
/**
|
|
415
|
+
* The package name to use in Java. Clobbers the java_package option
|
|
416
|
+
* set in the protobuf. This should be used **only** by APIs
|
|
417
|
+
* who have already set the language_settings.java.package_name" field
|
|
418
|
+
* in gapic.yaml. API teams should use the protobuf java_package option
|
|
419
|
+
* where possible.
|
|
420
|
+
*
|
|
421
|
+
* Example of a YAML configuration::
|
|
422
|
+
*
|
|
423
|
+
* publishing:
|
|
424
|
+
* java_settings:
|
|
425
|
+
* library_package: com.google.cloud.pubsub.v1
|
|
426
|
+
*
|
|
427
|
+
* @generated from field: string library_package = 1;
|
|
428
|
+
*/
|
|
429
|
+
libraryPackage: string;
|
|
430
|
+
/**
|
|
431
|
+
* Configure the Java class name to use instead of the service's for its
|
|
432
|
+
* corresponding generated GAPIC client. Keys are fully-qualified
|
|
433
|
+
* service names as they appear in the protobuf (including the full
|
|
434
|
+
* the language_settings.java.interface_names" field in gapic.yaml. API
|
|
435
|
+
* teams should otherwise use the service name as it appears in the
|
|
436
|
+
* protobuf.
|
|
437
|
+
*
|
|
438
|
+
* Example of a YAML configuration::
|
|
439
|
+
*
|
|
440
|
+
* publishing:
|
|
441
|
+
* java_settings:
|
|
442
|
+
* service_class_names:
|
|
443
|
+
* - google.pubsub.v1.Publisher: TopicAdmin
|
|
444
|
+
* - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
|
445
|
+
*
|
|
446
|
+
* @generated from field: map<string, string> service_class_names = 2;
|
|
447
|
+
*/
|
|
448
|
+
serviceClassNames: {
|
|
449
|
+
[key: string]: string;
|
|
450
|
+
};
|
|
451
|
+
/**
|
|
452
|
+
* Some settings.
|
|
453
|
+
*
|
|
454
|
+
* @generated from field: google.api.CommonLanguageSettings common = 3;
|
|
455
|
+
*/
|
|
456
|
+
common?: CommonLanguageSettings;
|
|
457
|
+
};
|
|
458
|
+
/**
|
|
459
|
+
* Settings for Java client libraries.
|
|
460
|
+
*
|
|
461
|
+
* @generated from message google.api.JavaSettings
|
|
462
|
+
*/
|
|
463
|
+
export type JavaSettingsJson = {
|
|
464
|
+
/**
|
|
465
|
+
* The package name to use in Java. Clobbers the java_package option
|
|
466
|
+
* set in the protobuf. This should be used **only** by APIs
|
|
467
|
+
* who have already set the language_settings.java.package_name" field
|
|
468
|
+
* in gapic.yaml. API teams should use the protobuf java_package option
|
|
469
|
+
* where possible.
|
|
470
|
+
*
|
|
471
|
+
* Example of a YAML configuration::
|
|
472
|
+
*
|
|
473
|
+
* publishing:
|
|
474
|
+
* java_settings:
|
|
475
|
+
* library_package: com.google.cloud.pubsub.v1
|
|
476
|
+
*
|
|
477
|
+
* @generated from field: string library_package = 1;
|
|
478
|
+
*/
|
|
479
|
+
libraryPackage?: string;
|
|
480
|
+
/**
|
|
481
|
+
* Configure the Java class name to use instead of the service's for its
|
|
482
|
+
* corresponding generated GAPIC client. Keys are fully-qualified
|
|
483
|
+
* service names as they appear in the protobuf (including the full
|
|
484
|
+
* the language_settings.java.interface_names" field in gapic.yaml. API
|
|
485
|
+
* teams should otherwise use the service name as it appears in the
|
|
486
|
+
* protobuf.
|
|
487
|
+
*
|
|
488
|
+
* Example of a YAML configuration::
|
|
489
|
+
*
|
|
490
|
+
* publishing:
|
|
491
|
+
* java_settings:
|
|
492
|
+
* service_class_names:
|
|
493
|
+
* - google.pubsub.v1.Publisher: TopicAdmin
|
|
494
|
+
* - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
|
495
|
+
*
|
|
496
|
+
* @generated from field: map<string, string> service_class_names = 2;
|
|
497
|
+
*/
|
|
498
|
+
serviceClassNames?: {
|
|
499
|
+
[key: string]: string;
|
|
500
|
+
};
|
|
501
|
+
/**
|
|
502
|
+
* Some settings.
|
|
503
|
+
*
|
|
504
|
+
* @generated from field: google.api.CommonLanguageSettings common = 3;
|
|
505
|
+
*/
|
|
506
|
+
common?: CommonLanguageSettingsJson;
|
|
507
|
+
};
|
|
508
|
+
/**
|
|
509
|
+
* Describes the message google.api.JavaSettings.
|
|
510
|
+
* Use `create(JavaSettingsSchema)` to create a new message.
|
|
511
|
+
*/
|
|
512
|
+
export declare const JavaSettingsSchema: GenMessage<JavaSettings, {
|
|
513
|
+
jsonType: JavaSettingsJson;
|
|
514
|
+
}>;
|
|
515
|
+
/**
|
|
516
|
+
* Settings for C++ client libraries.
|
|
517
|
+
*
|
|
518
|
+
* @generated from message google.api.CppSettings
|
|
519
|
+
*/
|
|
520
|
+
export type CppSettings = Message<"google.api.CppSettings"> & {
|
|
521
|
+
/**
|
|
522
|
+
* Some settings.
|
|
523
|
+
*
|
|
524
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
525
|
+
*/
|
|
526
|
+
common?: CommonLanguageSettings;
|
|
527
|
+
};
|
|
528
|
+
/**
|
|
529
|
+
* Settings for C++ client libraries.
|
|
530
|
+
*
|
|
531
|
+
* @generated from message google.api.CppSettings
|
|
532
|
+
*/
|
|
533
|
+
export type CppSettingsJson = {
|
|
534
|
+
/**
|
|
535
|
+
* Some settings.
|
|
536
|
+
*
|
|
537
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
538
|
+
*/
|
|
539
|
+
common?: CommonLanguageSettingsJson;
|
|
540
|
+
};
|
|
541
|
+
/**
|
|
542
|
+
* Describes the message google.api.CppSettings.
|
|
543
|
+
* Use `create(CppSettingsSchema)` to create a new message.
|
|
544
|
+
*/
|
|
545
|
+
export declare const CppSettingsSchema: GenMessage<CppSettings, {
|
|
546
|
+
jsonType: CppSettingsJson;
|
|
547
|
+
}>;
|
|
548
|
+
/**
|
|
549
|
+
* Settings for Php client libraries.
|
|
550
|
+
*
|
|
551
|
+
* @generated from message google.api.PhpSettings
|
|
552
|
+
*/
|
|
553
|
+
export type PhpSettings = Message<"google.api.PhpSettings"> & {
|
|
554
|
+
/**
|
|
555
|
+
* Some settings.
|
|
556
|
+
*
|
|
557
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
558
|
+
*/
|
|
559
|
+
common?: CommonLanguageSettings;
|
|
560
|
+
};
|
|
561
|
+
/**
|
|
562
|
+
* Settings for Php client libraries.
|
|
563
|
+
*
|
|
564
|
+
* @generated from message google.api.PhpSettings
|
|
565
|
+
*/
|
|
566
|
+
export type PhpSettingsJson = {
|
|
567
|
+
/**
|
|
568
|
+
* Some settings.
|
|
569
|
+
*
|
|
570
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
571
|
+
*/
|
|
572
|
+
common?: CommonLanguageSettingsJson;
|
|
573
|
+
};
|
|
574
|
+
/**
|
|
575
|
+
* Describes the message google.api.PhpSettings.
|
|
576
|
+
* Use `create(PhpSettingsSchema)` to create a new message.
|
|
577
|
+
*/
|
|
578
|
+
export declare const PhpSettingsSchema: GenMessage<PhpSettings, {
|
|
579
|
+
jsonType: PhpSettingsJson;
|
|
580
|
+
}>;
|
|
581
|
+
/**
|
|
582
|
+
* Settings for Python client libraries.
|
|
583
|
+
*
|
|
584
|
+
* @generated from message google.api.PythonSettings
|
|
585
|
+
*/
|
|
586
|
+
export type PythonSettings = Message<"google.api.PythonSettings"> & {
|
|
587
|
+
/**
|
|
588
|
+
* Some settings.
|
|
589
|
+
*
|
|
590
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
591
|
+
*/
|
|
592
|
+
common?: CommonLanguageSettings;
|
|
593
|
+
/**
|
|
594
|
+
* Experimental features to be included during client library generation.
|
|
595
|
+
*
|
|
596
|
+
* @generated from field: google.api.PythonSettings.ExperimentalFeatures experimental_features = 2;
|
|
597
|
+
*/
|
|
598
|
+
experimentalFeatures?: PythonSettings_ExperimentalFeatures;
|
|
599
|
+
};
|
|
600
|
+
/**
|
|
601
|
+
* Settings for Python client libraries.
|
|
602
|
+
*
|
|
603
|
+
* @generated from message google.api.PythonSettings
|
|
604
|
+
*/
|
|
605
|
+
export type PythonSettingsJson = {
|
|
606
|
+
/**
|
|
607
|
+
* Some settings.
|
|
608
|
+
*
|
|
609
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
610
|
+
*/
|
|
611
|
+
common?: CommonLanguageSettingsJson;
|
|
612
|
+
/**
|
|
613
|
+
* Experimental features to be included during client library generation.
|
|
614
|
+
*
|
|
615
|
+
* @generated from field: google.api.PythonSettings.ExperimentalFeatures experimental_features = 2;
|
|
616
|
+
*/
|
|
617
|
+
experimentalFeatures?: PythonSettings_ExperimentalFeaturesJson;
|
|
618
|
+
};
|
|
619
|
+
/**
|
|
620
|
+
* Describes the message google.api.PythonSettings.
|
|
621
|
+
* Use `create(PythonSettingsSchema)` to create a new message.
|
|
622
|
+
*/
|
|
623
|
+
export declare const PythonSettingsSchema: GenMessage<PythonSettings, {
|
|
624
|
+
jsonType: PythonSettingsJson;
|
|
625
|
+
}>;
|
|
626
|
+
/**
|
|
627
|
+
* Experimental features to be included during client library generation.
|
|
628
|
+
* These fields will be deprecated once the feature graduates and is enabled
|
|
629
|
+
* by default.
|
|
630
|
+
*
|
|
631
|
+
* @generated from message google.api.PythonSettings.ExperimentalFeatures
|
|
632
|
+
*/
|
|
633
|
+
export type PythonSettings_ExperimentalFeatures = Message<"google.api.PythonSettings.ExperimentalFeatures"> & {
|
|
634
|
+
/**
|
|
635
|
+
* Enables generation of asynchronous REST clients if `rest` transport is
|
|
636
|
+
* enabled. By default, asynchronous REST clients will not be generated.
|
|
637
|
+
* This feature will be enabled by default 1 month after launching the
|
|
638
|
+
* feature in preview packages.
|
|
639
|
+
*
|
|
640
|
+
* @generated from field: bool rest_async_io_enabled = 1;
|
|
641
|
+
*/
|
|
642
|
+
restAsyncIoEnabled: boolean;
|
|
643
|
+
/**
|
|
644
|
+
* Enables generation of protobuf code using new types that are more
|
|
645
|
+
* Pythonic which are included in `protobuf>=5.29.x`. This feature will be
|
|
646
|
+
* enabled by default 1 month after launching the feature in preview
|
|
647
|
+
* packages.
|
|
648
|
+
*
|
|
649
|
+
* @generated from field: bool protobuf_pythonic_types_enabled = 2;
|
|
650
|
+
*/
|
|
651
|
+
protobufPythonicTypesEnabled: boolean;
|
|
652
|
+
/**
|
|
653
|
+
* Disables generation of an unversioned Python package for this client
|
|
654
|
+
* library. This means that the module names will need to be versioned in
|
|
655
|
+
* import statements. For example `import google.cloud.library_v2` instead
|
|
656
|
+
* of `import google.cloud.library`.
|
|
657
|
+
*
|
|
658
|
+
* @generated from field: bool unversioned_package_disabled = 3;
|
|
659
|
+
*/
|
|
660
|
+
unversionedPackageDisabled: boolean;
|
|
661
|
+
};
|
|
662
|
+
/**
|
|
663
|
+
* Experimental features to be included during client library generation.
|
|
664
|
+
* These fields will be deprecated once the feature graduates and is enabled
|
|
665
|
+
* by default.
|
|
666
|
+
*
|
|
667
|
+
* @generated from message google.api.PythonSettings.ExperimentalFeatures
|
|
668
|
+
*/
|
|
669
|
+
export type PythonSettings_ExperimentalFeaturesJson = {
|
|
670
|
+
/**
|
|
671
|
+
* Enables generation of asynchronous REST clients if `rest` transport is
|
|
672
|
+
* enabled. By default, asynchronous REST clients will not be generated.
|
|
673
|
+
* This feature will be enabled by default 1 month after launching the
|
|
674
|
+
* feature in preview packages.
|
|
675
|
+
*
|
|
676
|
+
* @generated from field: bool rest_async_io_enabled = 1;
|
|
677
|
+
*/
|
|
678
|
+
restAsyncIoEnabled?: boolean;
|
|
679
|
+
/**
|
|
680
|
+
* Enables generation of protobuf code using new types that are more
|
|
681
|
+
* Pythonic which are included in `protobuf>=5.29.x`. This feature will be
|
|
682
|
+
* enabled by default 1 month after launching the feature in preview
|
|
683
|
+
* packages.
|
|
684
|
+
*
|
|
685
|
+
* @generated from field: bool protobuf_pythonic_types_enabled = 2;
|
|
686
|
+
*/
|
|
687
|
+
protobufPythonicTypesEnabled?: boolean;
|
|
688
|
+
/**
|
|
689
|
+
* Disables generation of an unversioned Python package for this client
|
|
690
|
+
* library. This means that the module names will need to be versioned in
|
|
691
|
+
* import statements. For example `import google.cloud.library_v2` instead
|
|
692
|
+
* of `import google.cloud.library`.
|
|
693
|
+
*
|
|
694
|
+
* @generated from field: bool unversioned_package_disabled = 3;
|
|
695
|
+
*/
|
|
696
|
+
unversionedPackageDisabled?: boolean;
|
|
697
|
+
};
|
|
698
|
+
/**
|
|
699
|
+
* Describes the message google.api.PythonSettings.ExperimentalFeatures.
|
|
700
|
+
* Use `create(PythonSettings_ExperimentalFeaturesSchema)` to create a new message.
|
|
701
|
+
*/
|
|
702
|
+
export declare const PythonSettings_ExperimentalFeaturesSchema: GenMessage<PythonSettings_ExperimentalFeatures, {
|
|
703
|
+
jsonType: PythonSettings_ExperimentalFeaturesJson;
|
|
704
|
+
}>;
|
|
705
|
+
/**
|
|
706
|
+
* Settings for Node client libraries.
|
|
707
|
+
*
|
|
708
|
+
* @generated from message google.api.NodeSettings
|
|
709
|
+
*/
|
|
710
|
+
export type NodeSettings = Message<"google.api.NodeSettings"> & {
|
|
711
|
+
/**
|
|
712
|
+
* Some settings.
|
|
713
|
+
*
|
|
714
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
715
|
+
*/
|
|
716
|
+
common?: CommonLanguageSettings;
|
|
717
|
+
};
|
|
718
|
+
/**
|
|
719
|
+
* Settings for Node client libraries.
|
|
720
|
+
*
|
|
721
|
+
* @generated from message google.api.NodeSettings
|
|
722
|
+
*/
|
|
723
|
+
export type NodeSettingsJson = {
|
|
724
|
+
/**
|
|
725
|
+
* Some settings.
|
|
726
|
+
*
|
|
727
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
728
|
+
*/
|
|
729
|
+
common?: CommonLanguageSettingsJson;
|
|
730
|
+
};
|
|
731
|
+
/**
|
|
732
|
+
* Describes the message google.api.NodeSettings.
|
|
733
|
+
* Use `create(NodeSettingsSchema)` to create a new message.
|
|
734
|
+
*/
|
|
735
|
+
export declare const NodeSettingsSchema: GenMessage<NodeSettings, {
|
|
736
|
+
jsonType: NodeSettingsJson;
|
|
737
|
+
}>;
|
|
738
|
+
/**
|
|
739
|
+
* Settings for Dotnet client libraries.
|
|
740
|
+
*
|
|
741
|
+
* @generated from message google.api.DotnetSettings
|
|
742
|
+
*/
|
|
743
|
+
export type DotnetSettings = Message<"google.api.DotnetSettings"> & {
|
|
744
|
+
/**
|
|
745
|
+
* Some settings.
|
|
746
|
+
*
|
|
747
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
748
|
+
*/
|
|
749
|
+
common?: CommonLanguageSettings;
|
|
750
|
+
/**
|
|
751
|
+
* Map from original service names to renamed versions.
|
|
752
|
+
* This is used when the default generated types
|
|
753
|
+
* would cause a naming conflict. (Neither name is
|
|
754
|
+
* fully-qualified.)
|
|
755
|
+
* Example: Subscriber to SubscriberServiceApi.
|
|
756
|
+
*
|
|
757
|
+
* @generated from field: map<string, string> renamed_services = 2;
|
|
758
|
+
*/
|
|
759
|
+
renamedServices: {
|
|
760
|
+
[key: string]: string;
|
|
761
|
+
};
|
|
762
|
+
/**
|
|
763
|
+
* Map from full resource types to the effective short name
|
|
764
|
+
* for the resource. This is used when otherwise resource
|
|
765
|
+
* named from different services would cause naming collisions.
|
|
766
|
+
* Example entry:
|
|
767
|
+
* "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
|
768
|
+
*
|
|
769
|
+
* @generated from field: map<string, string> renamed_resources = 3;
|
|
770
|
+
*/
|
|
771
|
+
renamedResources: {
|
|
772
|
+
[key: string]: string;
|
|
773
|
+
};
|
|
774
|
+
/**
|
|
775
|
+
* List of full resource types to ignore during generation.
|
|
776
|
+
* This is typically used for API-specific Location resources,
|
|
777
|
+
* which should be handled by the generator as if they were actually
|
|
778
|
+
* the common Location resources.
|
|
779
|
+
* Example entry: "documentai.googleapis.com/Location"
|
|
780
|
+
*
|
|
781
|
+
* @generated from field: repeated string ignored_resources = 4;
|
|
782
|
+
*/
|
|
783
|
+
ignoredResources: string[];
|
|
784
|
+
/**
|
|
785
|
+
* Namespaces which must be aliased in snippets due to
|
|
786
|
+
* a known (but non-generator-predictable) naming collision
|
|
787
|
+
*
|
|
788
|
+
* @generated from field: repeated string forced_namespace_aliases = 5;
|
|
789
|
+
*/
|
|
790
|
+
forcedNamespaceAliases: string[];
|
|
791
|
+
/**
|
|
792
|
+
* Method signatures (in the form "service.method(signature)")
|
|
793
|
+
* which are provided separately, so shouldn't be generated.
|
|
794
|
+
* Snippets *calling* these methods are still generated, however.
|
|
795
|
+
*
|
|
796
|
+
* @generated from field: repeated string handwritten_signatures = 6;
|
|
797
|
+
*/
|
|
798
|
+
handwrittenSignatures: string[];
|
|
799
|
+
};
|
|
800
|
+
/**
|
|
801
|
+
* Settings for Dotnet client libraries.
|
|
802
|
+
*
|
|
803
|
+
* @generated from message google.api.DotnetSettings
|
|
804
|
+
*/
|
|
805
|
+
export type DotnetSettingsJson = {
|
|
806
|
+
/**
|
|
807
|
+
* Some settings.
|
|
808
|
+
*
|
|
809
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
810
|
+
*/
|
|
811
|
+
common?: CommonLanguageSettingsJson;
|
|
812
|
+
/**
|
|
813
|
+
* Map from original service names to renamed versions.
|
|
814
|
+
* This is used when the default generated types
|
|
815
|
+
* would cause a naming conflict. (Neither name is
|
|
816
|
+
* fully-qualified.)
|
|
817
|
+
* Example: Subscriber to SubscriberServiceApi.
|
|
818
|
+
*
|
|
819
|
+
* @generated from field: map<string, string> renamed_services = 2;
|
|
820
|
+
*/
|
|
821
|
+
renamedServices?: {
|
|
822
|
+
[key: string]: string;
|
|
823
|
+
};
|
|
824
|
+
/**
|
|
825
|
+
* Map from full resource types to the effective short name
|
|
826
|
+
* for the resource. This is used when otherwise resource
|
|
827
|
+
* named from different services would cause naming collisions.
|
|
828
|
+
* Example entry:
|
|
829
|
+
* "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
|
830
|
+
*
|
|
831
|
+
* @generated from field: map<string, string> renamed_resources = 3;
|
|
832
|
+
*/
|
|
833
|
+
renamedResources?: {
|
|
834
|
+
[key: string]: string;
|
|
835
|
+
};
|
|
836
|
+
/**
|
|
837
|
+
* List of full resource types to ignore during generation.
|
|
838
|
+
* This is typically used for API-specific Location resources,
|
|
839
|
+
* which should be handled by the generator as if they were actually
|
|
840
|
+
* the common Location resources.
|
|
841
|
+
* Example entry: "documentai.googleapis.com/Location"
|
|
842
|
+
*
|
|
843
|
+
* @generated from field: repeated string ignored_resources = 4;
|
|
844
|
+
*/
|
|
845
|
+
ignoredResources?: string[];
|
|
846
|
+
/**
|
|
847
|
+
* Namespaces which must be aliased in snippets due to
|
|
848
|
+
* a known (but non-generator-predictable) naming collision
|
|
849
|
+
*
|
|
850
|
+
* @generated from field: repeated string forced_namespace_aliases = 5;
|
|
851
|
+
*/
|
|
852
|
+
forcedNamespaceAliases?: string[];
|
|
853
|
+
/**
|
|
854
|
+
* Method signatures (in the form "service.method(signature)")
|
|
855
|
+
* which are provided separately, so shouldn't be generated.
|
|
856
|
+
* Snippets *calling* these methods are still generated, however.
|
|
857
|
+
*
|
|
858
|
+
* @generated from field: repeated string handwritten_signatures = 6;
|
|
859
|
+
*/
|
|
860
|
+
handwrittenSignatures?: string[];
|
|
861
|
+
};
|
|
862
|
+
/**
|
|
863
|
+
* Describes the message google.api.DotnetSettings.
|
|
864
|
+
* Use `create(DotnetSettingsSchema)` to create a new message.
|
|
865
|
+
*/
|
|
866
|
+
export declare const DotnetSettingsSchema: GenMessage<DotnetSettings, {
|
|
867
|
+
jsonType: DotnetSettingsJson;
|
|
868
|
+
}>;
|
|
869
|
+
/**
|
|
870
|
+
* Settings for Ruby client libraries.
|
|
871
|
+
*
|
|
872
|
+
* @generated from message google.api.RubySettings
|
|
873
|
+
*/
|
|
874
|
+
export type RubySettings = Message<"google.api.RubySettings"> & {
|
|
875
|
+
/**
|
|
876
|
+
* Some settings.
|
|
877
|
+
*
|
|
878
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
879
|
+
*/
|
|
880
|
+
common?: CommonLanguageSettings;
|
|
881
|
+
};
|
|
882
|
+
/**
|
|
883
|
+
* Settings for Ruby client libraries.
|
|
884
|
+
*
|
|
885
|
+
* @generated from message google.api.RubySettings
|
|
886
|
+
*/
|
|
887
|
+
export type RubySettingsJson = {
|
|
888
|
+
/**
|
|
889
|
+
* Some settings.
|
|
890
|
+
*
|
|
891
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
892
|
+
*/
|
|
893
|
+
common?: CommonLanguageSettingsJson;
|
|
894
|
+
};
|
|
895
|
+
/**
|
|
896
|
+
* Describes the message google.api.RubySettings.
|
|
897
|
+
* Use `create(RubySettingsSchema)` to create a new message.
|
|
898
|
+
*/
|
|
899
|
+
export declare const RubySettingsSchema: GenMessage<RubySettings, {
|
|
900
|
+
jsonType: RubySettingsJson;
|
|
901
|
+
}>;
|
|
902
|
+
/**
|
|
903
|
+
* Settings for Go client libraries.
|
|
904
|
+
*
|
|
905
|
+
* @generated from message google.api.GoSettings
|
|
906
|
+
*/
|
|
907
|
+
export type GoSettings = Message<"google.api.GoSettings"> & {
|
|
908
|
+
/**
|
|
909
|
+
* Some settings.
|
|
910
|
+
*
|
|
911
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
912
|
+
*/
|
|
913
|
+
common?: CommonLanguageSettings;
|
|
914
|
+
/**
|
|
915
|
+
* Map of service names to renamed services. Keys are the package relative
|
|
916
|
+
* service names and values are the name to be used for the service client
|
|
917
|
+
* and call options.
|
|
918
|
+
*
|
|
919
|
+
* publishing:
|
|
920
|
+
* go_settings:
|
|
921
|
+
* renamed_services:
|
|
922
|
+
* Publisher: TopicAdmin
|
|
923
|
+
*
|
|
924
|
+
* @generated from field: map<string, string> renamed_services = 2;
|
|
925
|
+
*/
|
|
926
|
+
renamedServices: {
|
|
927
|
+
[key: string]: string;
|
|
928
|
+
};
|
|
929
|
+
};
|
|
930
|
+
/**
|
|
931
|
+
* Settings for Go client libraries.
|
|
932
|
+
*
|
|
933
|
+
* @generated from message google.api.GoSettings
|
|
934
|
+
*/
|
|
935
|
+
export type GoSettingsJson = {
|
|
936
|
+
/**
|
|
937
|
+
* Some settings.
|
|
938
|
+
*
|
|
939
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
940
|
+
*/
|
|
941
|
+
common?: CommonLanguageSettingsJson;
|
|
942
|
+
/**
|
|
943
|
+
* Map of service names to renamed services. Keys are the package relative
|
|
944
|
+
* service names and values are the name to be used for the service client
|
|
945
|
+
* and call options.
|
|
946
|
+
*
|
|
947
|
+
* publishing:
|
|
948
|
+
* go_settings:
|
|
949
|
+
* renamed_services:
|
|
950
|
+
* Publisher: TopicAdmin
|
|
951
|
+
*
|
|
952
|
+
* @generated from field: map<string, string> renamed_services = 2;
|
|
953
|
+
*/
|
|
954
|
+
renamedServices?: {
|
|
955
|
+
[key: string]: string;
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
/**
|
|
959
|
+
* Describes the message google.api.GoSettings.
|
|
960
|
+
* Use `create(GoSettingsSchema)` to create a new message.
|
|
961
|
+
*/
|
|
962
|
+
export declare const GoSettingsSchema: GenMessage<GoSettings, {
|
|
963
|
+
jsonType: GoSettingsJson;
|
|
964
|
+
}>;
|
|
965
|
+
/**
|
|
966
|
+
* Describes the generator configuration for a method.
|
|
967
|
+
*
|
|
968
|
+
* @generated from message google.api.MethodSettings
|
|
969
|
+
*/
|
|
970
|
+
export type MethodSettings = Message<"google.api.MethodSettings"> & {
|
|
971
|
+
/**
|
|
972
|
+
* The fully qualified name of the method, for which the options below apply.
|
|
973
|
+
* This is used to find the method to apply the options.
|
|
974
|
+
*
|
|
975
|
+
* Example:
|
|
976
|
+
*
|
|
977
|
+
* publishing:
|
|
978
|
+
* method_settings:
|
|
979
|
+
* - selector: google.storage.control.v2.StorageControl.CreateFolder
|
|
980
|
+
* # method settings for CreateFolder...
|
|
981
|
+
*
|
|
982
|
+
* @generated from field: string selector = 1;
|
|
983
|
+
*/
|
|
984
|
+
selector: string;
|
|
985
|
+
/**
|
|
986
|
+
* Describes settings to use for long-running operations when generating
|
|
987
|
+
* API methods for RPCs. Complements RPCs that use the annotations in
|
|
988
|
+
* google/longrunning/operations.proto.
|
|
989
|
+
*
|
|
990
|
+
* Example of a YAML configuration::
|
|
991
|
+
*
|
|
992
|
+
* publishing:
|
|
993
|
+
* method_settings:
|
|
994
|
+
* - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
|
995
|
+
* long_running:
|
|
996
|
+
* initial_poll_delay: 60s # 1 minute
|
|
997
|
+
* poll_delay_multiplier: 1.5
|
|
998
|
+
* max_poll_delay: 360s # 6 minutes
|
|
999
|
+
* total_poll_timeout: 54000s # 90 minutes
|
|
1000
|
+
*
|
|
1001
|
+
* @generated from field: google.api.MethodSettings.LongRunning long_running = 2;
|
|
1002
|
+
*/
|
|
1003
|
+
longRunning?: MethodSettings_LongRunning;
|
|
1004
|
+
/**
|
|
1005
|
+
* List of top-level fields of the request message, that should be
|
|
1006
|
+
* automatically populated by the client libraries based on their
|
|
1007
|
+
* (google.api.field_info).format. Currently supported format: UUID4.
|
|
1008
|
+
*
|
|
1009
|
+
* Example of a YAML configuration:
|
|
1010
|
+
*
|
|
1011
|
+
* publishing:
|
|
1012
|
+
* method_settings:
|
|
1013
|
+
* - selector: google.example.v1.ExampleService.CreateExample
|
|
1014
|
+
* auto_populated_fields:
|
|
1015
|
+
* - request_id
|
|
1016
|
+
*
|
|
1017
|
+
* @generated from field: repeated string auto_populated_fields = 3;
|
|
1018
|
+
*/
|
|
1019
|
+
autoPopulatedFields: string[];
|
|
1020
|
+
};
|
|
1021
|
+
/**
|
|
1022
|
+
* Describes the generator configuration for a method.
|
|
1023
|
+
*
|
|
1024
|
+
* @generated from message google.api.MethodSettings
|
|
1025
|
+
*/
|
|
1026
|
+
export type MethodSettingsJson = {
|
|
1027
|
+
/**
|
|
1028
|
+
* The fully qualified name of the method, for which the options below apply.
|
|
1029
|
+
* This is used to find the method to apply the options.
|
|
1030
|
+
*
|
|
1031
|
+
* Example:
|
|
1032
|
+
*
|
|
1033
|
+
* publishing:
|
|
1034
|
+
* method_settings:
|
|
1035
|
+
* - selector: google.storage.control.v2.StorageControl.CreateFolder
|
|
1036
|
+
* # method settings for CreateFolder...
|
|
1037
|
+
*
|
|
1038
|
+
* @generated from field: string selector = 1;
|
|
1039
|
+
*/
|
|
1040
|
+
selector?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Describes settings to use for long-running operations when generating
|
|
1043
|
+
* API methods for RPCs. Complements RPCs that use the annotations in
|
|
1044
|
+
* google/longrunning/operations.proto.
|
|
1045
|
+
*
|
|
1046
|
+
* Example of a YAML configuration::
|
|
1047
|
+
*
|
|
1048
|
+
* publishing:
|
|
1049
|
+
* method_settings:
|
|
1050
|
+
* - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
|
1051
|
+
* long_running:
|
|
1052
|
+
* initial_poll_delay: 60s # 1 minute
|
|
1053
|
+
* poll_delay_multiplier: 1.5
|
|
1054
|
+
* max_poll_delay: 360s # 6 minutes
|
|
1055
|
+
* total_poll_timeout: 54000s # 90 minutes
|
|
1056
|
+
*
|
|
1057
|
+
* @generated from field: google.api.MethodSettings.LongRunning long_running = 2;
|
|
1058
|
+
*/
|
|
1059
|
+
longRunning?: MethodSettings_LongRunningJson;
|
|
1060
|
+
/**
|
|
1061
|
+
* List of top-level fields of the request message, that should be
|
|
1062
|
+
* automatically populated by the client libraries based on their
|
|
1063
|
+
* (google.api.field_info).format. Currently supported format: UUID4.
|
|
1064
|
+
*
|
|
1065
|
+
* Example of a YAML configuration:
|
|
1066
|
+
*
|
|
1067
|
+
* publishing:
|
|
1068
|
+
* method_settings:
|
|
1069
|
+
* - selector: google.example.v1.ExampleService.CreateExample
|
|
1070
|
+
* auto_populated_fields:
|
|
1071
|
+
* - request_id
|
|
1072
|
+
*
|
|
1073
|
+
* @generated from field: repeated string auto_populated_fields = 3;
|
|
1074
|
+
*/
|
|
1075
|
+
autoPopulatedFields?: string[];
|
|
1076
|
+
};
|
|
1077
|
+
/**
|
|
1078
|
+
* Describes the message google.api.MethodSettings.
|
|
1079
|
+
* Use `create(MethodSettingsSchema)` to create a new message.
|
|
1080
|
+
*/
|
|
1081
|
+
export declare const MethodSettingsSchema: GenMessage<MethodSettings, {
|
|
1082
|
+
jsonType: MethodSettingsJson;
|
|
1083
|
+
}>;
|
|
1084
|
+
/**
|
|
1085
|
+
* Describes settings to use when generating API methods that use the
|
|
1086
|
+
* long-running operation pattern.
|
|
1087
|
+
* All default values below are from those used in the client library
|
|
1088
|
+
* generators (e.g.
|
|
1089
|
+
* [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
|
1090
|
+
*
|
|
1091
|
+
* @generated from message google.api.MethodSettings.LongRunning
|
|
1092
|
+
*/
|
|
1093
|
+
export type MethodSettings_LongRunning = Message<"google.api.MethodSettings.LongRunning"> & {
|
|
1094
|
+
/**
|
|
1095
|
+
* Initial delay after which the first poll request will be made.
|
|
1096
|
+
* Default value: 5 seconds.
|
|
1097
|
+
*
|
|
1098
|
+
* @generated from field: google.protobuf.Duration initial_poll_delay = 1;
|
|
1099
|
+
*/
|
|
1100
|
+
initialPollDelay?: Duration;
|
|
1101
|
+
/**
|
|
1102
|
+
* Multiplier to gradually increase delay between subsequent polls until it
|
|
1103
|
+
* reaches max_poll_delay.
|
|
1104
|
+
* Default value: 1.5.
|
|
1105
|
+
*
|
|
1106
|
+
* @generated from field: float poll_delay_multiplier = 2;
|
|
1107
|
+
*/
|
|
1108
|
+
pollDelayMultiplier: number;
|
|
1109
|
+
/**
|
|
1110
|
+
* Maximum time between two subsequent poll requests.
|
|
1111
|
+
* Default value: 45 seconds.
|
|
1112
|
+
*
|
|
1113
|
+
* @generated from field: google.protobuf.Duration max_poll_delay = 3;
|
|
1114
|
+
*/
|
|
1115
|
+
maxPollDelay?: Duration;
|
|
1116
|
+
/**
|
|
1117
|
+
* Total polling timeout.
|
|
1118
|
+
* Default value: 5 minutes.
|
|
1119
|
+
*
|
|
1120
|
+
* @generated from field: google.protobuf.Duration total_poll_timeout = 4;
|
|
1121
|
+
*/
|
|
1122
|
+
totalPollTimeout?: Duration;
|
|
1123
|
+
};
|
|
1124
|
+
/**
|
|
1125
|
+
* Describes settings to use when generating API methods that use the
|
|
1126
|
+
* long-running operation pattern.
|
|
1127
|
+
* All default values below are from those used in the client library
|
|
1128
|
+
* generators (e.g.
|
|
1129
|
+
* [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
|
1130
|
+
*
|
|
1131
|
+
* @generated from message google.api.MethodSettings.LongRunning
|
|
1132
|
+
*/
|
|
1133
|
+
export type MethodSettings_LongRunningJson = {
|
|
1134
|
+
/**
|
|
1135
|
+
* Initial delay after which the first poll request will be made.
|
|
1136
|
+
* Default value: 5 seconds.
|
|
1137
|
+
*
|
|
1138
|
+
* @generated from field: google.protobuf.Duration initial_poll_delay = 1;
|
|
1139
|
+
*/
|
|
1140
|
+
initialPollDelay?: DurationJson;
|
|
1141
|
+
/**
|
|
1142
|
+
* Multiplier to gradually increase delay between subsequent polls until it
|
|
1143
|
+
* reaches max_poll_delay.
|
|
1144
|
+
* Default value: 1.5.
|
|
1145
|
+
*
|
|
1146
|
+
* @generated from field: float poll_delay_multiplier = 2;
|
|
1147
|
+
*/
|
|
1148
|
+
pollDelayMultiplier?: number | "NaN" | "Infinity" | "-Infinity";
|
|
1149
|
+
/**
|
|
1150
|
+
* Maximum time between two subsequent poll requests.
|
|
1151
|
+
* Default value: 45 seconds.
|
|
1152
|
+
*
|
|
1153
|
+
* @generated from field: google.protobuf.Duration max_poll_delay = 3;
|
|
1154
|
+
*/
|
|
1155
|
+
maxPollDelay?: DurationJson;
|
|
1156
|
+
/**
|
|
1157
|
+
* Total polling timeout.
|
|
1158
|
+
* Default value: 5 minutes.
|
|
1159
|
+
*
|
|
1160
|
+
* @generated from field: google.protobuf.Duration total_poll_timeout = 4;
|
|
1161
|
+
*/
|
|
1162
|
+
totalPollTimeout?: DurationJson;
|
|
1163
|
+
};
|
|
1164
|
+
/**
|
|
1165
|
+
* Describes the message google.api.MethodSettings.LongRunning.
|
|
1166
|
+
* Use `create(MethodSettings_LongRunningSchema)` to create a new message.
|
|
1167
|
+
*/
|
|
1168
|
+
export declare const MethodSettings_LongRunningSchema: GenMessage<MethodSettings_LongRunning, {
|
|
1169
|
+
jsonType: MethodSettings_LongRunningJson;
|
|
1170
|
+
}>;
|
|
1171
|
+
/**
|
|
1172
|
+
* This message is used to configure the generation of a subset of the RPCs in
|
|
1173
|
+
* a service for client libraries.
|
|
1174
|
+
*
|
|
1175
|
+
* @generated from message google.api.SelectiveGapicGeneration
|
|
1176
|
+
*/
|
|
1177
|
+
export type SelectiveGapicGeneration = Message<"google.api.SelectiveGapicGeneration"> & {
|
|
1178
|
+
/**
|
|
1179
|
+
* An allowlist of the fully qualified names of RPCs that should be included
|
|
1180
|
+
* on public client surfaces.
|
|
1181
|
+
*
|
|
1182
|
+
* @generated from field: repeated string methods = 1;
|
|
1183
|
+
*/
|
|
1184
|
+
methods: string[];
|
|
1185
|
+
/**
|
|
1186
|
+
* Setting this to true indicates to the client generators that methods
|
|
1187
|
+
* that would be excluded from the generation should instead be generated
|
|
1188
|
+
* in a way that indicates these methods should not be consumed by
|
|
1189
|
+
* end users. How this is expressed is up to individual language
|
|
1190
|
+
* implementations to decide. Some examples may be: added annotations,
|
|
1191
|
+
* obfuscated identifiers, or other language idiomatic patterns.
|
|
1192
|
+
*
|
|
1193
|
+
* @generated from field: bool generate_omitted_as_internal = 2;
|
|
1194
|
+
*/
|
|
1195
|
+
generateOmittedAsInternal: boolean;
|
|
1196
|
+
};
|
|
1197
|
+
/**
|
|
1198
|
+
* This message is used to configure the generation of a subset of the RPCs in
|
|
1199
|
+
* a service for client libraries.
|
|
1200
|
+
*
|
|
1201
|
+
* @generated from message google.api.SelectiveGapicGeneration
|
|
1202
|
+
*/
|
|
1203
|
+
export type SelectiveGapicGenerationJson = {
|
|
1204
|
+
/**
|
|
1205
|
+
* An allowlist of the fully qualified names of RPCs that should be included
|
|
1206
|
+
* on public client surfaces.
|
|
1207
|
+
*
|
|
1208
|
+
* @generated from field: repeated string methods = 1;
|
|
1209
|
+
*/
|
|
1210
|
+
methods?: string[];
|
|
1211
|
+
/**
|
|
1212
|
+
* Setting this to true indicates to the client generators that methods
|
|
1213
|
+
* that would be excluded from the generation should instead be generated
|
|
1214
|
+
* in a way that indicates these methods should not be consumed by
|
|
1215
|
+
* end users. How this is expressed is up to individual language
|
|
1216
|
+
* implementations to decide. Some examples may be: added annotations,
|
|
1217
|
+
* obfuscated identifiers, or other language idiomatic patterns.
|
|
1218
|
+
*
|
|
1219
|
+
* @generated from field: bool generate_omitted_as_internal = 2;
|
|
1220
|
+
*/
|
|
1221
|
+
generateOmittedAsInternal?: boolean;
|
|
1222
|
+
};
|
|
1223
|
+
/**
|
|
1224
|
+
* Describes the message google.api.SelectiveGapicGeneration.
|
|
1225
|
+
* Use `create(SelectiveGapicGenerationSchema)` to create a new message.
|
|
1226
|
+
*/
|
|
1227
|
+
export declare const SelectiveGapicGenerationSchema: GenMessage<SelectiveGapicGeneration, {
|
|
1228
|
+
jsonType: SelectiveGapicGenerationJson;
|
|
1229
|
+
}>;
|
|
1230
|
+
/**
|
|
1231
|
+
* The organization for which the client libraries are being published.
|
|
1232
|
+
* Affects the url where generated docs are published, etc.
|
|
1233
|
+
*
|
|
1234
|
+
* @generated from enum google.api.ClientLibraryOrganization
|
|
1235
|
+
*/
|
|
1236
|
+
export declare enum ClientLibraryOrganization {
|
|
1237
|
+
/**
|
|
1238
|
+
* Not useful.
|
|
1239
|
+
*
|
|
1240
|
+
* @generated from enum value: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0;
|
|
1241
|
+
*/
|
|
1242
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0,
|
|
1243
|
+
/**
|
|
1244
|
+
* Google Cloud Platform Org.
|
|
1245
|
+
*
|
|
1246
|
+
* @generated from enum value: CLOUD = 1;
|
|
1247
|
+
*/
|
|
1248
|
+
CLOUD = 1,
|
|
1249
|
+
/**
|
|
1250
|
+
* Ads (Advertising) Org.
|
|
1251
|
+
*
|
|
1252
|
+
* @generated from enum value: ADS = 2;
|
|
1253
|
+
*/
|
|
1254
|
+
ADS = 2,
|
|
1255
|
+
/**
|
|
1256
|
+
* Photos Org.
|
|
1257
|
+
*
|
|
1258
|
+
* @generated from enum value: PHOTOS = 3;
|
|
1259
|
+
*/
|
|
1260
|
+
PHOTOS = 3,
|
|
1261
|
+
/**
|
|
1262
|
+
* Street View Org.
|
|
1263
|
+
*
|
|
1264
|
+
* @generated from enum value: STREET_VIEW = 4;
|
|
1265
|
+
*/
|
|
1266
|
+
STREET_VIEW = 4,
|
|
1267
|
+
/**
|
|
1268
|
+
* Shopping Org.
|
|
1269
|
+
*
|
|
1270
|
+
* @generated from enum value: SHOPPING = 5;
|
|
1271
|
+
*/
|
|
1272
|
+
SHOPPING = 5,
|
|
1273
|
+
/**
|
|
1274
|
+
* Geo Org.
|
|
1275
|
+
*
|
|
1276
|
+
* @generated from enum value: GEO = 6;
|
|
1277
|
+
*/
|
|
1278
|
+
GEO = 6,
|
|
1279
|
+
/**
|
|
1280
|
+
* Generative AI - https://developers.generativeai.google
|
|
1281
|
+
*
|
|
1282
|
+
* @generated from enum value: GENERATIVE_AI = 7;
|
|
1283
|
+
*/
|
|
1284
|
+
GENERATIVE_AI = 7
|
|
1285
|
+
}
|
|
1286
|
+
/**
|
|
1287
|
+
* The organization for which the client libraries are being published.
|
|
1288
|
+
* Affects the url where generated docs are published, etc.
|
|
1289
|
+
*
|
|
1290
|
+
* @generated from enum google.api.ClientLibraryOrganization
|
|
1291
|
+
*/
|
|
1292
|
+
export type ClientLibraryOrganizationJson = "CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED" | "CLOUD" | "ADS" | "PHOTOS" | "STREET_VIEW" | "SHOPPING" | "GEO" | "GENERATIVE_AI";
|
|
1293
|
+
/**
|
|
1294
|
+
* Describes the enum google.api.ClientLibraryOrganization.
|
|
1295
|
+
*/
|
|
1296
|
+
export declare const ClientLibraryOrganizationSchema: GenEnum<ClientLibraryOrganization, ClientLibraryOrganizationJson>;
|
|
1297
|
+
/**
|
|
1298
|
+
* To where should client libraries be published?
|
|
1299
|
+
*
|
|
1300
|
+
* @generated from enum google.api.ClientLibraryDestination
|
|
1301
|
+
*/
|
|
1302
|
+
export declare enum ClientLibraryDestination {
|
|
1303
|
+
/**
|
|
1304
|
+
* Client libraries will neither be generated nor published to package
|
|
1305
|
+
* managers.
|
|
1306
|
+
*
|
|
1307
|
+
* @generated from enum value: CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0;
|
|
1308
|
+
*/
|
|
1309
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0,
|
|
1310
|
+
/**
|
|
1311
|
+
* Generate the client library in a repo under github.com/googleapis,
|
|
1312
|
+
* but don't publish it to package managers.
|
|
1313
|
+
*
|
|
1314
|
+
* @generated from enum value: GITHUB = 10;
|
|
1315
|
+
*/
|
|
1316
|
+
GITHUB = 10,
|
|
1317
|
+
/**
|
|
1318
|
+
* Publish the library to package managers like nuget.org and npmjs.com.
|
|
1319
|
+
*
|
|
1320
|
+
* @generated from enum value: PACKAGE_MANAGER = 20;
|
|
1321
|
+
*/
|
|
1322
|
+
PACKAGE_MANAGER = 20
|
|
1323
|
+
}
|
|
1324
|
+
/**
|
|
1325
|
+
* To where should client libraries be published?
|
|
1326
|
+
*
|
|
1327
|
+
* @generated from enum google.api.ClientLibraryDestination
|
|
1328
|
+
*/
|
|
1329
|
+
export type ClientLibraryDestinationJson = "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED" | "GITHUB" | "PACKAGE_MANAGER";
|
|
1330
|
+
/**
|
|
1331
|
+
* Describes the enum google.api.ClientLibraryDestination.
|
|
1332
|
+
*/
|
|
1333
|
+
export declare const ClientLibraryDestinationSchema: GenEnum<ClientLibraryDestination, ClientLibraryDestinationJson>;
|
|
1334
|
+
/**
|
|
1335
|
+
* A definition of a client library method signature.
|
|
1336
|
+
*
|
|
1337
|
+
* In client libraries, each proto RPC corresponds to one or more methods
|
|
1338
|
+
* which the end user is able to call, and calls the underlying RPC.
|
|
1339
|
+
* Normally, this method receives a single argument (a struct or instance
|
|
1340
|
+
* corresponding to the RPC request object). Defining this field will
|
|
1341
|
+
* add one or more overloads providing flattened or simpler method signatures
|
|
1342
|
+
* in some languages.
|
|
1343
|
+
*
|
|
1344
|
+
* The fields on the method signature are provided as a comma-separated
|
|
1345
|
+
* string.
|
|
1346
|
+
*
|
|
1347
|
+
* For example, the proto RPC and annotation:
|
|
1348
|
+
*
|
|
1349
|
+
* rpc CreateSubscription(CreateSubscriptionRequest)
|
|
1350
|
+
* returns (Subscription) {
|
|
1351
|
+
* option (google.api.method_signature) = "name,topic";
|
|
1352
|
+
* }
|
|
1353
|
+
*
|
|
1354
|
+
* Would add the following Java overload (in addition to the method accepting
|
|
1355
|
+
* the request object):
|
|
1356
|
+
*
|
|
1357
|
+
* public final Subscription createSubscription(String name, String topic)
|
|
1358
|
+
*
|
|
1359
|
+
* The following backwards-compatibility guidelines apply:
|
|
1360
|
+
*
|
|
1361
|
+
* * Adding this annotation to an unannotated method is backwards
|
|
1362
|
+
* compatible.
|
|
1363
|
+
* * Adding this annotation to a method which already has existing
|
|
1364
|
+
* method signature annotations is backwards compatible if and only if
|
|
1365
|
+
* the new method signature annotation is last in the sequence.
|
|
1366
|
+
* * Modifying or removing an existing method signature annotation is
|
|
1367
|
+
* a breaking change.
|
|
1368
|
+
* * Re-ordering existing method signature annotations is a breaking
|
|
1369
|
+
* change.
|
|
1370
|
+
*
|
|
1371
|
+
* @generated from extension: repeated string method_signature = 1051;
|
|
1372
|
+
*/
|
|
1373
|
+
export declare const method_signature: GenExtension<MethodOptions, string[]>;
|
|
1374
|
+
/**
|
|
1375
|
+
* The hostname for this service.
|
|
1376
|
+
* This should be specified with no prefix or protocol.
|
|
1377
|
+
*
|
|
1378
|
+
* Example:
|
|
1379
|
+
*
|
|
1380
|
+
* service Foo {
|
|
1381
|
+
* option (google.api.default_host) = "foo.googleapi.com";
|
|
1382
|
+
* ...
|
|
1383
|
+
* }
|
|
1384
|
+
*
|
|
1385
|
+
* @generated from extension: string default_host = 1049;
|
|
1386
|
+
*/
|
|
1387
|
+
export declare const default_host: GenExtension<ServiceOptions, string>;
|
|
1388
|
+
/**
|
|
1389
|
+
* OAuth scopes needed for the client.
|
|
1390
|
+
*
|
|
1391
|
+
* Example:
|
|
1392
|
+
*
|
|
1393
|
+
* service Foo {
|
|
1394
|
+
* option (google.api.oauth_scopes) = \
|
|
1395
|
+
* "https://www.googleapis.com/auth/cloud-platform";
|
|
1396
|
+
* ...
|
|
1397
|
+
* }
|
|
1398
|
+
*
|
|
1399
|
+
* If there is more than one scope, use a comma-separated string:
|
|
1400
|
+
*
|
|
1401
|
+
* Example:
|
|
1402
|
+
*
|
|
1403
|
+
* service Foo {
|
|
1404
|
+
* option (google.api.oauth_scopes) = \
|
|
1405
|
+
* "https://www.googleapis.com/auth/cloud-platform,"
|
|
1406
|
+
* "https://www.googleapis.com/auth/monitoring";
|
|
1407
|
+
* ...
|
|
1408
|
+
* }
|
|
1409
|
+
*
|
|
1410
|
+
* @generated from extension: string oauth_scopes = 1050;
|
|
1411
|
+
*/
|
|
1412
|
+
export declare const oauth_scopes: GenExtension<ServiceOptions, string>;
|
|
1413
|
+
/**
|
|
1414
|
+
* The API version of this service, which should be sent by version-aware
|
|
1415
|
+
* clients to the service. This allows services to abide by the schema and
|
|
1416
|
+
* behavior of the service at the time this API version was deployed.
|
|
1417
|
+
* The format of the API version must be treated as opaque by clients.
|
|
1418
|
+
* Services may use a format with an apparent structure, but clients must
|
|
1419
|
+
* not rely on this to determine components within an API version, or attempt
|
|
1420
|
+
* to construct other valid API versions. Note that this is for upcoming
|
|
1421
|
+
* functionality and may not be implemented for all services.
|
|
1422
|
+
*
|
|
1423
|
+
* Example:
|
|
1424
|
+
*
|
|
1425
|
+
* service Foo {
|
|
1426
|
+
* option (google.api.api_version) = "v1_20230821_preview";
|
|
1427
|
+
* }
|
|
1428
|
+
*
|
|
1429
|
+
* @generated from extension: string api_version = 525000001;
|
|
1430
|
+
*/
|
|
1431
|
+
export declare const api_version: GenExtension<ServiceOptions, string>;
|
|
1432
|
+
//# sourceMappingURL=client_pb.d.ts.map
|