google-cloud-retail-v2 0.1.0 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -60,7 +60,7 @@ module Google
60
60
  parent_config = while namespace.any?
61
61
  parent_name = namespace.join "::"
62
62
  parent_const = const_get parent_name
63
- break parent_const.configure if parent_const&.respond_to? :configure
63
+ break parent_const.configure if parent_const.respond_to? :configure
64
64
  namespace.pop
65
65
  end
66
66
  default_config = Client::Configuration.new parent_config
@@ -68,9 +68,9 @@ module Google
68
68
  default_config.timeout = 60.0
69
69
  default_config.retry_policy = {
70
70
  initial_delay: 0.1,
71
- max_delay: 60.0,
72
- multiplier: 1.3,
73
- retry_codes: [14, 4]
71
+ max_delay: 60.0,
72
+ multiplier: 1.3,
73
+ retry_codes: [14, 4]
74
74
  }
75
75
 
76
76
  default_config
@@ -134,7 +134,13 @@ module Google
134
134
 
135
135
  # Create credentials
136
136
  credentials = @config.credentials
137
- credentials ||= Credentials.default scope: @config.scope
137
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
138
+ # but only if the default endpoint does not have a region prefix.
139
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
140
+ @config.endpoint == Client.configure.endpoint &&
141
+ !@config.endpoint.split(".").first.include?("-")
142
+ credentials ||= Credentials.default scope: @config.scope,
143
+ enable_self_signed_jwt: enable_self_signed_jwt
138
144
  if credentials.is_a?(String) || credentials.is_a?(Hash)
139
145
  credentials = Credentials.new credentials, scope: @config.scope
140
146
  end
@@ -184,7 +190,7 @@ module Google
184
190
  #
185
191
  # @param parent [::String]
186
192
  # Required. The parent catalog resource name, such as
187
- # "projects/1234/locations/global/catalogs/default_catalog".
193
+ # `projects/1234/locations/global/catalogs/default_catalog`.
188
194
  # @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
189
195
  # Required. User event to write.
190
196
  #
@@ -257,7 +263,7 @@ module Google
257
263
  #
258
264
  # @param parent [::String]
259
265
  # Required. The parent catalog name, such as
260
- # "projects/1234/locations/global/catalogs/default_catalog".
266
+ # `projects/1234/locations/global/catalogs/default_catalog`.
261
267
  # @param user_event [::String]
262
268
  # Required. URL encoded UserEvent proto with a length limit of 2,000,000
263
269
  # characters.
@@ -441,7 +447,7 @@ module Google
441
447
  # the default parameter values, pass an empty Hash as a request object (see above).
442
448
  #
443
449
  # @param parent [::String]
444
- # Required. "projects/1234/locations/global/catalogs/default_catalog"
450
+ # Required. `projects/1234/locations/global/catalogs/default_catalog`
445
451
  # @param input_config [::Google::Cloud::Retail::V2::UserEventInputConfig, ::Hash]
446
452
  # Required. The desired input location of the data.
447
453
  # @param errors_config [::Google::Cloud::Retail::V2::ImportErrorsConfig, ::Hash]
@@ -520,7 +526,7 @@ module Google
520
526
  #
521
527
  # @param parent [::String]
522
528
  # Required. The parent catalog resource name, such as
523
- # "projects/1234/locations/global/catalogs/default_catalog".
529
+ # `projects/1234/locations/global/catalogs/default_catalog`.
524
530
  # @param user_event_rejoin_scope [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
525
531
  # The type of the user event rejoin to define the scope and range of the user
526
532
  # events to be rejoined with the latest product catalog. Defaults to
@@ -665,7 +671,7 @@ module Google
665
671
  config_attr :scope, nil, ::String, ::Array, nil
666
672
  config_attr :lib_name, nil, ::String, nil
667
673
  config_attr :lib_version, nil, ::String, nil
668
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
674
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
669
675
  config_attr :interceptors, nil, ::Array, nil
670
676
  config_attr :timeout, nil, ::Numeric, nil
