google-cloud-api_hub-v1 0.2.0 → 0.4.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 (23) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +37 -1
  3. data/lib/google/cloud/api_hub/v1/api_hub/rest/client.rb +43 -36
  4. data/lib/google/cloud/api_hub/v1/api_hub/rest/service_stub.rb +294 -212
  5. data/lib/google/cloud/api_hub/v1/api_hub_dependencies/rest/client.rb +36 -6
  6. data/lib/google/cloud/api_hub/v1/api_hub_dependencies/rest/service_stub.rb +54 -32
  7. data/lib/google/cloud/api_hub/v1/api_hub_plugin/rest/client.rb +35 -4
  8. data/lib/google/cloud/api_hub/v1/api_hub_plugin/rest/service_stub.rb +38 -20
  9. data/lib/google/cloud/api_hub/v1/host_project_registration_service/rest/client.rb +36 -4
  10. data/lib/google/cloud/api_hub/v1/host_project_registration_service/rest/service_stub.rb +38 -20
  11. data/lib/google/cloud/api_hub/v1/linting_service/rest/client.rb +35 -5
  12. data/lib/google/cloud/api_hub/v1/linting_service/rest/service_stub.rb +46 -26
  13. data/lib/google/cloud/api_hub/v1/provisioning/rest/client.rb +36 -4
  14. data/lib/google/cloud/api_hub/v1/provisioning/rest/operations.rb +50 -38
  15. data/lib/google/cloud/api_hub/v1/provisioning/rest/service_stub.rb +38 -20
  16. data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb +36 -6
  17. data/lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/service_stub.rb +54 -32
  18. data/lib/google/cloud/api_hub/v1/version.rb +1 -1
  19. data/proto_docs/google/api/client.rb +39 -0
  20. data/proto_docs/google/cloud/apihub/v1/apihub_service.rb +12 -0
  21. data/proto_docs/google/cloud/apihub/v1/common_fields.rb +10 -0
  22. data/proto_docs/google/longrunning/operations.rb +23 -14
  23. metadata +6 -9
@@ -30,7 +30,8 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
34
35
  # These require statements are intentionally placed here to initialize
35
36
  # the REST modules only when it's required.
36
37
  require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
40
41
  universe_domain: universe_domain,
41
42
  credentials: credentials,
42
43
  numeric_enums: true,
43
- raise_faraday_errors: false
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
44
47
  end
45
48
 
46
49
  ##
@@ -61,6 +64,15 @@ module Google
61
64
  @client_stub.endpoint
62
65
  end
63
66
 
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
64
76
  ##
65
77
  # Baseline implementation for the create_api_hub_instance REST call
66
78
  #
@@ -87,16 +99,18 @@ module Google
87
99
 
