google-cloud-build-v2 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +151 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +144 -0
  6. data/lib/google/cloud/build/v2/repository_manager/client.rb +1713 -0
  7. data/lib/google/cloud/build/v2/repository_manager/credentials.rb +51 -0
  8. data/lib/google/cloud/build/v2/repository_manager/operations.rb +768 -0
  9. data/lib/google/cloud/build/v2/repository_manager/paths.rb +130 -0
  10. data/lib/google/cloud/build/v2/repository_manager.rb +50 -0
  11. data/lib/google/cloud/build/v2/version.rb +28 -0
  12. data/lib/google/cloud/build/v2.rb +40 -0
  13. data/lib/google/devtools/cloudbuild/v2/cloudbuild_pb.rb +44 -0
  14. data/lib/google/devtools/cloudbuild/v2/repositories_pb.rb +193 -0
  15. data/lib/google/devtools/cloudbuild/v2/repositories_services_pb.rb +70 -0
  16. data/lib/google-cloud-build-v2.rb +21 -0
  17. data/proto_docs/README.md +4 -0
  18. data/proto_docs/google/api/client.rb +318 -0
  19. data/proto_docs/google/api/field_behavior.rb +71 -0
  20. data/proto_docs/google/api/httpbody.rb +80 -0
  21. data/proto_docs/google/api/launch_stage.rb +71 -0
  22. data/proto_docs/google/api/resource.rb +222 -0
  23. data/proto_docs/google/devtools/cloudbuild/v2/cloudbuild.rb +88 -0
  24. data/proto_docs/google/devtools/cloudbuild/v2/repositories.rb +511 -0
  25. data/proto_docs/google/longrunning/operations.rb +164 -0
  26. data/proto_docs/google/protobuf/any.rb +141 -0
  27. data/proto_docs/google/protobuf/duration.rb +98 -0
  28. data/proto_docs/google/protobuf/empty.rb +34 -0
  29. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  30. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  31. data/proto_docs/google/rpc/status.rb +48 -0
  32. data/proto_docs/google/type/expr.rb +75 -0
  33. metadata +264 -0