671
677
  config_attr :metadata, nil, ::Hash, nil
@@ -686,7 +692,7 @@ module Google
686
692
  def rpcs
687
693
  @rpcs ||= begin
688
694
  parent_rpcs = nil
689
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
695
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
690
696
  Rpcs.new parent_rpcs
691
697
  end
692
698
  end
@@ -698,7 +704,7 @@ module Google
698
704
  # Each configuration object is of type `Gapic::Config::Method` and includes
699
705
  # the following configuration fields:
700
706
  #
701
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
707
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
702
708
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
703
709
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
704
710
  # include the following keys:
@@ -737,15 +743,15 @@ module Google
737
743
 
738
744
  # @private
739
745
  def initialize parent_rpcs = nil
740
- write_user_event_config = parent_rpcs&.write_user_event if parent_rpcs&.respond_to? :write_user_event
746
+ write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
741
747
  @write_user_event = ::Gapic::Config::Method.new write_user_event_config
742
- collect_user_event_config = parent_rpcs&.collect_user_event if parent_rpcs&.respond_to? :collect_user_event
748
+ collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
743
749
  @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
744
- purge_user_events_config = parent_rpcs&.purge_user_events if parent_rpcs&.respond_to? :purge_user_events
750
+ purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
745
751
  @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
746
- import_user_events_config = parent_rpcs&.import_user_events if parent_rpcs&.respond_to? :import_user_events
752
+ import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
747
753
  @import_user_events = ::Gapic::Config::Method.new import_user_events_config
748
- rejoin_user_events_config = parent_rpcs&.rejoin_user_events if parent_rpcs&.respond_to? :rejoin_user_events
754
+ rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
749
755
  @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config
750
756
 
751
757
  yield self if block_given?
@@ -103,8 +103,13 @@ module Google
103
103
  # Lists operations that match the specified filter in the request. If the
104
104
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
105
105
  #
106
- # NOTE: the `name` binding below allows API services to override the binding
107
- # to use different resource name schemes, such as `users/*/operations`.
106
+ # NOTE: the `name` binding allows API services to override the binding
107
+ # to use different resource name schemes, such as `users/*/operations`. To
108
+ # override the binding, API services can add a binding such as
109
+ # `"/v1/{name=users/*}/operations"` to their service configuration.
110
+ # For backwards compatibility, the default name includes the operations
111
+ # collection id, however overriding users must ensure the name binding
112
+ # is the parent resource, without the operations collection id.
108
113
  #
109
114
  # @overload list_operations(request, options = nil)
110
115
  # Pass arguments to `list_operations` via a request object, either of type
@@ -122,7 +127,7 @@ module Google
122
127
  # the default parameter values, pass an empty Hash as a request object (see above).
123
128
  #
124
129
  # @param name [::String]
125
- # The name of the operation collection.
130
+ # The name of the operation's parent resource.
126
131
  # @param filter [::String]
127
132
  # The standard list filter.
128
133
  # @param page_size [::Integer]
@@ -390,6 +395,79 @@ module Google
390
395
  raise ::Google::Cloud::Error.from_error(e)
391
396
  end
392
397
 