88
100
  response = @client_stub.make_http_request(
89
101
  verb,
90
- uri: uri,
91
- body: body || "",
92
- params: query_string_params,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "create_api_hub_instance",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
97
-
98
- yield result, operation if block_given?
99
- result
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
100
114
  end
101
115
 
102
116
  ##
@@ -125,16 +139,18 @@ module Google
125
139
 
126
140
  response = @client_stub.make_http_request(
127
141
  verb,
128
- uri: uri,
129
- body: body || "",
130
- params: query_string_params,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "get_api_hub_instance",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::ApiHub::V1::ApiHubInstance.decode_json response.body, ignore_unknown_fields: true
135
-
136
- yield result, operation if block_given?
137
- result
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
138
154
  end
139
155
 
140
156
  ##
@@ -163,16 +179,18 @@ module Google
163
179
 
164
180
  response = @client_stub.make_http_request(
165
181
  verb,
166
- uri: uri,
167
- body: body || "",
168
- params: query_string_params,
182
+ uri: uri,
183
+ body: body || "",
184
+ params: query_string_params,
185
+ method_name: "lookup_api_hub_instance",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::ApiHub::V1::LookupApiHubInstanceResponse.decode_json response.body, ignore_unknown_fields: true
173
-
174
- yield result, operation if block_given?
175
- result
190
+ catch :response do
191
+ yield result, operation if block_given?
192
+ result
193
+ end
176
194
  end
177
195
 
178
196
  ##
@@ -170,15 +170,27 @@ module Google
170
170
  endpoint: @config.endpoint,
171
171
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
172
172
  universe_domain: @config.universe_domain,
173
- credentials: credentials
173
+ credentials: credentials,
174
+ logger: @config.logger
174
175
  )
175
176
 
177
+ @runtime_project_attachment_service_stub.logger(stub: true)&.info do |entry|
178
+ entry.set_system_name
179
+ entry.set_service
180
+ entry.message = "Created client for #{entry.service}"
181
+ entry.set_credentials_fields credentials
182
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
183
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
184
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
185
+ end
186
+
176
187
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
177
188
  config.credentials = credentials
178
189
  config.quota_project = @quota_project_id
179
190
  config.endpoint = @runtime_project_attachment_service_stub.endpoint
180
191
  config.universe_domain = @runtime_project_attachment_service_stub.universe_domain
181
192
  config.bindings_override = @config.bindings_override
193
+ config.logger = @runtime_project_attachment_service_stub.logger if config.respond_to? :logger=
182
194
  end
183
195
  end
184
196
 
@@ -189,6 +201,15 @@ module Google
189
201
  #
190
202
  attr_reader :location_client
191
203
 
204
+ ##
205
+ # The logger used for request/response debug logging.
206
+ #
207
+ # @return [Logger]
208
+ #
209
+ def logger
210
+ @runtime_project_attachment_service_stub.logger
211
+ end
212
+
192
213
  # Service calls
193
214
 
194
215
  ##
@@ -272,7 +293,6 @@ module Google
272
293
 
273
294
  @runtime_project_attachment_service_stub.create_runtime_project_attachment request, options do |result, operation|
274
295
  yield result, operation if block_given?
275
- return result
276
296
  end
277
297
  rescue ::Gapic::Rest::Error => e
278
298
  raise ::Google::Cloud::Error.from_error(e)
@@ -353,7 +373,6 @@ module Google
353
373
 
354
374
  @runtime_project_attachment_service_stub.get_runtime_project_attachment request, options do |result, operation|
355
375
  yield result, operation if block_given?
356
- return result
357
376
  end
358
377
  rescue ::Gapic::Rest::Error => e
359
378
  raise ::Google::Cloud::Error.from_error(e)
@@ -470,7 +489,7 @@ module Google
470
489
  @runtime_project_attachment_service_stub.list_runtime_project_attachments request, options do |result, operation|
471
490
  result = ::Gapic::Rest::PagedEnumerable.new @runtime_project_attachment_service_stub, :list_runtime_project_attachments, "runtime_project_attachments", request, result, options
472
491
  yield result, operation if block_given?
473
- return result
492
+ throw :response, result
474
493
  end
475
494
  rescue ::Gapic::Rest::Error => e
476
495
  raise ::Google::Cloud::Error.from_error(e)
@@ -552,7 +571,6 @@ module Google
552
571
 
553
572
  @runtime_project_attachment_service_stub.delete_runtime_project_attachment request, options do |result, operation|
554
573
  yield result, operation if block_given?
555
- return result
556
574
  end
557
575
  rescue ::Gapic::Rest::Error => e
558
576
  raise ::Google::Cloud::Error.from_error(e)
@@ -634,7 +652,6 @@ module Google
634
652
 
635
653
  @runtime_project_attachment_service_stub.lookup_runtime_project_attachment request, options do |result, operation|
636
654
  yield result, operation if block_given?
637
- return result
638
655
  end
639
656
  rescue ::Gapic::Rest::Error => e
640
657
  raise ::Google::Cloud::Error.from_error(e)
@@ -682,6 +699,13 @@ module Google
682
699
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
683
700
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
684
701
  # * (`nil`) indicating no credentials
702
+ #
703
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
704
+ # external source for authentication to Google Cloud, you must validate it before
705
+ # providing it to a Google API client library. Providing an unvalidated credential
706
+ # configuration to Google APIs can compromise the security of your systems and data.
707
+ # For more information, refer to [Validate credential configurations from external
708
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
685
709
  # @return [::Object]
686
710
  # @!attribute [rw] scope
687
711
  # The OAuth scopes
@@ -714,6 +738,11 @@ module Google
714
738
  # default endpoint URL. The default value of nil uses the environment
715
739
  # universe (usually the default "googleapis.com" universe).
716
740
  # @return [::String,nil]
741
+ # @!attribute [rw] logger
742
+ # A custom logger to use for request/response debug logging, or the value
743
+ # `:default` (the default) to construct a default logger, or `nil` to
744
+ # explicitly disable logging.
745
+ # @return [::Logger,:default,nil]
717
746
  #
718
747
  class Configuration
719
748
  extend ::Gapic::Config
@@ -742,6 +771,7 @@ module Google
742
771
  # by the host service.
743
772
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
744
773
  config_attr :bindings_override, {}, ::Hash, nil
774
+ config_attr :logger, :default, ::Logger, nil, :default
745
775
 
746
776
  # @private
747
777
  def initialize parent_config = nil
@@ -30,7 +30,8 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
34
35
  # These require statements are intentionally placed here to initialize
35
36
  # the REST modules only when it's required.
36
37
  require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
40
41
  universe_domain: universe_domain,
41
42
  credentials: credentials,
42
43
  numeric_enums: true,
43
- raise_faraday_errors: false
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
44
47
  end
45
48
 
46
49
  ##
@@ -61,6 +64,15 @@ module Google
61
64
  @client_stub.endpoint
62
65
  end
63
66
 
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
64
76
  ##
65
77
  # Baseline implementation for the create_runtime_project_attachment REST call
66
78
  #
@@ -87,16 +99,18 @@ module Google
87
99
 
88
100
  response = @client_stub.make_http_request(
89
101
  verb,
90
- uri: uri,
91
- body: body || "",
92
- params: query_string_params,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "create_runtime_project_attachment",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment.decode_json response.body, ignore_unknown_fields: true
97
-
98
- yield result, operation if block_given?
99
- result
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
100
114
  end
101
115
 
102
116
  ##
@@ -125,16 +139,18 @@ module Google
125
139
 
126
140
  response = @client_stub.make_http_request(
127
141
  verb,
128
- uri: uri,
129
- body: body || "",
130
- params: query_string_params,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "get_runtime_project_attachment",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment.decode_json response.body, ignore_unknown_fields: true
135
-
136
- yield result, operation if block_given?
137
- result
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
138
154
  end
139
155
 
140
156
  ##
@@ -163,16 +179,18 @@ module Google
163
179
 
164
180
  response = @client_stub.make_http_request(
165
181
  verb,
166
- uri: uri,
167
- body: body || "",
168
- params: query_string_params,
182
+ uri: uri,
183
+ body: body || "",
184
+ params: query_string_params,
185
+ method_name: "list_runtime_project_attachments",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::ApiHub::V1::ListRuntimeProjectAttachmentsResponse.decode_json response.body, ignore_unknown_fields: true
173
-
174
- yield result, operation if block_given?
175
- result
190
+ catch :response do
191
+ yield result, operation if block_given?
192
+ result
193
+ end
176
194
  end
177
195
 
178
196
  ##
@@ -201,16 +219,18 @@ module Google
201
219
 
202
220
  response = @client_stub.make_http_request(
203
221
  verb,
204
- uri: uri,
205
- body: body || "",
206
- params: query_string_params,
222
+ uri: uri,
223
+ body: body || "",
224
+ params: query_string_params,
225
+ method_name: "delete_runtime_project_attachment",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
211
-
212
- yield result, operation if block_given?
213
- result
230
+ catch :response do
231
+ yield result, operation if block_given?
232
+ result
233
+ end
214
234
  end
215
235
 
216
236
  ##
@@ -239,16 +259,18 @@ module Google
239
259
 
240
260
  response = @client_stub.make_http_request(
241
261
  verb,
242
- uri: uri,
243
- body: body || "",
244
- params: query_string_params,
262
+ uri: uri,
263
+ body: body || "",
264
+ params: query_string_params,
265
+ method_name: "lookup_runtime_project_attachment",
245
266
  options: options
246
267
  )
247
268
  operation = ::Gapic::Rest::TransportOperation.new response
248
269
  result = ::Google::Cloud::ApiHub::V1::LookupRuntimeProjectAttachmentResponse.decode_json response.body, ignore_unknown_fields: true
249
-
250
- yield result, operation if block_given?
251
- result
270
+ catch :response do
271
+ yield result, operation if block_given?
272
+ result
273
+ end
252
274
  end
253
275
 
254
276
  ##
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ApiHub
23
23
  module V1
24
- VERSION = "0.2.0"
24
+ VERSION = "0.4.0"
25
25
  end
26
26
  end
27
27
  end
@@ -28,6 +28,9 @@ module Google
28
28
  # @!attribute [rw] destinations
29
29
  # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
30
  # The destination where API teams want this client library to be published.
31
+ # @!attribute [rw] selective_gapic_generation
32
+ # @return [::Google::Api::SelectiveGapicGeneration]
33
+ # Configuration for which RPCs should be generated in the GAPIC client.
31
34
  class CommonLanguageSettings
32
35
  include ::Google::Protobuf::MessageExts
33
36
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
212
215
  # enabled. By default, asynchronous REST clients will not be generated.
213
216
  # This feature will be enabled by default 1 month after launching the
214
217
  # feature in preview packages.
218
+ # @!attribute [rw] protobuf_pythonic_types_enabled
219
+ # @return [::Boolean]
220
+ # Enables generation of protobuf code using new types that are more
221
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
+ # enabled by default 1 month after launching the feature in preview
223
+ # packages.
215
224
  class ExperimentalFeatures
216
225
  include ::Google::Protobuf::MessageExts
217
226
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,9 +306,28 @@ module Google
297
306
  # @!attribute [rw] common
298
307
  # @return [::Google::Api::CommonLanguageSettings]
299
308
  # Some settings.
309
+ # @!attribute [rw] renamed_services
310
+ # @return [::Google::Protobuf::Map{::String => ::String}]
311
+ # Map of service names to renamed services. Keys are the package relative
312
+ # service names and values are the name to be used for the service client
313
+ # and call options.
314
+ #
315
+ # publishing:
316
+ # go_settings:
317
+ # renamed_services:
318
+ # Publisher: TopicAdmin
300
319
  class GoSettings
301
320
  include ::Google::Protobuf::MessageExts
302
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
+
323
+ # @!attribute [rw] key
324
+ # @return [::String]
325
+ # @!attribute [rw] value
326
+ # @return [::String]
327
+ class RenamedServicesEntry
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
303
331
  end
304
332
 
305
333
  # Describes the generator configuration for a method.
@@ -375,6 +403,17 @@ module Google
375
403
  end
376
404
  end
377
405
 
406
+ # This message is used to configure the generation of a subset of the RPCs in
407
+ # a service for client libraries.
408
+ # @!attribute [rw] methods
409
+ # @return [::Array<::String>]
410
+ # An allowlist of the fully qualified names of RPCs that should be included
411
+ # on public client surfaces.
412
+ class SelectiveGapicGeneration
413
+ include ::Google::Protobuf::MessageExts
414
+ extend ::Google::Protobuf::MessageExts::ClassMethods
415
+ end
416
+
378
417
  # The organization for which the client libraries are being published.
379
418
  # Affects the url where generated docs are published, etc.
380
419
  module ClientLibraryOrganization
@@ -1010,26 +1010,38 @@ module Google
1010
1010
  # @return [::Google::Cloud::ApiHub::V1::Api]
1011
1011
  # This represents Api resource in search results. Only name, display_name,
1012
1012
  # description and owner fields are populated in search results.
1013
+ #
1014
+ # Note: The following fields are mutually exclusive: `api`, `operation`, `deployment`, `spec`, `definition`, `version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1013
1015
  # @!attribute [rw] operation
1014
1016
  # @return [::Google::Cloud::ApiHub::V1::ApiOperation]
1015
1017
  # This represents ApiOperation resource in search results. Only name,
1016
1018
  # and description fields are populated in search results.
1019
+ #
1020
+ # Note: The following fields are mutually exclusive: `operation`, `api`, `deployment`, `spec`, `definition`, `version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1017
1021
  # @!attribute [rw] deployment
1018
1022
  # @return [::Google::Cloud::ApiHub::V1::Deployment]
1019
1023
  # This represents Deployment resource in search results. Only name,
1020
1024
  # display_name and description fields are populated in search results.
1025
+ #
1026
+ # Note: The following fields are mutually exclusive: `deployment`, `api`, `operation`, `spec`, `definition`, `version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1021
1027
  # @!attribute [rw] spec
1022
1028
  # @return [::Google::Cloud::ApiHub::V1::Spec]
1023
1029
  # This represents Spec resource in search results. Only name,
1024
1030
  # display_name and description fields are populated in search results.
1031
+ #
1032
+ # Note: The following fields are mutually exclusive: `spec`, `api`, `operation`, `deployment`, `definition`, `version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1025
1033
  # @!attribute [rw] definition
1026
1034
  # @return [::Google::Cloud::ApiHub::V1::Definition]
1027
1035
  # This represents Definition resource in search results.
1028
1036
  # Only name field is populated in search results.
1037
+ #
1038
+ # Note: The following fields are mutually exclusive: `definition`, `api`, `operation`, `deployment`, `spec`, `version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1029
1039
  # @!attribute [rw] version
1030
1040
  # @return [::Google::Cloud::ApiHub::V1::Version]
1031
1041
  # This represents Version resource in search results. Only name,
1032
1042
  # display_name and description fields are populated in search results.
1043
+ #
1044
+ # Note: The following fields are mutually exclusive: `version`, `api`, `operation`, `deployment`, `spec`, `definition`. If a field in that set is populated, all other fields in the set will automatically be cleared.
1033
1045
  class ApiHubResource
1034
1046
  include ::Google::Protobuf::MessageExts
1035
1047
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -848,14 +848,20 @@ module Google
848
848
  # @return [::Google::Cloud::ApiHub::V1::AttributeValues::EnumAttributeValues]
849
849
  # The attribute values associated with a resource in case attribute data
850
850
  # type is enum.
851
+ #
852
+ # Note: The following fields are mutually exclusive: `enum_values`, `string_values`, `json_values`. If a field in that set is populated, all other fields in the set will automatically be cleared.
851
853
  # @!attribute [rw] string_values
852
854
  # @return [::Google::Cloud::ApiHub::V1::AttributeValues::StringAttributeValues]
853
855
  # The attribute values associated with a resource in case attribute data
854
856
  # type is string.
857
+ #
858
+ # Note: The following fields are mutually exclusive: `string_values`, `enum_values`, `json_values`. If a field in that set is populated, all other fields in the set will automatically be cleared.
855
859
  # @!attribute [rw] json_values
856
860
  # @return [::Google::Cloud::ApiHub::V1::AttributeValues::StringAttributeValues]
857
861
  # The attribute values associated with a resource in case attribute data
858
862
  # type is JSON.
863
+ #
864
+ # Note: The following fields are mutually exclusive: `json_values`, `enum_values`, `string_values`. If a field in that set is populated, all other fields in the set will automatically be cleared.
859
865
  # @!attribute [r] attribute
860
866
  # @return [::String]
861
867
  # Output only. The name of the attribute.
@@ -969,12 +975,16 @@ module Google
969
975
  #
970
976
  # Format:
971
977
  # `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
978
+ #
979
+ # Note: The following fields are mutually exclusive: `operation_resource_name`, `external_api_resource_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
972
980
  # @!attribute [rw] external_api_resource_name
973
981
  # @return [::String]
974
982
  # The resource name of an external API in the API Hub.
975
983
  #
976
984
  # Format:
977
985
  # `projects/{project}/locations/{location}/externalApis/{external_api}`
986
+ #
987
+ # Note: The following fields are mutually exclusive: `external_api_resource_name`, `operation_resource_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
978
988
  # @!attribute [r] display_name
979
989
  # @return [::String]
980
990
  # Output only. Display name of the entity.
@@ -40,9 +40,11 @@ module Google
40
40
  # @!attribute [rw] error
41
41
  # @return [::Google::Rpc::Status]
42
42
  # The error result of the operation in case of failure or cancellation.
43
+ #
44
+ # Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
43
45
  # @!attribute [rw] response
44
46
  # @return [::Google::Protobuf::Any]
45
- # The normal response of the operation in case of success. If the original
47
+ # The normal, successful response of the operation. If the original
46
48
  # method returns no data on success, such as `Delete`, the response is
47
49
  # `google.protobuf.Empty`. If the original method is standard
48
50
  # `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -50,12 +52,15 @@ module Google
50
52
  # is the original method name. For example, if the original method name
51
53
  # is `TakeSnapshot()`, the inferred response type is
52
54
  # `TakeSnapshotResponse`.
55
+ #
56
+ # Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
53
57
  class Operation
54
58
  include ::Google::Protobuf::MessageExts
55
59
  extend ::Google::Protobuf::MessageExts::ClassMethods
56
60
  end
57
61
 
58
- # The request message for Operations.GetOperation.
62
+ # The request message for
63
+ # Operations.GetOperation.
59
64
  # @!attribute [rw] name
60
65
  # @return [::String]
61
66
  # The name of the operation resource.
@@ -64,7 +69,8 @@ module Google
64
69
  extend ::Google::Protobuf::MessageExts::ClassMethods
65
70
  end
66
71
 
67
- # The request message for Operations.ListOperations.
72
+ # The request message for
73
+ # Operations.ListOperations.
68
74
  # @!attribute [rw] name
69
75
  # @return [::String]
70
76
  # The name of the operation's parent resource.
@@ -82,7 +88,8 @@ module Google
82
88
  extend ::Google::Protobuf::MessageExts::ClassMethods
83
89
  end
84
90
 
85
- # The response message for Operations.ListOperations.
91
+ # The response message for
92
+ # Operations.ListOperations.
86
93
  # @!attribute [rw] operations
87
94
  # @return [::Array<::Google::Longrunning::Operation>]
88
95
  # A list of operations that matches the specified filter in the request.
@@ -94,7 +101,8 @@ module Google
94
101
  extend ::Google::Protobuf::MessageExts::ClassMethods
95
102
  end
96
103
 
97
- # The request message for Operations.CancelOperation.
104
+ # The request message for
105
+ # Operations.CancelOperation.
98
106
  # @!attribute [rw] name
99
107
  # @return [::String]
100
108
  # The name of the operation resource to be cancelled.
@@ -103,7 +111,8 @@ module Google
103
111
  extend ::Google::Protobuf::MessageExts::ClassMethods
104
112
  end
105
113
 
106
- # The request message for Operations.DeleteOperation.
114
+ # The request message for
115
+ # Operations.DeleteOperation.
107
116
  # @!attribute [rw] name
108
117
  # @return [::String]
109
118
  # The name of the operation resource to be deleted.
@@ -112,7 +121,8 @@ module Google
112
121
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
122
  end
114
123
 
115
- # The request message for Operations.WaitOperation.
124
+ # The request message for
125
+ # Operations.WaitOperation.
116
126
  # @!attribute [rw] name
117
127
  # @return [::String]
118
128
  # The name of the operation resource to wait on.
@@ -130,13 +140,12 @@ module Google
130
140
  #
131
141
  # Example:
132
142
  #
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
- # }
143
+ # rpc Export(ExportRequest) returns (google.longrunning.Operation) {
144
+ # option (google.longrunning.operation_info) = {
145
+ # response_type: "ExportResponse"
146
+ # metadata_type: "ExportMetadata"
147
+ # };
148
+ # }
140
149
  # @!attribute [rw] response_type
141
150
  # @return [::String]
142
151
  # Required. The message name of the primary return type for this