google-cloud-apigee_registry-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +144 -0
  6. data/lib/google/cloud/apigee_registry/v1/provisioning/client.rb +636 -0
  7. data/lib/google/cloud/apigee_registry/v1/provisioning/credentials.rb +47 -0
  8. data/lib/google/cloud/apigee_registry/v1/provisioning/operations.rb +767 -0
  9. data/lib/google/cloud/apigee_registry/v1/provisioning/paths.rb +69 -0
  10. data/lib/google/cloud/apigee_registry/v1/provisioning.rb +51 -0
  11. data/lib/google/cloud/apigee_registry/v1/registry/client.rb +4005 -0
  12. data/lib/google/cloud/apigee_registry/v1/registry/credentials.rb +47 -0
  13. data/lib/google/cloud/apigee_registry/v1/registry/paths.rb +238 -0
  14. data/lib/google/cloud/apigee_registry/v1/registry.rb +49 -0
  15. data/lib/google/cloud/apigee_registry/v1/version.rb +28 -0
  16. data/lib/google/cloud/apigee_registry/v1.rb +41 -0
  17. data/lib/google/cloud/apigeeregistry/v1/provisioning_service_pb.rb +73 -0
  18. data/lib/google/cloud/apigeeregistry/v1/provisioning_service_services_pb.rb +50 -0
  19. data/lib/google/cloud/apigeeregistry/v1/registry_models_pb.rb +90 -0
  20. data/lib/google/cloud/apigeeregistry/v1/registry_service_pb.rb +245 -0
  21. data/lib/google/cloud/apigeeregistry/v1/registry_service_services_pb.rb +128 -0
  22. data/lib/google-cloud-apigee_registry-v1.rb +21 -0
  23. data/proto_docs/README.md +4 -0
  24. data/proto_docs/google/api/field_behavior.rb +71 -0
  25. data/proto_docs/google/api/httpbody.rb +80 -0
  26. data/proto_docs/google/api/resource.rb +222 -0
  27. data/proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb +157 -0
  28. data/proto_docs/google/cloud/apigeeregistry/v1/registry_models.rb +407 -0
  29. data/proto_docs/google/cloud/apigeeregistry/v1/registry_service.rb +704 -0
  30. data/proto_docs/google/longrunning/operations.rb +164 -0
  31. data/proto_docs/google/protobuf/any.rb +141 -0
  32. data/proto_docs/google/protobuf/duration.rb +98 -0
  33. data/proto_docs/google/protobuf/empty.rb +36 -0
  34. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  35. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  36. data/proto_docs/google/rpc/status.rb +46 -0
  37. data/proto_docs/google/type/expr.rb +75 -0
  38. metadata +273 -0