398
+ ##
399
+ # Waits for the specified long-running operation until it is done or reaches
400
+ # at most a specified timeout, returning the latest state. If the operation
401
+ # is already done, the latest state is immediately returned. If the timeout
402
+ # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
+ # timeout is used. If the server does not support this method, it returns
404
+ # `google.rpc.Code.UNIMPLEMENTED`.
405
+ # Note that this method is on a best-effort basis. It may return the latest
406
+ # state before the specified timeout (including immediately), meaning even an
407
+ # immediate response is no guarantee that the operation is done.
408
+ #
409
+ # @overload wait_operation(request, options = nil)
410
+ # Pass arguments to `wait_operation` via a request object, either of type
411
+ # {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
412
+ #
413
+ # @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
414
+ # A request object representing the call parameters. Required. To specify no
415
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
416
+ # @param options [::Gapic::CallOptions, ::Hash]
417
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
418
+ #
419
+ # @overload wait_operation(name: nil, timeout: nil)
420
+ # Pass arguments to `wait_operation` via keyword arguments. Note that at
421
+ # least one keyword argument is required. To specify no parameters, or to keep all
422
+ # the default parameter values, pass an empty Hash as a request object (see above).
423
+ #
424
+ # @param name [::String]
425
+ # The name of the operation resource to wait on.
426
+ # @param timeout [::Google::Protobuf::Duration, ::Hash]
427
+ # The maximum duration to wait before timing out. If left blank, the wait
428
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
429
+ # If RPC context deadline is also specified, the shorter one will be used.
430
+ #
431
+ # @yield [response, operation] Access the result along with the RPC operation
432
+ # @yieldparam response [::Gapic::Operation]
433
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
434
+ #
435
+ # @return [::Gapic::Operation]
436
+ #
437
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
438
+ #
439
+ def wait_operation request, options = nil
440
+ raise ::ArgumentError, "request must be provided" if request.nil?
441
+
442
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
443
+
444
+ # Converts hash and nil to an options object
445
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
446
+
447
+ # Customize the options with defaults
448
+ metadata = @config.rpcs.wait_operation.metadata.to_h
449
+
450
+ # Set x-goog-api-client and x-goog-user-project headers
451
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
452
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
453
+ gapic_version: ::Google::Cloud::Retail::V2::VERSION
454
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
455
+
456
+ options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
+ metadata: metadata,
458
+ retry_policy: @config.rpcs.wait_operation.retry_policy
459
+ options.apply_defaults metadata: @config.metadata,
460
+ retry_policy: @config.retry_policy
461
+
462
+ @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
463
+ response = ::Gapic::Operation.new response, @operations_client, options: options
464
+ yield response, operation if block_given?
465
+ return response
466
+ end
467
+ rescue ::GRPC::BadStatus => e
468
+ raise ::Google::Cloud::Error.from_error(e)
469
+ end
470
+
393
471
  ##
394
472
  # Configuration class for the Operations API.
395
473
  #
@@ -482,7 +560,7 @@ module Google
482
560
  config_attr :scope, nil, ::String, ::Array, nil
483
561
  config_attr :lib_name, nil, ::String, nil
484
562
  config_attr :lib_version, nil, ::String, nil
485
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
563
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
486
564
  config_attr :interceptors, nil, ::Array, nil
487
565
  config_attr :timeout, nil, ::Numeric, nil
488
566
  config_attr :metadata, nil, ::Hash, nil
@@ -503,7 +581,7 @@ module Google
503
581
  def rpcs
504
582
  @rpcs ||= begin
505
583
  parent_rpcs = nil
506
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
584
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
507
585
  Rpcs.new parent_rpcs
508
586
  end
509
587
  end
@@ -515,7 +593,7 @@ module Google
515
593
  # Each configuration object is of type `Gapic::Config::Method` and includes
516
594
  # the following configuration fields:
517
595
  #
518
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
596
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
519
597
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
520
598
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
521
599
  # include the following keys:
@@ -546,17 +624,24 @@ module Google
546
624
  # @return [::Gapic::Config::Method]
547
625
  #
548
626
  attr_reader :cancel_operation
627
+ ##
628
+ # RPC-specific configuration for `wait_operation`
629
+ # @return [::Gapic::Config::Method]
630
+ #
631
+ attr_reader :wait_operation
549
632
 
550
633
  # @private
551
634
  def initialize parent_rpcs = nil
552
- list_operations_config = parent_rpcs&.list_operations if parent_rpcs&.respond_to? :list_operations
635
+ list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
553
636
  @list_operations = ::Gapic::Config::Method.new list_operations_config
554
- get_operation_config = parent_rpcs&.get_operation if parent_rpcs&.respond_to? :get_operation
637
+ get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
555
638
  @get_operation = ::Gapic::Config::Method.new get_operation_config