@@ -0,0 +1,511 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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 Build
23
+ module V2
24
+ # A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Server or
25
+ # GitLab.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Immutable. The resource name of the connection, in the format
29
+ # `projects/{project}/locations/{location}/connections/{connection_id}`.
30
+ # @!attribute [r] create_time
31
+ # @return [::Google::Protobuf::Timestamp]
32
+ # Output only. Server assigned timestamp for when the connection was created.
33
+ # @!attribute [r] update_time
34
+ # @return [::Google::Protobuf::Timestamp]
35
+ # Output only. Server assigned timestamp for when the connection was updated.
36
+ # @!attribute [rw] github_config
37
+ # @return [::Google::Cloud::Build::V2::GitHubConfig]
38
+ # Configuration for connections to github.com.
39
+ # @!attribute [rw] github_enterprise_config
40
+ # @return [::Google::Cloud::Build::V2::GitHubEnterpriseConfig]
41
+ # Configuration for connections to an instance of GitHub Enterprise.
42
+ # @!attribute [r] installation_state
43
+ # @return [::Google::Cloud::Build::V2::InstallationState]
44
+ # Output only. Installation state of the Connection.
45
+ # @!attribute [rw] disabled
46
+ # @return [::Boolean]
47
+ # If disabled is set to true, functionality is disabled for this connection.
48
+ # Repository based API methods and webhooks processing for repositories in
49
+ # this connection will be disabled.
50
+ # @!attribute [r] reconciling
51
+ # @return [::Boolean]
52
+ # Output only. Set to true when the connection is being set up or updated in
53
+ # the background.
54
+ # @!attribute [rw] annotations
55
+ # @return [::Google::Protobuf::Map{::String => ::String}]
56
+ # Allows clients to store small amounts of arbitrary data.
57
+ # @!attribute [rw] etag
58
+ # @return [::String]
59
+ # This checksum is computed by the server based on the value of other
60
+ # fields, and may be sent on update and delete requests to ensure the
61
+ # client has an up-to-date value before proceeding.
62
+ class Connection
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+
66
+ # @!attribute [rw] key
67
+ # @return [::String]
68
+ # @!attribute [rw] value
69
+ # @return [::String]
70
+ class AnnotationsEntry
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+ end
75
+
76
+ # Describes stage and necessary actions to be taken by the
77
+ # user to complete the installation. Used for GitHub and GitHub Enterprise
78
+ # based connections.
79
+ # @!attribute [r] stage
80
+ # @return [::Google::Cloud::Build::V2::InstallationState::Stage]
81
+ # Output only. Current step of the installation process.
82
+ # @!attribute [r] message
83
+ # @return [::String]
84
+ # Output only. Message of what the user should do next to continue the
85
+ # installation. Empty string if the installation is already complete.
86
+ # @!attribute [r] action_uri
87
+ # @return [::String]
88
+ # Output only. Link to follow for next action. Empty string if the
89
+ # installation is already complete.
90
+ class InstallationState
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
+
94
+ # Stage of the installation process.
95
+ module Stage
96
+ # No stage specified.
97
+ STAGE_UNSPECIFIED = 0
98
+
99
+ # Only for GitHub Enterprise. An App creation has been requested.
100
+ # The user needs to confirm the creation in their GitHub enterprise host.
101
+ PENDING_CREATE_APP = 1
102
+
103
+ # User needs to authorize the GitHub (or Enterprise) App via OAuth.
104
+ PENDING_USER_OAUTH = 2
105
+
106
+ # User needs to follow the link to install the GitHub (or Enterprise) App.
107
+ PENDING_INSTALL_APP = 3
108
+
109
+ # Installation process has been completed.
110
+ COMPLETE = 10
111
+ end
112
+ end
113
+
114
+ # Request message for FetchLinkableRepositories.
115
+ # @!attribute [rw] connection
116
+ # @return [::String]
117
+ # Required. The name of the Connection.
118
+ # Format: `projects/*/locations/*/connections/*`.
119
+ # @!attribute [rw] page_size
120
+ # @return [::Integer]
121
+ # Number of results to return in the list. Default to 20.
122
+ # @!attribute [rw] page_token
123
+ # @return [::String]
124
+ # Page start.
125
+ class FetchLinkableRepositoriesRequest
126
+ include ::Google::Protobuf::MessageExts
127
+ extend ::Google::Protobuf::MessageExts::ClassMethods
128
+ end
129
+
130
+ # Response message for FetchLinkableRepositories.
131
+ # @!attribute [rw] repositories
132
+ # @return [::Array<::Google::Cloud::Build::V2::Repository>]
133
+ # repositories ready to be created.
134
+ # @!attribute [rw] next_page_token
135
+ # @return [::String]
136
+ # A token identifying a page of results the server should return.
137
+ class FetchLinkableRepositoriesResponse
138
+ include ::Google::Protobuf::MessageExts
139
+ extend ::Google::Protobuf::MessageExts::ClassMethods
140
+ end
141
+
142
+ # Configuration for connections to github.com.
143
+ # @!attribute [rw] authorizer_credential
144
+ # @return [::Google::Cloud::Build::V2::OAuthCredential]
145
+ # OAuth credential of the account that authorized the Cloud Build GitHub App.
146
+ # It is recommended to use a robot account instead of a human user account.
147
+ # The OAuth token must be tied to the Cloud Build GitHub App.
148
+ # @!attribute [rw] app_installation_id
149
+ # @return [::Integer]
150
+ # GitHub App installation id.
151
+ class GitHubConfig
152
+ include ::Google::Protobuf::MessageExts
153
+ extend ::Google::Protobuf::MessageExts::ClassMethods
154
+ end
155
+
156
+ # Configuration for connections to an instance of GitHub Enterprise.
157
+ # @!attribute [rw] host_uri
158
+ # @return [::String]
159
+ # Required. The URI of the GitHub Enterprise host this connection is for.
160
+ # @!attribute [rw] api_key
161
+ # @return [::String]
162
+ # Required. API Key used for authentication of webhook events.
163
+ # @!attribute [rw] app_id
164
+ # @return [::Integer]
165
+ # Id of the GitHub App created from the manifest.
166
+ # @!attribute [rw] app_slug
167
+ # @return [::String]
168
+ # The URL-friendly name of the GitHub App.
169
+ # @!attribute [rw] private_key_secret_version
170
+ # @return [::String]
171
+ # SecretManager resource containing the private key of the GitHub App,
172
+ # formatted as `projects/*/secrets/*/versions/*`.
173
+ # @!attribute [rw] webhook_secret_secret_version
174
+ # @return [::String]
175
+ # SecretManager resource containing the webhook secret of the GitHub App,
176
+ # formatted as `projects/*/secrets/*/versions/*`.
177
+ # @!attribute [rw] app_installation_id
178
+ # @return [::Integer]
179
+ # ID of the installation of the GitHub App.
180
+ # @!attribute [rw] service_directory_config
181
+ # @return [::Google::Cloud::Build::V2::ServiceDirectoryConfig]
182
+ # Configuration for using Service Directory to privately connect to a GitHub
183
+ # Enterprise server. This should only be set if the GitHub Enterprise server
184
+ # is hosted on-premises and not reachable by public internet. If this field
185
+ # is left empty, calls to the GitHub Enterprise server will be made over the
186
+ # public internet.
187
+ # @!attribute [rw] ssl_ca
188
+ # @return [::String]
189
+ # SSL certificate to use for requests to GitHub Enterprise.
190
+ # @!attribute [r] server_version
191
+ # @return [::String]
192
+ # Output only. GitHub Enterprise version installed at the host_uri.
193
+ class GitHubEnterpriseConfig
194
+ include ::Google::Protobuf::MessageExts
195
+ extend ::Google::Protobuf::MessageExts::ClassMethods
196
+ end
197
+
198
+ # ServiceDirectoryConfig represents Service Directory configuration for a
199
+ # connection.
200
+ # @!attribute [rw] service
201
+ # @return [::String]
202
+ # Required. The Service Directory service name.
203
+ # Format:
204
+ # projects/\\{project}/locations/\\{location}/namespaces/\\{namespace}/services/\\{service}.
205
+ class ServiceDirectoryConfig
206
+ include ::Google::Protobuf::MessageExts
207
+ extend ::Google::Protobuf::MessageExts::ClassMethods
208
+ end
209
+
210
+ # A repository associated to a parent connection.
211
+ # @!attribute [rw] name
212
+ # @return [::String]
213
+ # Immutable. Resource name of the repository, in the format
214
+ # `projects/*/locations/*/connections/*/repositories/*`.
215
+ # @!attribute [rw] remote_uri
216
+ # @return [::String]
217
+ # Required. Git Clone HTTPS URI.
218
+ # @!attribute [r] create_time
219
+ # @return [::Google::Protobuf::Timestamp]
220
+ # Output only. Server assigned timestamp for when the connection was created.
221
+ # @!attribute [r] update_time
222
+ # @return [::Google::Protobuf::Timestamp]
223
+ # Output only. Server assigned timestamp for when the connection was updated.
224
+ # @!attribute [rw] annotations
225
+ # @return [::Google::Protobuf::Map{::String => ::String}]
226
+ # Allows clients to store small amounts of arbitrary data.
227
+ # @!attribute [rw] etag
228
+ # @return [::String]
229
+ # This checksum is computed by the server based on the value of other
230
+ # fields, and may be sent on update and delete requests to ensure the
231
+ # client has an up-to-date value before proceeding.
232
+ class Repository
233
+ include ::Google::Protobuf::MessageExts
234
+ extend ::Google::Protobuf::MessageExts::ClassMethods
235
+
236
+ # @!attribute [rw] key
237
+ # @return [::String]
238
+ # @!attribute [rw] value
239
+ # @return [::String]
240
+ class AnnotationsEntry
241
+ include ::Google::Protobuf::MessageExts
242
+ extend ::Google::Protobuf::MessageExts::ClassMethods
243
+ end
244
+ end
245
+
246
+ # Represents an OAuth token of the account that authorized the Connection,
247
+ # and associated metadata.
248
+ # @!attribute [rw] oauth_token_secret_version
249
+ # @return [::String]
250
+ # A SecretManager resource containing the OAuth token that authorizes
251
+ # the Cloud Build connection. Format: `projects/*/secrets/*/versions/*`.
252
+ # @!attribute [r] username
253
+ # @return [::String]
254
+ # Output only. The username associated to this token.
255
+ class OAuthCredential
256
+ include ::Google::Protobuf::MessageExts
257
+ extend ::Google::Protobuf::MessageExts::ClassMethods
258
+ end
259
+
260
+ # Message for creating a Connection
261
+ # @!attribute [rw] parent
262
+ # @return [::String]
263
+ # Required. Project and location where the connection will be created.
264
+ # Format: `projects/*/locations/*`.
265
+ # @!attribute [rw] connection
266
+ # @return [::Google::Cloud::Build::V2::Connection]
267
+ # Required. The Connection to create.
268
+ # @!attribute [rw] connection_id
269
+ # @return [::String]
270
+ # Required. The ID to use for the Connection, which will become the final
271
+ # component of the Connection's resource name. Names must be unique
272
+ # per-project per-location. Allows alphanumeric characters and any of
273
+ # -._~%!$&'()*+,;=@.
274
+ class CreateConnectionRequest
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
+ end
278
+
279
+ # Message for getting the details of a Connection.
280
+ # @!attribute [rw] name
281
+ # @return [::String]
282
+ # Required. The name of the Connection to retrieve.
283
+ # Format: `projects/*/locations/*/connections/*`.
284
+ class GetConnectionRequest
285
+ include ::Google::Protobuf::MessageExts
286
+ extend ::Google::Protobuf::MessageExts::ClassMethods
287
+ end
288
+
289
+ # Message for requesting list of Connections.
290
+ # @!attribute [rw] parent
291
+ # @return [::String]
292
+ # Required. The parent, which owns this collection of Connections.
293
+ # Format: `projects/*/locations/*`.
294
+ # @!attribute [rw] page_size
295
+ # @return [::Integer]
296
+ # Number of results to return in the list.
297
+ # @!attribute [rw] page_token
298
+ # @return [::String]
299
+ # Page start.
300
+ class ListConnectionsRequest
301
+ include ::Google::Protobuf::MessageExts
302
+ extend ::Google::Protobuf::MessageExts::ClassMethods
303
+ end
304
+
305
+ # Message for response to listing Connections.
306
+ # @!attribute [rw] connections
307
+ # @return [::Array<::Google::Cloud::Build::V2::Connection>]
308
+ # The list of Connections.
309
+ # @!attribute [rw] next_page_token
310
+ # @return [::String]
311
+ # A token identifying a page of results the server should return.
312
+ class ListConnectionsResponse
313
+ include ::Google::Protobuf::MessageExts
314
+ extend ::Google::Protobuf::MessageExts::ClassMethods
315
+ end
316
+
317
+ # Message for updating a Connection.
318
+ # @!attribute [rw] connection
319
+ # @return [::Google::Cloud::Build::V2::Connection]
320
+ # Required. The Connection to update.
321
+ # @!attribute [rw] update_mask
322
+ # @return [::Google::Protobuf::FieldMask]
323
+ # The list of fields to be updated.
324
+ # @!attribute [rw] allow_missing
325
+ # @return [::Boolean]
326
+ # If set to true, and the connection is not found a new connection
327
+ # will be created. In this situation `update_mask` is ignored.
328
+ # The creation will succeed only if the input connection has all the
329
+ # necessary information (e.g a github_config with both user_oauth_token and
330
+ # installation_id properties).
331
+ # @!attribute [rw] etag
332
+ # @return [::String]
333
+ # The current etag of the connection.
334
+ # If an etag is provided and does not match the current etag of the
335
+ # connection, update will be blocked and an ABORTED error will be returned.
336
+ class UpdateConnectionRequest
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+ end
340
+
341
+ # Message for deleting a Connection.
342
+ # @!attribute [rw] name
343
+ # @return [::String]
344
+ # Required. The name of the Connection to delete.
345
+ # Format: `projects/*/locations/*/connections/*`.
346
+ # @!attribute [rw] etag
347
+ # @return [::String]
348
+ # The current etag of the connection.
349
+ # If an etag is provided and does not match the current etag of the
350
+ # connection, deletion will be blocked and an ABORTED error will be returned.
351
+ # @!attribute [rw] validate_only
352
+ # @return [::Boolean]
353
+ # If set, validate the request, but do not actually post it.
354
+ class DeleteConnectionRequest
355
+ include ::Google::Protobuf::MessageExts
356
+ extend ::Google::Protobuf::MessageExts::ClassMethods
357
+ end
358
+
359
+ # Message for creating a Repository.
360
+ # @!attribute [rw] parent
361
+ # @return [::String]
362
+ # Required. The connection to contain the repository. If the request is part
363
+ # of a BatchCreateRepositoriesRequest, this field should be empty or match
364
+ # the parent specified there.
365
+ # @!attribute [rw] repository
366
+ # @return [::Google::Cloud::Build::V2::Repository]
367
+ # Required. The repository to create.
368
+ # @!attribute [rw] repository_id
369
+ # @return [::String]
370
+ # Required. The ID to use for the repository, which will become the final
371
+ # component of the repository's resource name. This ID should be unique in
372
+ # the connection. Allows alphanumeric characters and any of
373
+ # -._~%!$&'()*+,;=@.
374
+ class CreateRepositoryRequest
375
+ include ::Google::Protobuf::MessageExts
376
+ extend ::Google::Protobuf::MessageExts::ClassMethods
377
+ end
378
+
379
+ # Message for creating repositoritories in batch.
380
+ # @!attribute [rw] parent
381
+ # @return [::String]
382
+ # Required. The connection to contain all the repositories being created.
383
+ # Format: projects/*/locations/*/connections/*
384
+ # The parent field in the CreateRepositoryRequest messages
385
+ # must either be empty or match this field.
386
+ # @!attribute [rw] requests
387
+ # @return [::Array<::Google::Cloud::Build::V2::CreateRepositoryRequest>]
388
+ # Required. The request messages specifying the repositories to create.
389
+ class BatchCreateRepositoriesRequest
390
+ include ::Google::Protobuf::MessageExts
391
+ extend ::Google::Protobuf::MessageExts::ClassMethods
392
+ end
393
+
394
+ # Message for response of creating repositories in batch.
395
+ # @!attribute [rw] repositories
396
+ # @return [::Array<::Google::Cloud::Build::V2::Repository>]
397
+ # Repository resources created.
398
+ class BatchCreateRepositoriesResponse
399
+ include ::Google::Protobuf::MessageExts
400
+ extend ::Google::Protobuf::MessageExts::ClassMethods
401
+ end
402
+
403
+ # Message for getting the details of a Repository.
404
+ # @!attribute [rw] name
405
+ # @return [::String]
406
+ # Required. The name of the Repository to retrieve.
407
+ # Format: `projects/*/locations/*/connections/*/repositories/*`.
408
+ class GetRepositoryRequest
409
+ include ::Google::Protobuf::MessageExts
410
+ extend ::Google::Protobuf::MessageExts::ClassMethods
411
+ end
412
+
413
+ # Message for requesting list of Repositories.
414
+ # @!attribute [rw] parent
415
+ # @return [::String]
416
+ # Required. The parent, which owns this collection of Repositories.
417
+ # Format: `projects/*/locations/*/connections/*`.
418
+ # @!attribute [rw] page_size
419
+ # @return [::Integer]
420
+ # Number of results to return in the list.
421
+ # @!attribute [rw] page_token
422
+ # @return [::String]
423
+ # Page start.
424
+ # @!attribute [rw] filter
425
+ # @return [::String]
426
+ # A filter expression that filters resources listed in the response.
427
+ # Expressions must follow API improvement proposal
428
+ # [AIP-160](https://google.aip.dev/160). e.g.
429
+ # `remote_uri:"https://github.com*"`.
430
+ class ListRepositoriesRequest
431
+ include ::Google::Protobuf::MessageExts
432
+ extend ::Google::Protobuf::MessageExts::ClassMethods
433
+ end
434
+
435
+ # Message for response to listing Repositories.
436
+ # @!attribute [rw] repositories
437
+ # @return [::Array<::Google::Cloud::Build::V2::Repository>]
438
+ # The list of Repositories.
439
+ # @!attribute [rw] next_page_token
440
+ # @return [::String]
441
+ # A token identifying a page of results the server should return.
442
+ class ListRepositoriesResponse
443
+ include ::Google::Protobuf::MessageExts
444
+ extend ::Google::Protobuf::MessageExts::ClassMethods
445
+ end
446
+
447
+ # Message for deleting a Repository.
448
+ # @!attribute [rw] name
449
+ # @return [::String]
450
+ # Required. The name of the Repository to delete.
451
+ # Format: `projects/*/locations/*/connections/*/repositories/*`.
452
+ # @!attribute [rw] etag
453
+ # @return [::String]
454
+ # The current etag of the repository.
455
+ # If an etag is provided and does not match the current etag of the
456
+ # repository, deletion will be blocked and an ABORTED error will be returned.
457
+ # @!attribute [rw] validate_only
458
+ # @return [::Boolean]
459
+ # If set, validate the request, but do not actually post it.
460
+ class DeleteRepositoryRequest
461
+ include ::Google::Protobuf::MessageExts
462
+ extend ::Google::Protobuf::MessageExts::ClassMethods
463
+ end
464
+
465
+ # Message for fetching SCM read/write token.
466
+ # @!attribute [rw] repository
467
+ # @return [::String]
468
+ # Required. The resource name of the repository in the format
469
+ # `projects/*/locations/*/connections/*/repositories/*`.
470
+ class FetchReadWriteTokenRequest
471
+ include ::Google::Protobuf::MessageExts
472
+ extend ::Google::Protobuf::MessageExts::ClassMethods
473
+ end
474
+
475
+ # Message for fetching SCM read token.
476
+ # @!attribute [rw] repository
477
+ # @return [::String]
478
+ # Required. The resource name of the repository in the format
479
+ # `projects/*/locations/*/connections/*/repositories/*`.
480
+ class FetchReadTokenRequest
481
+ include ::Google::Protobuf::MessageExts
482
+ extend ::Google::Protobuf::MessageExts::ClassMethods
483
+ end
484
+
485
+ # Message for responding to get read token.
486
+ # @!attribute [rw] token
487
+ # @return [::String]
488
+ # The token content.
489
+ # @!attribute [rw] expiration_time
490
+ # @return [::Google::Protobuf::Timestamp]
491
+ # Expiration timestamp. Can be empty if unknown or non-expiring.
492
+ class FetchReadTokenResponse
493
+ include ::Google::Protobuf::MessageExts
494
+ extend ::Google::Protobuf::MessageExts::ClassMethods
495
+ end
496
+
497
+ # Message for responding to get read/write token.
498
+ # @!attribute [rw] token
499
+ # @return [::String]
500
+ # The token content.
501
+ # @!attribute [rw] expiration_time
502
+ # @return [::Google::Protobuf::Timestamp]
503
+ # Expiration timestamp. Can be empty if unknown or non-expiring.
504
+ class FetchReadWriteTokenResponse
505
+ include ::Google::Protobuf::MessageExts
506
+ extend ::Google::Protobuf::MessageExts::ClassMethods
507
+ end
508
+ end
509
+ end
510
+ end
511
+ end
@@ -0,0 +1,164 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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 Longrunning
22
+ # This resource represents a long-running operation that is the result of a
23
+ # network API call.
24
+ # @!attribute [rw] name
25
+ # @return [::String]
26
+ # The server-assigned name, which is only unique within the same service that
27
+ # originally returns it. If you use the default HTTP mapping, the
28
+ # `name` should be a resource name ending with `operations/{unique_id}`.
29
+ # @!attribute [rw] metadata
30
+ # @return [::Google::Protobuf::Any]
31
+ # Service-specific metadata associated with the operation. It typically
32
+ # contains progress information and common metadata such as create time.
33
+ # Some services might not provide such metadata. Any method that returns a
34
+ # long-running operation should document the metadata type, if any.
35
+ # @!attribute [rw] done
36
+ # @return [::Boolean]
37
+ # If the value is `false`, it means the operation is still in progress.
38
+ # If `true`, the operation is completed, and either `error` or `response` is
39
+ # available.
40
+ # @!attribute [rw] error
41
+ # @return [::Google::Rpc::Status]
42
+ # The error result of the operation in case of failure or cancellation.
43
+ # @!attribute [rw] response
44
+ # @return [::Google::Protobuf::Any]
45
+ # The normal response of the operation in case of success. If the original
46
+ # method returns no data on success, such as `Delete`, the response is
47
+ # `google.protobuf.Empty`. If the original method is standard
48
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
49
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
50
+ # is the original method name. For example, if the original method name
51
+ # is `TakeSnapshot()`, the inferred response type is
52
+ # `TakeSnapshotResponse`.
53
+ class Operation
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
+ end
57
+
58
+ # The request message for Operations.GetOperation.
59
+ # @!attribute [rw] name
60
+ # @return [::String]
61
+ # The name of the operation resource.
62
+ class GetOperationRequest
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+
67
+ # The request message for Operations.ListOperations.
68
+ # @!attribute [rw] name
69
+ # @return [::String]
70
+ # The name of the operation's parent resource.
71
+ # @!attribute [rw] filter
72
+ # @return [::String]
73
+ # The standard list filter.
74
+ # @!attribute [rw] page_size
75
+ # @return [::Integer]
76
+ # The standard list page size.
77
+ # @!attribute [rw] page_token
78
+ # @return [::String]
79
+ # The standard list page token.
80
+ class ListOperationsRequest
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # The response message for Operations.ListOperations.
86
+ # @!attribute [rw] operations
87
+ # @return [::Array<::Google::Longrunning::Operation>]
88
+ # A list of operations that matches the specified filter in the request.
89
+ # @!attribute [rw] next_page_token
90
+ # @return [::String]
91
+ # The standard List next-page token.
92
+ class ListOperationsResponse
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+
97
+ # The request message for Operations.CancelOperation.
98
+ # @!attribute [rw] name
99
+ # @return [::String]
100
+ # The name of the operation resource to be cancelled.
101
+ class CancelOperationRequest
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+ end
105
+
106
+ # The request message for Operations.DeleteOperation.
107
+ # @!attribute [rw] name
108
+ # @return [::String]
109
+ # The name of the operation resource to be deleted.
110
+ class DeleteOperationRequest
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # The request message for Operations.WaitOperation.
116
+ # @!attribute [rw] name
117
+ # @return [::String]
118
+ # The name of the operation resource to wait on.
119
+ # @!attribute [rw] timeout
120
+ # @return [::Google::Protobuf::Duration]
121
+ # The maximum duration to wait before timing out. If left blank, the wait
122
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
123
+ # If RPC context deadline is also specified, the shorter one will be used.
124
+ class WaitOperationRequest
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+
129
+ # A message representing the message types used by a long-running operation.
130
+ #
131
+ # Example:
132
+ #
133
+ # rpc LongRunningRecognize(LongRunningRecognizeRequest)
134
+ # returns (google.longrunning.Operation) {
135
+ # option (google.longrunning.operation_info) = {
136
+ # response_type: "LongRunningRecognizeResponse"
137
+ # metadata_type: "LongRunningRecognizeMetadata"
138
+ # };
139
+ # }
140
+ # @!attribute [rw] response_type
141
+ # @return [::String]
142
+ # Required. The message name of the primary return type for this
143
+ # long-running operation.
144
+ # This type will be used to deserialize the LRO's response.
145
+ #
146
+ # If the response is in a different package from the rpc, a fully-qualified
147
+ # message name must be used (e.g. `google.protobuf.Struct`).
148
+ #
149
+ # Note: Altering this value constitutes a breaking change.
150
+ # @!attribute [rw] metadata_type
151
+ # @return [::String]
152
+ # Required. The message name of the metadata type for this long-running
153
+ # operation.
154
+ #
155
+ # If the response is in a different package from the rpc, a fully-qualified
156
+ # message name must be used (e.g. `google.protobuf.Struct`).
157
+ #
158
+ # Note: Altering this value constitutes a breaking change.
159
+ class OperationInfo
160
+ include ::Google::Protobuf::MessageExts
161
+ extend ::Google::Protobuf::MessageExts::ClassMethods
162
+ end
163
+ end
164
+ end