@@ -0,0 +1,704 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module ApigeeRegistry
23
+ module V1
24
+ # Request message for ListApis.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The parent, which owns this collection of APIs.
28
+ # Format: projects/*/locations/*
29
+ # @!attribute [rw] page_size
30
+ # @return [::Integer]
31
+ # The maximum number of APIs to return.
32
+ # The service may return fewer than this value.
33
+ # If unspecified, at most 50 values will be returned.
34
+ # The maximum is 1000; values above 1000 will be coerced to 1000.
35
+ # @!attribute [rw] page_token
36
+ # @return [::String]
37
+ # A page token, received from a previous `ListApis` call.
38
+ # Provide this to retrieve the subsequent page.
39
+ #
40
+ # When paginating, all other parameters provided to `ListApis` must match
41
+ # the call that provided the page token.
42
+ # @!attribute [rw] filter
43
+ # @return [::String]
44
+ # An expression that can be used to filter the list. Filters use the Common
45
+ # Expression Language and can refer to all message fields.
46
+ class ListApisRequest
47
+ include ::Google::Protobuf::MessageExts
48
+ extend ::Google::Protobuf::MessageExts::ClassMethods
49
+ end
50
+
51
+ # Response message for ListApis.
52
+ # @!attribute [rw] apis
53
+ # @return [::Array<::Google::Cloud::ApigeeRegistry::V1::Api>]
54
+ # The APIs from the specified publisher.
55
+ # @!attribute [rw] next_page_token
56
+ # @return [::String]
57
+ # A token, which can be sent as `page_token` to retrieve the next page.
58
+ # If this field is omitted, there are no subsequent pages.
59
+ class ListApisResponse
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # Request message for GetApi.
65
+ # @!attribute [rw] name
66
+ # @return [::String]
67
+ # Required. The name of the API to retrieve.
68
+ # Format: projects/*/locations/*/apis/*
69
+ class GetApiRequest
70
+ include ::Google::Protobuf::MessageExts
71
+ extend ::Google::Protobuf::MessageExts::ClassMethods
72
+ end
73
+
74
+ # Request message for CreateApi.
75
+ # @!attribute [rw] parent
76
+ # @return [::String]
77
+ # Required. The parent, which owns this collection of APIs.
78
+ # Format: projects/*/locations/*
79
+ # @!attribute [rw] api
80
+ # @return [::Google::Cloud::ApigeeRegistry::V1::Api]
81
+ # Required. The API to create.
82
+ # @!attribute [rw] api_id
83
+ # @return [::String]
84
+ # Required. The ID to use for the api, which will become the final component of
85
+ # the api's resource name.
86
+ #
87
+ # This value should be 4-63 characters, and valid characters
88
+ # are /[a-z][0-9]-/.
89
+ #
90
+ # Following AIP-162, IDs must not have the form of a UUID.
91
+ class CreateApiRequest
92
+ include ::Google::Protobuf::MessageExts
93
+ extend ::Google::Protobuf::MessageExts::ClassMethods
94
+ end
95
+
96
+ # Request message for UpdateApi.
97
+ # @!attribute [rw] api
98
+ # @return [::Google::Cloud::ApigeeRegistry::V1::Api]
99
+ # Required. The API to update.
100
+ #
101
+ # The `name` field is used to identify the API to update.
102
+ # Format: projects/*/locations/*/apis/*
103
+ # @!attribute [rw] update_mask
104
+ # @return [::Google::Protobuf::FieldMask]
105
+ # The list of fields to be updated. If omitted, all fields are updated that
106
+ # are set in the request message (fields set to default values are ignored).
107
+ # If a "*" is specified, all fields are updated, including fields that are
108
+ # unspecified/default in the request.
109
+ # @!attribute [rw] allow_missing
110
+ # @return [::Boolean]
111
+ # If set to true, and the api is not found, a new api will be created.
112
+ # In this situation, `update_mask` is ignored.
113
+ class UpdateApiRequest
114
+ include ::Google::Protobuf::MessageExts
115
+ extend ::Google::Protobuf::MessageExts::ClassMethods
116
+ end
117
+
118
+ # Request message for DeleteApi.
119
+ # @!attribute [rw] name
120
+ # @return [::String]
121
+ # Required. The name of the API to delete.
122
+ # Format: projects/*/locations/*/apis/*
123
+ class DeleteApiRequest
124
+ include ::Google::Protobuf::MessageExts
125
+ extend ::Google::Protobuf::MessageExts::ClassMethods
126
+ end
127
+
128
+ # Request message for ListApiVersions.
129
+ # @!attribute [rw] parent
130
+ # @return [::String]
131
+ # Required. The parent, which owns this collection of versions.
132
+ # Format: projects/*/locations/*/apis/*
133
+ # @!attribute [rw] page_size
134
+ # @return [::Integer]
135
+ # The maximum number of versions to return.
136
+ # The service may return fewer than this value.
137
+ # If unspecified, at most 50 values will be returned.
138
+ # The maximum is 1000; values above 1000 will be coerced to 1000.
139
+ # @!attribute [rw] page_token
140
+ # @return [::String]
141
+ # A page token, received from a previous `ListApiVersions` call.
142
+ # Provide this to retrieve the subsequent page.
143
+ #
144
+ # When paginating, all other parameters provided to `ListApiVersions` must
145
+ # match the call that provided the page token.
146
+ # @!attribute [rw] filter
147
+ # @return [::String]
148
+ # An expression that can be used to filter the list. Filters use the Common
149
+ # Expression Language and can refer to all message fields.
150
+ class ListApiVersionsRequest
151
+ include ::Google::Protobuf::MessageExts
152
+ extend ::Google::Protobuf::MessageExts::ClassMethods
153
+ end
154
+
155
+ # Response message for ListApiVersions.
156
+ # @!attribute [rw] api_versions
157
+ # @return [::Array<::Google::Cloud::ApigeeRegistry::V1::ApiVersion>]
158
+ # The versions from the specified publisher.
159
+ # @!attribute [rw] next_page_token
160
+ # @return [::String]
161
+ # A token, which can be sent as `page_token` to retrieve the next page.
162
+ # If this field is omitted, there are no subsequent pages.
163
+ class ListApiVersionsResponse
164
+ include ::Google::Protobuf::MessageExts
165
+ extend ::Google::Protobuf::MessageExts::ClassMethods
166
+ end
167
+
168
+ # Request message for GetApiVersion.
169
+ # @!attribute [rw] name
170
+ # @return [::String]
171
+ # Required. The name of the version to retrieve.
172
+ # Format: projects/*/locations/*/apis/*/versions/*
173
+ class GetApiVersionRequest
174
+ include ::Google::Protobuf::MessageExts
175
+ extend ::Google::Protobuf::MessageExts::ClassMethods
176
+ end
177
+
178
+ # Request message for CreateApiVersion.
179
+ # @!attribute [rw] parent
180
+ # @return [::String]
181
+ # Required. The parent, which owns this collection of versions.
182
+ # Format: projects/*/locations/*/apis/*
183
+ # @!attribute [rw] api_version
184
+ # @return [::Google::Cloud::ApigeeRegistry::V1::ApiVersion]
185
+ # Required. The version to create.
186
+ # @!attribute [rw] api_version_id
187
+ # @return [::String]
188
+ # Required. The ID to use for the version, which will become the final component of
189
+ # the version's resource name.
190
+ #
191
+ # This value should be 1-63 characters, and valid characters
192
+ # are /[a-z][0-9]-/.
193
+ #
194
+ # Following AIP-162, IDs must not have the form of a UUID.
195
+ class CreateApiVersionRequest
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
+ end
199
+
200
+ # Request message for UpdateApiVersion.
201
+ # @!attribute [rw] api_version
202
+ # @return [::Google::Cloud::ApigeeRegistry::V1::ApiVersion]
203
+ # Required. The version to update.
204
+ #
205
+ # The `name` field is used to identify the version to update.
206
+ # Format: projects/*/locations/*/apis/*/versions/*
207
+ # @!attribute [rw] update_mask
208
+ # @return [::Google::Protobuf::FieldMask]
209
+ # The list of fields to be updated. If omitted, all fields are updated that
210
+ # are set in the request message (fields set to default values are ignored).
211
+ # If a "*" is specified, all fields are updated, including fields that are
212
+ # unspecified/default in the request.
213
+ # @!attribute [rw] allow_missing
214
+ # @return [::Boolean]
215
+ # If set to true, and the version is not found, a new version will be
216
+ # created. In this situation, `update_mask` is ignored.
217
+ class UpdateApiVersionRequest
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+
222
+ # Request message for DeleteApiVersion.
223
+ # @!attribute [rw] name
224
+ # @return [::String]
225
+ # Required. The name of the version to delete.
226
+ # Format: projects/*/locations/*/apis/*/versions/*
227
+ class DeleteApiVersionRequest
228
+ include ::Google::Protobuf::MessageExts
229
+ extend ::Google::Protobuf::MessageExts::ClassMethods
230
+ end
231
+
232
+ # Request message for ListApiSpecs.
233
+ # @!attribute [rw] parent
234
+ # @return [::String]
235
+ # Required. The parent, which owns this collection of specs.
236
+ # Format: projects/*/locations/*/apis/*/versions/*
237
+ # @!attribute [rw] page_size
238
+ # @return [::Integer]
239
+ # The maximum number of specs to return.
240
+ # The service may return fewer than this value.
241
+ # If unspecified, at most 50 values will be returned.
242
+ # The maximum is 1000; values above 1000 will be coerced to 1000.
243
+ # @!attribute [rw] page_token
244
+ # @return [::String]
245
+ # A page token, received from a previous `ListApiSpecs` call.
246
+ # Provide this to retrieve the subsequent page.
247
+ #
248
+ # When paginating, all other parameters provided to `ListApiSpecs` must match
249
+ # the call that provided the page token.
250
+ # @!attribute [rw] filter
251
+ # @return [::String]
252
+ # An expression that can be used to filter the list. Filters use the Common
253
+ # Expression Language and can refer to all message fields except contents.
254
+ class ListApiSpecsRequest
255
+ include ::Google::Protobuf::MessageExts
256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
257
+ end
258
+
259
+ # Response message for ListApiSpecs.
260
+ # @!attribute [rw] api_specs
261
+ # @return [::Array<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>]
262
+ # The specs from the specified publisher.
263
+ # @!attribute [rw] next_page_token
264
+ # @return [::String]
265
+ # A token, which can be sent as `page_token` to retrieve the next page.
266
+ # If this field is omitted, there are no subsequent pages.
267
+ class ListApiSpecsResponse
268
+ include ::Google::Protobuf::MessageExts
269
+ extend ::Google::Protobuf::MessageExts::ClassMethods
270
+ end
271
+
272
+ # Request message for GetApiSpec.
273
+ # @!attribute [rw] name
274
+ # @return [::String]
275
+ # Required. The name of the spec to retrieve.
276
+ # Format: projects/*/locations/*/apis/*/versions/*/specs/*
277
+ class GetApiSpecRequest
278
+ include ::Google::Protobuf::MessageExts
279
+ extend ::Google::Protobuf::MessageExts::ClassMethods
280
+ end
281
+
282
+ # Request message for GetApiSpecContents.
283
+ # @!attribute [rw] name
284
+ # @return [::String]
285
+ # Required. The name of the spec whose contents should be retrieved.
286
+ # Format: projects/*/locations/*/apis/*/versions/*/specs/*
287
+ class GetApiSpecContentsRequest
288
+ include ::Google::Protobuf::MessageExts
289
+ extend ::Google::Protobuf::MessageExts::ClassMethods
290
+ end
291
+
292
+ # Request message for CreateApiSpec.
293
+ # @!attribute [rw] parent
294
+ # @return [::String]
295
+ # Required. The parent, which owns this collection of specs.
296
+ # Format: projects/*/locations/*/apis/*/versions/*
297
+ # @!attribute [rw] api_spec
298
+ # @return [::Google::Cloud::ApigeeRegistry::V1::ApiSpec]
299
+ # Required. The spec to create.
300
+ # @!attribute [rw] api_spec_id
301
+ # @return [::String]
302
+ # Required. The ID to use for the spec, which will become the final component of
303
+ # the spec's resource name.
304
+ #
305
+ # This value should be 4-63 characters, and valid characters
306
+ # are /[a-z][0-9]-/.
307
+ #
308
+ # Following AIP-162, IDs must not have the form of a UUID.
309
+ class CreateApiSpecRequest
310
+ include ::Google::Protobuf::MessageExts
311
+ extend ::Google::Protobuf::MessageExts::ClassMethods
312
+ end
313
+
314
+ # Request message for UpdateApiSpec.
315
+ # @!attribute [rw] api_spec
316
+ # @return [::Google::Cloud::ApigeeRegistry::V1::ApiSpec]
317
+ # Required. The spec to update.
318
+ #
319
+ # The `name` field is used to identify the spec to update.
320
+ # Format: projects/*/locations/*/apis/*/versions/*/specs/*
321
+ # @!attribute [rw] update_mask
322
+ # @return [::Google::Protobuf::FieldMask]
323
+ # The list of fields to be updated. If omitted, all fields are updated that
324
+ # are set in the request message (fields set to default values are ignored).
325
+ # If a "*" is specified, all fields are updated, including fields that are
326
+ # unspecified/default in the request.
327
+ # @!attribute [rw] allow_missing
328
+ # @return [::Boolean]
329
+ # If set to true, and the spec is not found, a new spec will be created.
330
+ # In this situation, `update_mask` is ignored.
331
+ class UpdateApiSpecRequest
332
+ include ::Google::Protobuf::MessageExts
333
+ extend ::Google::Protobuf::MessageExts::ClassMethods
334
+ end
335
+
336
+ # Request message for DeleteApiSpec.
337
+ # @!attribute [rw] name
338
+ # @return [::String]
339
+ # Required. The name of the spec to delete.
340
+ # Format: projects/*/locations/*/apis/*/versions/*/specs/*
341
+ # @!attribute [rw] force
342
+ # @return [::Boolean]
343
+ # If set to true, any child resources will also be deleted.
344
+ # (Otherwise, the request will only work if there are no child resources.)
345
+ class DeleteApiSpecRequest
346
+ include ::Google::Protobuf::MessageExts
347
+ extend ::Google::Protobuf::MessageExts::ClassMethods
348
+ end
349
+
350
+ # Request message for TagApiSpecRevision.
351
+ # @!attribute [rw] name
352
+ # @return [::String]
353
+ # Required. The name of the spec to be tagged, including the revision ID.
354
+ # @!attribute [rw] tag
355
+ # @return [::String]
356
+ # Required. The tag to apply.
357
+ # The tag should be at most 40 characters, and match `[a-z][a-z0-9-]{3,39}`.
358
+ class TagApiSpecRevisionRequest
359
+ include ::Google::Protobuf::MessageExts
360
+ extend ::Google::Protobuf::MessageExts::ClassMethods
361
+ end
362
+
363
+ # Request message for ListApiSpecRevisions.
364
+ # @!attribute [rw] name
365
+ # @return [::String]
366
+ # Required. The name of the spec to list revisions for.
367
+ # @!attribute [rw] page_size
368
+ # @return [::Integer]
369
+ # The maximum number of revisions to return per page.
370
+ # @!attribute [rw] page_token
371
+ # @return [::String]
372
+ # The page token, received from a previous ListApiSpecRevisions call.
373
+ # Provide this to retrieve the subsequent page.
374
+ class ListApiSpecRevisionsRequest
375
+ include ::Google::Protobuf::MessageExts
376
+ extend ::Google::Protobuf::MessageExts::ClassMethods
377
+ end
378
+
379
+ # Response message for ListApiSpecRevisionsResponse.
380
+ # @!attribute [rw] api_specs
381
+ # @return [::Array<::Google::Cloud::ApigeeRegistry::V1::ApiSpec>]
382
+ # The revisions of the spec.
383
+ # @!attribute [rw] next_page_token
384
+ # @return [::String]
385
+ # A token that can be sent as `page_token` to retrieve the next page.
386
+ # If this field is omitted, there are no subsequent pages.
387
+ class ListApiSpecRevisionsResponse
388
+ include ::Google::Protobuf::MessageExts
389
+ extend ::Google::Protobuf::MessageExts::ClassMethods
390
+ end
391
+
392
+ # Request message for RollbackApiSpec.
393
+ # @!attribute [rw] name
394
+ # @return [::String]
395
+ # Required. The spec being rolled back.
396
+ # @!attribute [rw] revision_id
397
+ # @return [::String]
398
+ # Required. The revision ID to roll back to.
399
+ # It must be a revision of the same spec.
400
+ #
401
+ # Example: c7cfa2a8
402
+ class RollbackApiSpecRequest
403
+ include ::Google::Protobuf::MessageExts
404
+ extend ::Google::Protobuf::MessageExts::ClassMethods
405
+ end
406
+
407
+ # Request message for DeleteApiSpecRevision.
408
+ # @!attribute [rw] name
409
+ # @return [::String]
410
+ # Required. The name of the spec revision to be deleted,
411
+ # with a revision ID explicitly included.
412
+ #
413
+ # Example:
414
+ # projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8
415
+ class DeleteApiSpecRevisionRequest
416
+ include ::Google::Protobuf::MessageExts
417
+ extend ::Google::Protobuf::MessageExts::ClassMethods
418
+ end
419
+
420
+ # Request message for ListApiDeployments.
421
+ # @!attribute [rw] parent
422
+ # @return [::String]
423
+ # Required. The parent, which owns this collection of deployments.
424
+ # Format: projects/*/locations/*/apis/*
425
+ # @!attribute [rw] page_size
426
+ # @return [::Integer]
427
+ # The maximum number of deployments to return.
428
+ # The service may return fewer than this value.
429
+ # If unspecified, at most 50 values will be returned.
430
+ # The maximum is 1000; values above 1000 will be coerced to 1000.
431
+ # @!attribute [rw] page_token
432
+ # @return [::String]
433
+ # A page token, received from a previous `ListApiDeployments` call.
434
+ # Provide this to retrieve the subsequent page.
435
+ #
436
+ # When paginating, all other parameters provided to `ListApiDeployments` must
437
+ # match the call that provided the page token.
438
+ # @!attribute [rw] filter
439
+ # @return [::String]
440
+ # An expression that can be used to filter the list. Filters use the Common
441
+ # Expression Language and can refer to all message fields.
442
+ class ListApiDeploymentsRequest
443
+ include ::Google::Protobuf::MessageExts
444
+ extend ::Google::Protobuf::MessageExts::ClassMethods
445
+ end
446
+
447
+ # Response message for ListApiDeployments.
448
+ # @!attribute [rw] api_deployments
449
+ # @return [::Array<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>]
450
+ # The deployments from the specified publisher.
451
+ # @!attribute [rw] next_page_token
452
+ # @return [::String]
453
+ # A token, which can be sent as `page_token` to retrieve the next page.
454
+ # If this field is omitted, there are no subsequent pages.
455
+ class ListApiDeploymentsResponse
456
+ include ::Google::Protobuf::MessageExts
457
+ extend ::Google::Protobuf::MessageExts::ClassMethods
458
+ end
459
+
460
+ # Request message for GetApiDeployment.
461
+ # @!attribute [rw] name
462
+ # @return [::String]
463
+ # Required. The name of the deployment to retrieve.
464
+ # Format: projects/*/locations/*/apis/*/deployments/*
465
+ class GetApiDeploymentRequest
466
+ include ::Google::Protobuf::MessageExts
467
+ extend ::Google::Protobuf::MessageExts::ClassMethods
468
+ end
469
+
470
+ # Request message for CreateApiDeployment.
471
+ # @!attribute [rw] parent
472
+ # @return [::String]
473
+ # Required. The parent, which owns this collection of deployments.
474
+ # Format: projects/*/locations/*/apis/*
475
+ # @!attribute [rw] api_deployment
476
+ # @return [::Google::Cloud::ApigeeRegistry::V1::ApiDeployment]
477
+ # Required. The deployment to create.
478
+ # @!attribute [rw] api_deployment_id
479
+ # @return [::String]
480
+ # Required. The ID to use for the deployment, which will become the final component of
481
+ # the deployment's resource name.
482
+ #
483
+ # This value should be 4-63 characters, and valid characters
484
+ # are /[a-z][0-9]-/.
485
+ #
486
+ # Following AIP-162, IDs must not have the form of a UUID.
487
+ class CreateApiDeploymentRequest
488
+ include ::Google::Protobuf::MessageExts
489
+ extend ::Google::Protobuf::MessageExts::ClassMethods
490
+ end
491
+
492
+ # Request message for UpdateApiDeployment.
493
+ # @!attribute [rw] api_deployment
494
+ # @return [::Google::Cloud::ApigeeRegistry::V1::ApiDeployment]
495
+ # Required. The deployment to update.
496
+ #
497
+ # The `name` field is used to identify the deployment to update.
498
+ # Format: projects/*/locations/*/apis/*/deployments/*
499
+ # @!attribute [rw] update_mask
500
+ # @return [::Google::Protobuf::FieldMask]
501
+ # The list of fields to be updated. If omitted, all fields are updated that
502
+ # are set in the request message (fields set to default values are ignored).
503
+ # If a "*" is specified, all fields are updated, including fields that are
504
+ # unspecified/default in the request.
505
+ # @!attribute [rw] allow_missing
506
+ # @return [::Boolean]
507
+ # If set to true, and the deployment is not found, a new deployment will be
508
+ # created. In this situation, `update_mask` is ignored.
509
+ class UpdateApiDeploymentRequest
510
+ include ::Google::Protobuf::MessageExts
511
+ extend ::Google::Protobuf::MessageExts::ClassMethods
512
+ end
513
+
514
+ # Request message for DeleteApiDeployment.
515
+ # @!attribute [rw] name
516
+ # @return [::String]
517
+ # Required. The name of the deployment to delete.
518
+ # Format: projects/*/locations/*/apis/*/deployments/*
519
+ # @!attribute [rw] force
520
+ # @return [::Boolean]
521
+ # If set to true, any child resources will also be deleted.
522
+ # (Otherwise, the request will only work if there are no child resources.)
523
+ class DeleteApiDeploymentRequest
524
+ include ::Google::Protobuf::MessageExts
525
+ extend ::Google::Protobuf::MessageExts::ClassMethods
526
+ end
527
+
528
+ # Request message for TagApiDeploymentRevision.
529
+ # @!attribute [rw] name
530
+ # @return [::String]
531
+ # Required. The name of the deployment to be tagged, including the revision ID.
532
+ # @!attribute [rw] tag
533
+ # @return [::String]
534
+ # Required. The tag to apply.
535
+ # The tag should be at most 40 characters, and match `[a-z][a-z0-9-]{3,39}`.
536
+ class TagApiDeploymentRevisionRequest
537
+ include ::Google::Protobuf::MessageExts
538
+ extend ::Google::Protobuf::MessageExts::ClassMethods
539
+ end
540
+
541
+ # Request message for ListApiDeploymentRevisions.
542
+ # @!attribute [rw] name
543
+ # @return [::String]
544
+ # Required. The name of the deployment to list revisions for.
545
+ # @!attribute [rw] page_size
546
+ # @return [::Integer]
547
+ # The maximum number of revisions to return per page.
548
+ # @!attribute [rw] page_token
549
+ # @return [::String]
550
+ # The page token, received from a previous ListApiDeploymentRevisions call.
551
+ # Provide this to retrieve the subsequent page.
552
+ class ListApiDeploymentRevisionsRequest
553
+ include ::Google::Protobuf::MessageExts
554
+ extend ::Google::Protobuf::MessageExts::ClassMethods
555
+ end
556
+
557
+ # Response message for ListApiDeploymentRevisionsResponse.
558
+ # @!attribute [rw] api_deployments
559
+ # @return [::Array<::Google::Cloud::ApigeeRegistry::V1::ApiDeployment>]
560
+ # The revisions of the deployment.
561
+ # @!attribute [rw] next_page_token
562
+ # @return [::String]
563
+ # A token that can be sent as `page_token` to retrieve the next page.
564
+ # If this field is omitted, there are no subsequent pages.
565
+ class ListApiDeploymentRevisionsResponse
566
+ include ::Google::Protobuf::MessageExts
567
+ extend ::Google::Protobuf::MessageExts::ClassMethods
568
+ end
569
+
570
+ # Request message for RollbackApiDeployment.
571
+ # @!attribute [rw] name
572
+ # @return [::String]
573
+ # Required. The deployment being rolled back.
574
+ # @!attribute [rw] revision_id
575
+ # @return [::String]
576
+ # Required. The revision ID to roll back to.
577
+ # It must be a revision of the same deployment.
578
+ #
579
+ # Example: c7cfa2a8
580
+ class RollbackApiDeploymentRequest
581
+ include ::Google::Protobuf::MessageExts
582
+ extend ::Google::Protobuf::MessageExts::ClassMethods
583
+ end
584
+
585
+ # Request message for DeleteApiDeploymentRevision.
586
+ # @!attribute [rw] name
587
+ # @return [::String]
588
+ # Required. The name of the deployment revision to be deleted,
589
+ # with a revision ID explicitly included.
590
+ #
591
+ # Example:
592
+ # projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8
593
+ class DeleteApiDeploymentRevisionRequest
594
+ include ::Google::Protobuf::MessageExts
595
+ extend ::Google::Protobuf::MessageExts::ClassMethods
596
+ end
597
+
598
+ # Request message for ListArtifacts.
599
+ # @!attribute [rw] parent
600
+ # @return [::String]
601
+ # Required. The parent, which owns this collection of artifacts.
602
+ # Format: \\{parent}
603
+ # @!attribute [rw] page_size
604
+ # @return [::Integer]
605
+ # The maximum number of artifacts to return.
606
+ # The service may return fewer than this value.
607
+ # If unspecified, at most 50 values will be returned.
608
+ # The maximum is 1000; values above 1000 will be coerced to 1000.
609
+ # @!attribute [rw] page_token
610
+ # @return [::String]
611
+ # A page token, received from a previous `ListArtifacts` call.
612
+ # Provide this to retrieve the subsequent page.
613
+ #
614
+ # When paginating, all other parameters provided to `ListArtifacts` must
615
+ # match the call that provided the page token.
616
+ # @!attribute [rw] filter
617
+ # @return [::String]
618
+ # An expression that can be used to filter the list. Filters use the Common
619
+ # Expression Language and can refer to all message fields except contents.
620
+ class ListArtifactsRequest
621
+ include ::Google::Protobuf::MessageExts
622
+ extend ::Google::Protobuf::MessageExts::ClassMethods
623
+ end
624
+
625
+ # Response message for ListArtifacts.
626
+ # @!attribute [rw] artifacts
627
+ # @return [::Array<::Google::Cloud::ApigeeRegistry::V1::Artifact>]
628
+ # The artifacts from the specified publisher.
629
+ # @!attribute [rw] next_page_token
630
+ # @return [::String]
631
+ # A token, which can be sent as `page_token` to retrieve the next page.
632
+ # If this field is omitted, there are no subsequent pages.
633
+ class ListArtifactsResponse
634
+ include ::Google::Protobuf::MessageExts
635
+ extend ::Google::Protobuf::MessageExts::ClassMethods
636
+ end
637
+
638
+ # Request message for GetArtifact.
639
+ # @!attribute [rw] name
640
+ # @return [::String]
641
+ # Required. The name of the artifact to retrieve.
642
+ # Format: \\{parent}/artifacts/*
643
+ class GetArtifactRequest
644
+ include ::Google::Protobuf::MessageExts
645
+ extend ::Google::Protobuf::MessageExts::ClassMethods
646
+ end
647
+
648
+ # Request message for GetArtifactContents.
649
+ # @!attribute [rw] name
650
+ # @return [::String]
651
+ # Required. The name of the artifact whose contents should be retrieved.
652
+ # Format: \\{parent}/artifacts/*
653
+ class GetArtifactContentsRequest
654
+ include ::Google::Protobuf::MessageExts
655
+ extend ::Google::Protobuf::MessageExts::ClassMethods
656
+ end
657
+
658
+ # Request message for CreateArtifact.
659
+ # @!attribute [rw] parent
660
+ # @return [::String]
661
+ # Required. The parent, which owns this collection of artifacts.
662
+ # Format: \\{parent}
663
+ # @!attribute [rw] artifact
664
+ # @return [::Google::Cloud::ApigeeRegistry::V1::Artifact]
665
+ # Required. The artifact to create.
666
+ # @!attribute [rw] artifact_id
667
+ # @return [::String]
668
+ # Required. The ID to use for the artifact, which will become the final component of
669
+ # the artifact's resource name.
670
+ #
671
+ # This value should be 4-63 characters, and valid characters
672
+ # are /[a-z][0-9]-/.
673
+ #
674
+ # Following AIP-162, IDs must not have the form of a UUID.
675
+ class CreateArtifactRequest
676
+ include ::Google::Protobuf::MessageExts
677
+ extend ::Google::Protobuf::MessageExts::ClassMethods
678
+ end
679
+
680
+ # Request message for ReplaceArtifact.
681
+ # @!attribute [rw] artifact
682
+ # @return [::Google::Cloud::ApigeeRegistry::V1::Artifact]
683
+ # Required. The artifact to replace.
684
+ #
685
+ # The `name` field is used to identify the artifact to replace.
686
+ # Format: \\{parent}/artifacts/*
687
+ class ReplaceArtifactRequest
688
+ include ::Google::Protobuf::MessageExts
689
+ extend ::Google::Protobuf::MessageExts::ClassMethods
690
+ end
691
+
692
+ # Request message for DeleteArtifact.
693
+ # @!attribute [rw] name
694
+ # @return [::String]
695
+ # Required. The name of the artifact to delete.
696
+ # Format: \\{parent}/artifacts/*
697
+ class DeleteArtifactRequest
698
+ include ::Google::Protobuf::MessageExts
699
+ extend ::Google::Protobuf::MessageExts::ClassMethods
700
+ end
701
+ end
702
+ end
703
+ end
704
+ end