556
- delete_operation_config = parent_rpcs&.delete_operation if parent_rpcs&.respond_to? :delete_operation
639
+ delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
557
640
  @delete_operation = ::Gapic::Config::Method.new delete_operation_config
558
- cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
641
+ cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
559
642
  @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
643
+ wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
644
+ @wait_operation = ::Gapic::Config::Method.new wait_operation_config
560
645
 
561
646
  yield self if block_given?
562
647
  end
@@ -27,7 +27,7 @@ module Google
27
27
  # Service for ingesting end user actions on the customer website.
28
28
  class Service
29
29
 
30
- include GRPC::GenericService
30
+ include ::GRPC::GenericService
31
31
 
32
32
  self.marshal_class_method = :encode
33
33
  self.unmarshal_class_method = :decode
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Retail
23
23
  module V2
24
- VERSION = "0.1.0"
24
+ VERSION = "0.3.1"
25
25
  end
26
26
  end
27
27
  end
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -27,10 +27,11 @@ module Google
27
27
  # @return [::Array<::String>]
28
28
  # Required. Google Cloud Storage URIs to input files. URI can be up to
29
29
  # 2000 characters long. URIs can match the full object path (for example,
30
- # gs://bucket/directory/object.json) or a pattern matching one or more
31
- # files, such as gs://bucket/directory/*.json. A request can
30
+ # `gs://bucket/directory/object.json`) or a pattern matching one or more
31
+ # files, such as `gs://bucket/directory/*.json`. A request can
32
32
  # contain at most 100 files, and each file can be up to 2 GB. See
33
- # [Importing product information](/recommendations-ai/docs/upload-catalog)
33
+ # [Importing product
34
+ # information](https://cloud.google.com/recommendations-ai/docs/upload-catalog)
34
35
  # for the expected file format and setup instructions.
35
36
  # @!attribute [rw] data_schema
36
37
  # @return [::String]
@@ -42,7 +43,7 @@ module Google
42
43
  # per line. Each product must
43
44
  # have a valid {::Google::Cloud::Retail::V2::Product#id Product.id}.
44
45
  # * `product_merchant_center`: See [Importing catalog data from Merchant
45
- # Center](/retail/recommendations-ai/docs/upload-catalog#mc).
46
+ # Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
46
47
  #
47
48
  # Supported values for user events imports:
48
49
  #
@@ -84,7 +85,7 @@ module Google
84
85
  # per line. Each product must
85
86
  # have a valid {::Google::Cloud::Retail::V2::Product#id Product.id}.
86
87
  # * `product_merchant_center`: See [Importing catalog data from Merchant
87
- # Center](/retail/recommendations-ai/docs/upload-catalog#mc).
88
+ # Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
88
89
  #
89
90
  # Supported values for user events imports:
90
91
  #
@@ -133,7 +134,7 @@ module Google
133
134
  # @!attribute [rw] parent
134
135
  # @return [::String]
135
136
  # Required.
136
- # "projects/1234/locations/global/catalogs/default_catalog/branches/default_branch"
137
+ # `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`
137
138
  #
138
139
  # If no updateMask is specified, requires products.create permission.
139
140
  # If updateMask is specified, requires products.update permission.
@@ -155,7 +156,7 @@ module Google
155
156
  # Request message for the ImportUserEvents request.
156
157
  # @!attribute [rw] parent
157
158
  # @return [::String]
158
- # Required. "projects/1234/locations/global/catalogs/default_catalog"
159
+ # Required. `projects/1234/locations/global/catalogs/default_catalog`
159
160
  # @!attribute [rw] input_config
160
161
  # @return [::Google::Cloud::Retail::V2::UserEventInputConfig]
161
162
  # Required. The desired input location of the data.
@@ -26,7 +26,7 @@ module Google
26
26
  # @!attribute [rw] name
27
27
  # @return [::String]
28
28
  # Immutable. Full resource name of the product, such as
29
- # "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id".
29
+ # `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
30
30
  #
31
31
  # The branch ID must be "default_branch".
32
32
  # @!attribute [rw] id
@@ -35,7 +35,7 @@ module Google
35
35
  # the final component of {::Google::Cloud::Retail::V2::Product#name name}. For
36
36
  # example, this field is "id_1", if
37
37
  # {::Google::Cloud::Retail::V2::Product#name name} is
38
- # "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1".
38
+ # `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`.
39
39
  #
40
40
  # This field must be a UTF-8 encoded string with a length limit of 128
41
41
  # characters. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -25,7 +25,7 @@ module Google
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
27
  # Required. The parent catalog resource name, such as
28
- # "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
28
+ # `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.
29
29
  # @!attribute [rw] product
30
30
  # @return [::Google::Cloud::Retail::V2::Product]
31
31
  # Required. The {::Google::Cloud::Retail::V2::Product Product} to create.
@@ -56,7 +56,7 @@ module Google
56
56
  # @return [::String]
57
57
  # Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
58
58
  # such as
59
- # "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
59
+ # `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
60
60
  #
61
61
  # If the caller does not have permission to access the
62
62
  # {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
@@ -99,7 +99,7 @@ module Google
99
99
  # @return [::String]
100
100
  # Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
101
101
  # such as
102
- # "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
102
+ # `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
103
103
  #
104
104
  # If the caller does not have permission to delete the
105
105
  # {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
@@ -25,7 +25,7 @@ module Google
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
27
  # Required. The parent catalog resource name, such as
28
- # "projects/1234/locations/global/catalogs/default_catalog".
28
+ # `projects/1234/locations/global/catalogs/default_catalog`.
29
29
  # @!attribute [rw] user_event
30
30
  # @return [::Google::Cloud::Retail::V2::UserEvent]
31
31
  # Required. User event to write.
@@ -38,7 +38,7 @@ module Google
38
38
  # @!attribute [rw] parent
39
39
  # @return [::String]
40
40
  # Required. The parent catalog name, such as
41
- # "projects/1234/locations/global/catalogs/default_catalog".
41
+ # `projects/1234/locations/global/catalogs/default_catalog`.
42
42
  # @!attribute [rw] user_event
43
43
  # @return [::String]
44
44
  # Required. URL encoded UserEvent proto with a length limit of 2,000,000
@@ -63,7 +63,7 @@ module Google
63
63
  # @!attribute [rw] parent
64
64
  # @return [::String]
65
65
  # Required. The parent catalog resource name, such as
66
- # "projects/1234/locations/global/catalogs/default_catalog".
66
+ # `projects/1234/locations/global/catalogs/default_catalog`.
67
67
  # @!attribute [rw] user_event_rejoin_scope
68
68
  # @return [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
69
69
  # The type of the user event rejoin to define the scope and range of the user
@@ -25,7 +25,7 @@ module Google
25
25
  # @return [::String]
26
26
  # The server-assigned name, which is only unique within the same service that
27
27
  # originally returns it. If you use the default HTTP mapping, the
28
- # `name` should have the format of `operations/some/unique/name`.
28
+ # `name` should be a resource name ending with `operations/{unique_id}`.
29
29
  # @!attribute [rw] metadata
30
30
  # @return [::Google::Protobuf::Any]
31
31
  # Service-specific metadata associated with the operation. It typically
@@ -35,7 +35,7 @@ module Google
35
35
  # @!attribute [rw] done
36
36
  # @return [::Boolean]
37
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
38
+ # If `true`, the operation is completed, and either `error` or `response` is
39
39
  # available.
40
40
  # @!attribute [rw] error
41
41
  # @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
67
67
  # The request message for Operations.ListOperations.
68
68
  # @!attribute [rw] name
69
69
  # @return [::String]
70
- # The name of the operation collection.
70
+ # The name of the operation's parent resource.
71
71
  # @!attribute [rw] filter
72
72
  # @return [::String]
73
73
  # The standard list filter.
@@ -112,6 +112,20 @@ module Google
112
112
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
113
  end
114
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
+
115
129
  # A message representing the message types used by a long-running operation.
116
130
  #
117
131
  # Example: