google-cloud-vision-v1 0.2.3 → 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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 170964c4307606d76b3530e2447564f1641691135ab4c8382f45bf483f58b6d0
4
- data.tar.gz: f9c11db4226960a554f1d69ce2d69614244eb7b1100fa913b4f88277457b163d
3
+ metadata.gz: 71ac8147a42a9980b722fe44fef1e94c6dac6b8f1bae6ec7efc623ed42521776
4
+ data.tar.gz: 835e008bd8b3ad897054d6fd28c17676ca8d485e53980e27d7083c2d3294191d
5
5
  SHA512:
6
- metadata.gz: c9cd0ef3ceaa55757c201231d3204f9e48abf1553ea67be2f3eeaa2c1f6ec45cba0171b7088dfaa548b98b6963534b0422c9c00435c465ff948789cd9fdf46c8
7
- data.tar.gz: cb4db1f3e26fe5e27f1d09ab307a331871a5b8b9689be6a758fe8ed01a085b2c74fef6636fa4111afb3a082bae71a72c0d8e1233a86b7e9b0f4718cacc50831d
6
+ metadata.gz: 924ef7290698022ab393f25651ac4589da7395859866d7d273bcb67b1a8c74071b6525f63f11bdd102f7ca7821724aaa0f80c9f1db04c3d45695e6a6b0522cb0
7
+ data.tar.gz: b00037cb9ce8ce1ec7b2f075a998a759deded2a4d1b9a0d85f0a87d56823a46d7097a16baa207d34de7100cb19a13e43064cf54de0e21ce3e80f44a1ef7b70fb
data/README.md CHANGED
@@ -6,6 +6,12 @@ Cloud Vision API allows developers to easily integrate vision detection features
6
6
 
7
7
  https://github.com/googleapis/google-cloud-ruby
8
8
 
9
+ This gem is a _versioned_ client. It provides basic client classes for a
10
+ specific version of the Cloud Vision V1 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-vision](https://rubygems.org/gems/google-cloud-vision).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
9
15
  ## Installation
10
16
 
11
17
  ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
73
79
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
74
80
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
75
81
  about the Ruby support schedule.
82
+
83
+ ## Which client should I use?
84
+
85
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
86
+ client library with a name such as `google-cloud-vision`,
87
+ and lower-level _versioned_ client libraries with names such as
88
+ `google-cloud-vision-v1`.
89
+ _In most cases, you should install the main client._
90
+
91
+ ### What's the difference between the main client and a versioned client?
92
+
93
+ A _versioned client_ provides a basic set of data types and client classes for
94
+ a _single version_ of a specific service. (That is, for a service with multiple
95
+ versions, there might be a separate versioned client for each service version.)
96
+ Most versioned clients are written and maintained by a code generator.
97
+
98
+ The _main client_ is designed to provide you with the _recommended_ client
99
+ interfaces for the service. There will be only one main client for any given
100
+ service, even a service with multiple versions. The main client includes
101
+ factory methods for constructing the client objects we recommend for most
102
+ users. In some cases, those will be classes provided by an underlying versioned
103
+ client; in other cases, they will be handwritten higher-level client objects
104
+ with additional capabilities, convenience methods, or best practices built in.
105
+ Generally, the main client will default to a recommended service version,
106
+ although in some cases you can override this if you need to talk to a specific
107
+ service version.
108
+
109
+ ### Why would I want to use the main client?
110
+
111
+ We recommend that most users install the main client gem for a service. You can
112
+ identify this gem as the one _without_ a version in its name, e.g.
113
+ `google-cloud-vision`.
114
+ The main client is recommended because it will embody the best practices for
115
+ accessing the service, and may also provide more convenient interfaces or
116
+ tighter integration into frameworks and third-party libraries. In addition, the
117
+ documentation and samples published by Google will generally demonstrate use of
118
+ the main client.
119
+
120
+ ### Why would I want to use a versioned client?
121
+
122
+ You can use a versioned client if you are content with a possibly lower-level
123
+ class interface, you explicitly want to avoid features provided by the main
124
+ client, or you want to access a specific service version not be covered by the
125
+ main client. You can identify versioned client gems because the service version
126
+ is part of the name, e.g. `google-cloud-vision-v1`.
127
+
128
+ ### What about the google-apis-<name> clients?
129
+
130
+ Client library gems with names that begin with `google-apis-` are based on an
131
+ older code generation technology. They talk to a REST/JSON backend (whereas
132
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
133
+ not offer the same performance, features, and ease of use provided by more
134
+ modern clients.
135
+
136
+ The `google-apis-` clients have wide coverage across Google services, so you
137
+ might need to use one if there is no modern client available for the service.
138
+ However, if a modern client is available, we generally recommend it over the
139
+ older `google-apis-` clients.
@@ -34,3 +34,6 @@ module Google
34
34
  end
35
35
  end
36
36
  end
37
+
38
+ helper_path = ::File.join __dir__, "v1", "_helpers.rb"
39
+ require "google/cloud/vision/v1/_helpers" if ::File.file? helper_path
@@ -72,7 +72,7 @@ module Google
72
72
  initial_delay: 0.1,
73
73
  max_delay: 60.0,
74
74
  multiplier: 1.3,
75
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
75
+ retry_codes: [4, 14]
76
76
  }
77
77
 
78
78
  default_config.rpcs.batch_annotate_files.timeout = 600.0
@@ -80,7 +80,7 @@ module Google
80
80
  initial_delay: 0.1,
81
81
  max_delay: 60.0,
82
82
  multiplier: 1.3,
83
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
83
+ retry_codes: [4, 14]
84
84
  }
85
85
 
86
86
  default_config.rpcs.async_batch_annotate_images.timeout = 600.0
@@ -88,7 +88,7 @@ module Google
88
88
  initial_delay: 0.1,
89
89
  max_delay: 60.0,
90
90
  multiplier: 1.3,
91
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
91
+ retry_codes: [4, 14]
92
92
  }
93
93
 
94
94
  default_config.rpcs.async_batch_annotate_files.timeout = 600.0
@@ -96,7 +96,7 @@ module Google
96
96
  initial_delay: 0.1,
97
97
  max_delay: 60.0,
98
98
  multiplier: 1.3,
99
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
99
+ retry_codes: [4, 14]
100
100
  }
101
101
 
102
102
  default_config
@@ -160,7 +160,13 @@ module Google
160
160
 
161
161
  # Create credentials
162
162
  credentials = @config.credentials
163
- credentials ||= Credentials.default scope: @config.scope
163
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
164
+ # but only if the default endpoint does not have a region prefix.
165
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
166
+ @config.endpoint == Client.configure.endpoint &&
167
+ !@config.endpoint.split(".").first.include?("-")
168
+ credentials ||= Credentials.default scope: @config.scope,
169
+ enable_self_signed_jwt: enable_self_signed_jwt
164
170
  if credentials.is_a?(String) || credentials.is_a?(Hash)
165
171
  credentials = Credentials.new credentials, scope: @config.scope
166
172
  end
@@ -591,7 +597,7 @@ module Google
591
597
 
592
598
  config_attr :endpoint, "vision.googleapis.com", ::String
593
599
  config_attr :credentials, nil do |value|
594
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
600
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
595
601
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
596
602
  allowed.any? { |klass| klass === value }
597
603
  end
@@ -631,7 +637,7 @@ module Google
631
637
  # Each configuration object is of type `Gapic::Config::Method` and includes
632
638
  # the following configuration fields:
633
639
  #
634
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
640
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
635
641
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
636
642
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
637
643
  # include the following keys:
@@ -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::Vision::V1::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
  #
@@ -475,7 +553,7 @@ module Google
475
553
 
476
554
  config_attr :endpoint, "vision.googleapis.com", ::String
477
555
  config_attr :credentials, nil do |value|
478
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
556
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
479
557
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
480
558
  allowed.any? { |klass| klass === value }
481
559
  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,6 +624,11 @@ 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
@@ -557,6 +640,8 @@ module Google
557
640
  @delete_operation = ::Gapic::Config::Method.new delete_operation_config
558
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
@@ -172,12 +172,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
172
172
  add_message "google.cloud.vision.v1.WebDetectionParams" do
173
173
  optional :include_geo_results, :bool, 2
174
174
  end
175
+ add_message "google.cloud.vision.v1.TextDetectionParams" do
176
+ optional :enable_text_detection_confidence_score, :bool, 9
177
+ end
175
178
  add_message "google.cloud.vision.v1.ImageContext" do
176
179
  optional :lat_long_rect, :message, 1, "google.cloud.vision.v1.LatLongRect"
177
180
  repeated :language_hints, :string, 2
178
181
  optional :crop_hints_params, :message, 4, "google.cloud.vision.v1.CropHintsParams"
179
182
  optional :product_search_params, :message, 5, "google.cloud.vision.v1.ProductSearchParams"
180
183
  optional :web_detection_params, :message, 6, "google.cloud.vision.v1.WebDetectionParams"
184
+ optional :text_detection_params, :message, 12, "google.cloud.vision.v1.TextDetectionParams"
181
185
  end
182
186
  add_message "google.cloud.vision.v1.AnnotateImageRequest" do
183
187
  optional :image, :message, 1, "google.cloud.vision.v1.Image"
@@ -316,6 +320,7 @@ module Google
316
320
  CropHintsAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHintsAnnotation").msgclass
317
321
  CropHintsParams = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHintsParams").msgclass
318
322
  WebDetectionParams = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.WebDetectionParams").msgclass
323
+ TextDetectionParams = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.TextDetectionParams").msgclass
319
324
  ImageContext = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageContext").msgclass
320
325
  AnnotateImageRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AnnotateImageRequest").msgclass
321
326
  ImageAnnotationContext = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageAnnotationContext").msgclass
@@ -37,7 +37,7 @@ module Google
37
37
  self.service_name = 'google.cloud.vision.v1.ImageAnnotator'
38
38
 
39
39
  # Run image detection and annotation for a batch of images.
40
- rpc :BatchAnnotateImages, BatchAnnotateImagesRequest, BatchAnnotateImagesResponse
40
+ rpc :BatchAnnotateImages, ::Google::Cloud::Vision::V1::BatchAnnotateImagesRequest, ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse
41
41
  # Service that performs image detection and annotation for a batch of files.
42
42
  # Now only "application/pdf", "image/tiff" and "image/gif" are supported.
43
43
  #
@@ -45,7 +45,7 @@ module Google
45
45
  # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each
46
46
  # file provided and perform detection and annotation for each image
47
47
  # extracted.
48
- rpc :BatchAnnotateFiles, BatchAnnotateFilesRequest, BatchAnnotateFilesResponse
48
+ rpc :BatchAnnotateFiles, ::Google::Cloud::Vision::V1::BatchAnnotateFilesRequest, ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse
49
49
  # Run asynchronous image detection and annotation for a list of images.
50
50
  #
51
51
  # Progress and results can be retrieved through the
@@ -55,14 +55,14 @@ module Google
55
55
  #
56
56
  # This service will write image annotation outputs to json files in customer
57
57
  # GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
58
- rpc :AsyncBatchAnnotateImages, AsyncBatchAnnotateImagesRequest, Google::Longrunning::Operation
58
+ rpc :AsyncBatchAnnotateImages, ::Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest, ::Google::Longrunning::Operation
59
59
  # Run asynchronous image detection and annotation for a list of generic
60
60
  # files, such as PDF files, which may contain multiple pages and multiple
61
61
  # images per page. Progress and results can be retrieved through the
62
62
  # `google.longrunning.Operations` interface.
63
63
  # `Operation.metadata` contains `OperationMetadata` (metadata).
64
64
  # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
65
- rpc :AsyncBatchAnnotateFiles, AsyncBatchAnnotateFilesRequest, Google::Longrunning::Operation
65
+ rpc :AsyncBatchAnnotateFiles, ::Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest, ::Google::Longrunning::Operation
66
66
  end
67
67
 
68
68
  Stub = Service.rpc_stub_class
@@ -91,7 +91,7 @@ module Google
91
91
  initial_delay: 0.1,
92
92
  max_delay: 60.0,
93
93
  multiplier: 1.3,
94
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
94
+ retry_codes: [4, 14]
95
95
  }
96
96
 
97
97
  default_config.rpcs.get_product_set.timeout = 600.0
@@ -99,7 +99,7 @@ module Google
99
99
  initial_delay: 0.1,
100
100
  max_delay: 60.0,
101
101
  multiplier: 1.3,
102
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
102
+ retry_codes: [4, 14]
103
103
  }
104
104
 
105
105
  default_config.rpcs.update_product_set.timeout = 600.0
@@ -107,7 +107,7 @@ module Google
107
107
  initial_delay: 0.1,
108
108
  max_delay: 60.0,
109
109
  multiplier: 1.3,
110
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
110
+ retry_codes: [4, 14]
111
111
  }
112
112
 
113
113
  default_config.rpcs.delete_product_set.timeout = 600.0
@@ -115,7 +115,7 @@ module Google
115
115
  initial_delay: 0.1,
116
116
  max_delay: 60.0,
117
117
  multiplier: 1.3,
118
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
118
+ retry_codes: [4, 14]
119
119
  }
120
120
 
121
121
  default_config.rpcs.create_product.timeout = 600.0
@@ -131,7 +131,7 @@ module Google
131
131
  initial_delay: 0.1,
132
132
  max_delay: 60.0,
133
133
  multiplier: 1.3,
134
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
134
+ retry_codes: [4, 14]
135
135
  }
136
136
 
137
137
  default_config.rpcs.get_product.timeout = 600.0
@@ -139,7 +139,7 @@ module Google
139
139
  initial_delay: 0.1,
140
140
  max_delay: 60.0,
141
141
  multiplier: 1.3,
142
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
142
+ retry_codes: [4, 14]
143
143
  }
144
144
 
145
145
  default_config.rpcs.update_product.timeout = 600.0
@@ -147,7 +147,7 @@ module Google
147
147
  initial_delay: 0.1,
148
148
  max_delay: 60.0,
149
149
  multiplier: 1.3,
150
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
150
+ retry_codes: [4, 14]
151
151
  }
152
152
 
153
153
  default_config.rpcs.delete_product.timeout = 600.0
@@ -155,7 +155,7 @@ module Google
155
155
  initial_delay: 0.1,
156
156
  max_delay: 60.0,
157
157
  multiplier: 1.3,
158
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
158
+ retry_codes: [4, 14]
159
159
  }
160
160
 
161
161
  default_config.rpcs.create_reference_image.timeout = 600.0
@@ -171,7 +171,7 @@ module Google
171
171
  initial_delay: 0.1,
172
172
  max_delay: 60.0,
173
173
  multiplier: 1.3,
174
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
174
+ retry_codes: [4, 14]
175
175
  }
176
176
 
177
177
  default_config.rpcs.list_reference_images.timeout = 600.0
@@ -179,7 +179,7 @@ module Google
179
179
  initial_delay: 0.1,
180
180
  max_delay: 60.0,
181
181
  multiplier: 1.3,
182
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
182
+ retry_codes: [4, 14]
183
183
  }
184
184
 
185
185
  default_config.rpcs.get_reference_image.timeout = 600.0
@@ -187,7 +187,7 @@ module Google
187
187
  initial_delay: 0.1,
188
188
  max_delay: 60.0,
189
189
  multiplier: 1.3,
190
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
190
+ retry_codes: [4, 14]
191
191
  }
192
192
 
193
193
  default_config.rpcs.add_product_to_product_set.timeout = 600.0
@@ -195,7 +195,7 @@ module Google
195
195
  initial_delay: 0.1,
196
196
  max_delay: 60.0,
197
197
  multiplier: 1.3,
198
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
198
+ retry_codes: [4, 14]
199
199
  }
200
200
 
201
201
  default_config.rpcs.remove_product_from_product_set.timeout = 600.0
@@ -203,7 +203,7 @@ module Google
203
203
  initial_delay: 0.1,
204
204
  max_delay: 60.0,
205
205
  multiplier: 1.3,
206
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
206
+ retry_codes: [4, 14]
207
207
  }
208
208
 
209
209
  default_config.rpcs.list_products_in_product_set.timeout = 600.0
@@ -211,7 +211,7 @@ module Google
211
211
  initial_delay: 0.1,
212
212
  max_delay: 60.0,
213
213
  multiplier: 1.3,
214
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
214
+ retry_codes: [4, 14]
215
215
  }
216
216
 
217
217
  default_config.rpcs.import_product_sets.timeout = 600.0
@@ -291,7 +291,13 @@ module Google
291
291
 
292
292
  # Create credentials
293
293
  credentials = @config.credentials
294
- credentials ||= Credentials.default scope: @config.scope
294
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
295
+ # but only if the default endpoint does not have a region prefix.
296
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
297
+ @config.endpoint == Client.configure.endpoint &&
298
+ !@config.endpoint.split(".").first.include?("-")
299
+ credentials ||= Credentials.default scope: @config.scope,
300
+ enable_self_signed_jwt: enable_self_signed_jwt
295
301
  if credentials.is_a?(String) || credentials.is_a?(Hash)
296
302
  credentials = Credentials.new credentials, scope: @config.scope
297
303
  end
@@ -1925,7 +1931,7 @@ module Google
1925
1931
 
1926
1932
  config_attr :endpoint, "vision.googleapis.com", ::String
1927
1933
  config_attr :credentials, nil do |value|
1928
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1934
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1929
1935
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
1930
1936
  allowed.any? { |klass| klass === value }
1931
1937
  end
@@ -1965,7 +1971,7 @@ module Google
1965
1971
  # Each configuration object is of type `Gapic::Config::Method` and includes
1966
1972
  # the following configuration fields:
1967
1973
  #
1968
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
1974
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
1969
1975
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
1970
1976
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
1971
1977
  # include the following keys:
@@ -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::Vision::V1::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
  #
@@ -475,7 +553,7 @@ module Google
475
553
 
476
554
  config_attr :endpoint, "vision.googleapis.com", ::String
477
555
  config_attr :credentials, nil do |value|
478
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
556
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
479
557
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
480
558
  allowed.any? { |klass| klass === value }
481
559
  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,6 +624,11 @@ 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
@@ -557,6 +640,8 @@ module Google
557
640
  @delete_operation = ::Gapic::Config::Method.new delete_operation_config
558
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
@@ -53,20 +53,20 @@ module Google
53
53
  #
54
54
  # * Returns INVALID_ARGUMENT if display_name is missing, or is longer than
55
55
  # 4096 characters.
56
- rpc :CreateProductSet, CreateProductSetRequest, ProductSet
56
+ rpc :CreateProductSet, ::Google::Cloud::Vision::V1::CreateProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
57
57
  # Lists ProductSets in an unspecified order.
58
58
  #
59
59
  # Possible errors:
60
60
  #
61
61
  # * Returns INVALID_ARGUMENT if page_size is greater than 100, or less
62
62
  # than 1.
63
- rpc :ListProductSets, ListProductSetsRequest, ListProductSetsResponse
63
+ rpc :ListProductSets, ::Google::Cloud::Vision::V1::ListProductSetsRequest, ::Google::Cloud::Vision::V1::ListProductSetsResponse
64
64
  # Gets information associated with a ProductSet.
65
65
  #
66
66
  # Possible errors:
67
67
  #
68
68
  # * Returns NOT_FOUND if the ProductSet does not exist.
69
- rpc :GetProductSet, GetProductSetRequest, ProductSet
69
+ rpc :GetProductSet, ::Google::Cloud::Vision::V1::GetProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
70
70
  # Makes changes to a ProductSet resource.
71
71
  # Only display_name can be updated currently.
72
72
  #
@@ -75,12 +75,12 @@ module Google
75
75
  # * Returns NOT_FOUND if the ProductSet does not exist.
76
76
  # * Returns INVALID_ARGUMENT if display_name is present in update_mask but
77
77
  # missing from the request or longer than 4096 characters.
78
- rpc :UpdateProductSet, UpdateProductSetRequest, ProductSet
78
+ rpc :UpdateProductSet, ::Google::Cloud::Vision::V1::UpdateProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
79
79
  # Permanently deletes a ProductSet. Products and ReferenceImages in the
80
80
  # ProductSet are not deleted.
81
81
  #
82
82
  # The actual image files are not deleted from Google Cloud Storage.
83
- rpc :DeleteProductSet, DeleteProductSetRequest, Google::Protobuf::Empty
83
+ rpc :DeleteProductSet, ::Google::Cloud::Vision::V1::DeleteProductSetRequest, ::Google::Protobuf::Empty
84
84
  # Creates and returns a new product resource.
85
85
  #
86
86
  # Possible errors:
@@ -89,19 +89,19 @@ module Google
89
89
  # characters.
90
90
  # * Returns INVALID_ARGUMENT if description is longer than 4096 characters.
91
91
  # * Returns INVALID_ARGUMENT if product_category is missing or invalid.
92
- rpc :CreateProduct, CreateProductRequest, Product
92
+ rpc :CreateProduct, ::Google::Cloud::Vision::V1::CreateProductRequest, ::Google::Cloud::Vision::V1::Product
93
93
  # Lists products in an unspecified order.
94
94
  #
95
95
  # Possible errors:
96
96
  #
97
97
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
98
- rpc :ListProducts, ListProductsRequest, ListProductsResponse
98
+ rpc :ListProducts, ::Google::Cloud::Vision::V1::ListProductsRequest, ::Google::Cloud::Vision::V1::ListProductsResponse
99
99
  # Gets information associated with a Product.
100
100
  #
101
101
  # Possible errors:
102
102
  #
103
103
  # * Returns NOT_FOUND if the Product does not exist.
104
- rpc :GetProduct, GetProductRequest, Product
104
+ rpc :GetProduct, ::Google::Cloud::Vision::V1::GetProductRequest, ::Google::Cloud::Vision::V1::Product
105
105
  # Makes changes to a Product resource.
106
106
  # Only the `display_name`, `description`, and `labels` fields can be updated
107
107
  # right now.
@@ -117,13 +117,13 @@ module Google
117
117
  # * Returns INVALID_ARGUMENT if description is present in update_mask but is
118
118
  # longer than 4096 characters.
119
119
  # * Returns INVALID_ARGUMENT if product_category is present in update_mask.
120
- rpc :UpdateProduct, UpdateProductRequest, Product
120
+ rpc :UpdateProduct, ::Google::Cloud::Vision::V1::UpdateProductRequest, ::Google::Cloud::Vision::V1::Product
121
121
  # Permanently deletes a product and its reference images.
122
122
  #
123
123
  # Metadata of the product and all its images will be deleted right away, but
124
124
  # search queries against ProductSets containing the product may still work
125
125
  # until all related caches are refreshed.
126
- rpc :DeleteProduct, DeleteProductRequest, Google::Protobuf::Empty
126
+ rpc :DeleteProduct, ::Google::Cloud::Vision::V1::DeleteProductRequest, ::Google::Protobuf::Empty
127
127
  # Creates and returns a new ReferenceImage resource.
128
128
  #
129
129
  # The `bounding_poly` field is optional. If `bounding_poly` is not specified,
@@ -143,7 +143,7 @@ module Google
143
143
  # * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
144
144
  # compatible with the parent product's product_category is detected.
145
145
  # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
146
- rpc :CreateReferenceImage, CreateReferenceImageRequest, ReferenceImage
146
+ rpc :CreateReferenceImage, ::Google::Cloud::Vision::V1::CreateReferenceImageRequest, ::Google::Cloud::Vision::V1::ReferenceImage
147
147
  # Permanently deletes a reference image.
148
148
  #
149
149
  # The image metadata will be deleted right away, but search queries
@@ -151,7 +151,7 @@ module Google
151
151
  # caches are refreshed.
152
152
  #
153
153
  # The actual image files are not deleted from Google Cloud Storage.
154
- rpc :DeleteReferenceImage, DeleteReferenceImageRequest, Google::Protobuf::Empty
154
+ rpc :DeleteReferenceImage, ::Google::Cloud::Vision::V1::DeleteReferenceImageRequest, ::Google::Protobuf::Empty
155
155
  # Lists reference images.
156
156
  #
157
157
  # Possible errors:
@@ -159,13 +159,13 @@ module Google
159
159
  # * Returns NOT_FOUND if the parent product does not exist.
160
160
  # * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
161
161
  # than 1.
162
- rpc :ListReferenceImages, ListReferenceImagesRequest, ListReferenceImagesResponse
162
+ rpc :ListReferenceImages, ::Google::Cloud::Vision::V1::ListReferenceImagesRequest, ::Google::Cloud::Vision::V1::ListReferenceImagesResponse
163
163
  # Gets information associated with a ReferenceImage.
164
164
  #
165
165
  # Possible errors:
166
166
  #
167
167
  # * Returns NOT_FOUND if the specified image does not exist.
168
- rpc :GetReferenceImage, GetReferenceImageRequest, ReferenceImage
168
+ rpc :GetReferenceImage, ::Google::Cloud::Vision::V1::GetReferenceImageRequest, ::Google::Cloud::Vision::V1::ReferenceImage
169
169
  # Adds a Product to the specified ProductSet. If the Product is already
170
170
  # present, no change is made.
171
171
  #
@@ -174,9 +174,9 @@ module Google
174
174
  # Possible errors:
175
175
  #
176
176
  # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
177
- rpc :AddProductToProductSet, AddProductToProductSetRequest, Google::Protobuf::Empty
177
+ rpc :AddProductToProductSet, ::Google::Cloud::Vision::V1::AddProductToProductSetRequest, ::Google::Protobuf::Empty
178
178
  # Removes a Product from the specified ProductSet.
179
- rpc :RemoveProductFromProductSet, RemoveProductFromProductSetRequest, Google::Protobuf::Empty
179
+ rpc :RemoveProductFromProductSet, ::Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest, ::Google::Protobuf::Empty
180
180
  # Lists the Products in a ProductSet, in an unspecified order. If the
181
181
  # ProductSet does not exist, the products field of the response will be
182
182
  # empty.
@@ -184,7 +184,7 @@ module Google
184
184
  # Possible errors:
185
185
  #
186
186
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
187
- rpc :ListProductsInProductSet, ListProductsInProductSetRequest, ListProductsInProductSetResponse
187
+ rpc :ListProductsInProductSet, ::Google::Cloud::Vision::V1::ListProductsInProductSetRequest, ::Google::Cloud::Vision::V1::ListProductsInProductSetResponse
188
188
  # Asynchronous API that imports a list of reference images to specified
189
189
  # product sets based on a list of image information.
190
190
  #
@@ -196,7 +196,7 @@ module Google
196
196
  # The input source of this method is a csv file on Google Cloud Storage.
197
197
  # For the format of the csv file please see
198
198
  # [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri].
199
- rpc :ImportProductSets, ImportProductSetsRequest, Google::Longrunning::Operation
199
+ rpc :ImportProductSets, ::Google::Cloud::Vision::V1::ImportProductSetsRequest, ::Google::Longrunning::Operation
200
200
  # Asynchronous API to delete all Products in a ProductSet or all Products
201
201
  # that are in no ProductSet.
202
202
  #
@@ -221,7 +221,7 @@ module Google
221
221
  # The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
222
222
  # progress and results of the request.
223
223
  # `Operation.metadata` contains `BatchOperationMetadata`. (progress)
224
- rpc :PurgeProducts, PurgeProductsRequest, Google::Longrunning::Operation
224
+ rpc :PurgeProducts, ::Google::Cloud::Vision::V1::PurgeProductsRequest, ::Google::Longrunning::Operation
225
225
  end
226
226
 
227
227
  Stub = Service.rpc_stub_class
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Vision
23
23
  module V1
24
- VERSION = "0.2.3"
24
+ VERSION = "0.4.0"
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
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -574,6 +574,18 @@ module Google
574
574
  extend ::Google::Protobuf::MessageExts::ClassMethods
575
575
  end
576
576
 
577
+ # Parameters for text detections. This is used to control TEXT_DETECTION and
578
+ # DOCUMENT_TEXT_DETECTION features.
579
+ # @!attribute [rw] enable_text_detection_confidence_score
580
+ # @return [::Boolean]
581
+ # By default, Cloud Vision API only includes confidence score for
582
+ # DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence
583
+ # score for TEXT_DETECTION as well.
584
+ class TextDetectionParams
585
+ include ::Google::Protobuf::MessageExts
586
+ extend ::Google::Protobuf::MessageExts::ClassMethods
587
+ end
588
+
577
589
  # Image context and/or feature-specific parameters.
578
590
  # @!attribute [rw] lat_long_rect
579
591
  # @return [::Google::Cloud::Vision::V1::LatLongRect]
@@ -597,6 +609,9 @@ module Google
597
609
  # @!attribute [rw] web_detection_params
598
610
  # @return [::Google::Cloud::Vision::V1::WebDetectionParams]
599
611
  # Parameters for web detection.
612
+ # @!attribute [rw] text_detection_params
613
+ # @return [::Google::Cloud::Vision::V1::TextDetectionParams]
614
+ # Parameters for text detection and document text detection.
600
615
  class ImageContext
601
616
  include ::Google::Protobuf::MessageExts
602
617
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -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:
@@ -57,10 +57,13 @@ module Google
57
57
  # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
- # any, err := ptypes.MarshalAny(foo)
60
+ # any, err := anypb.New(foo)
61
+ # if err != nil {
62
+ # ...
63
+ # }
61
64
  # ...
62
65
  # foo := &pb.Foo{}
63
- # if err := ptypes.UnmarshalAny(any, foo); err != nil {
66
+ # if err := any.UnmarshalTo(foo); err != nil {
64
67
  # ...
65
68
  # }
66
69
  #
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 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 Protobuf
22
+ # A Duration represents a signed, fixed-length span of time represented
23
+ # as a count of seconds and fractions of seconds at nanosecond
24
+ # resolution. It is independent of any calendar and concepts like "day"
25
+ # or "month". It is related to Timestamp in that the difference between
26
+ # two Timestamp values is a Duration and it can be added or subtracted
27
+ # from a Timestamp. Range is approximately +-10,000 years.
28
+ #
29
+ # # Examples
30
+ #
31
+ # Example 1: Compute Duration from two Timestamps in pseudo code.
32
+ #
33
+ # Timestamp start = ...;
34
+ # Timestamp end = ...;
35
+ # Duration duration = ...;
36
+ #
37
+ # duration.seconds = end.seconds - start.seconds;
38
+ # duration.nanos = end.nanos - start.nanos;
39
+ #
40
+ # if (duration.seconds < 0 && duration.nanos > 0) {
41
+ # duration.seconds += 1;
42
+ # duration.nanos -= 1000000000;
43
+ # } else if (duration.seconds > 0 && duration.nanos < 0) {
44
+ # duration.seconds -= 1;
45
+ # duration.nanos += 1000000000;
46
+ # }
47
+ #
48
+ # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
49
+ #
50
+ # Timestamp start = ...;
51
+ # Duration duration = ...;
52
+ # Timestamp end = ...;
53
+ #
54
+ # end.seconds = start.seconds + duration.seconds;
55
+ # end.nanos = start.nanos + duration.nanos;
56
+ #
57
+ # if (end.nanos < 0) {
58
+ # end.seconds -= 1;
59
+ # end.nanos += 1000000000;
60
+ # } else if (end.nanos >= 1000000000) {
61
+ # end.seconds += 1;
62
+ # end.nanos -= 1000000000;
63
+ # }
64
+ #
65
+ # Example 3: Compute Duration from datetime.timedelta in Python.
66
+ #
67
+ # td = datetime.timedelta(days=3, minutes=10)
68
+ # duration = Duration()
69
+ # duration.FromTimedelta(td)
70
+ #
71
+ # # JSON Mapping
72
+ #
73
+ # In JSON format, the Duration type is encoded as a string rather than an
74
+ # object, where the string ends in the suffix "s" (indicating seconds) and
75
+ # is preceded by the number of seconds, with nanoseconds expressed as
76
+ # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
77
+ # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
78
+ # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
79
+ # microsecond should be expressed in JSON format as "3.000001s".
80
+ # @!attribute [rw] seconds
81
+ # @return [::Integer]
82
+ # Signed seconds of the span of time. Must be from -315,576,000,000
83
+ # to +315,576,000,000 inclusive. Note: these bounds are computed from:
84
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
85
+ # @!attribute [rw] nanos
86
+ # @return [::Integer]
87
+ # Signed fractions of a second at nanosecond resolution of the span
88
+ # of time. Durations less than one second are represented with a 0
89
+ # `seconds` field and a positive or negative `nanos` field. For durations
90
+ # of one second or more, a non-zero value for the `nanos` field must be
91
+ # of the same sign as the `seconds` field. Must be from -999,999,999
92
+ # to +999,999,999 inclusive.
93
+ class Duration
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+ end
98
+ end
@@ -70,7 +70,16 @@ module Google
70
70
  # .setNanos((int) ((millis % 1000) * 1000000)).build();
71
71
  #
72
72
  #
73
- # Example 5: Compute Timestamp from current time in Python.
73
+ # Example 5: Compute Timestamp from Java `Instant.now()`.
74
+ #
75
+ # Instant now = Instant.now();
76
+ #
77
+ # Timestamp timestamp =
78
+ # Timestamp.newBuilder().setSeconds(now.getEpochSecond())
79
+ # .setNanos(now.getNano()).build();
80
+ #
81
+ #
82
+ # Example 6: Compute Timestamp from current time in Python.
74
83
  #
75
84
  # timestamp = Timestamp()
76
85
  # timestamp.GetCurrentTime()
@@ -19,8 +19,8 @@
19
19
 
20
20
  module Google
21
21
  module Type
22
- # An object representing a latitude/longitude pair. This is expressed as a pair
23
- # of doubles representing degrees latitude and degrees longitude. Unless
22
+ # An object that represents a latitude/longitude pair. This is expressed as a
23
+ # pair of doubles to represent degrees latitude and degrees longitude. Unless
24
24
  # specified otherwise, this must conform to the
25
25
  # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
26
26
  # standard</a>. Values must be within normalized ranges.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-vision-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.3
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-18 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '0.2'
19
+ version: '0.3'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '0.2'
26
+ version: '0.3'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: google-cloud-errors
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -152,7 +152,10 @@ dependencies:
152
152
  version: '0.9'
153
153
  description: Cloud Vision API allows developers to easily integrate vision detection
154
154
  features within applications, including image labeling, face and landmark detection,
155
- optical character recognition (OCR), and tagging of explicit content.
155
+ optical character recognition (OCR), and tagging of explicit content. Note that
156
+ google-cloud-vision-v1 is a version-specific client library. For most uses, we recommend
157
+ installing the main client library google-cloud-vision instead. See the readme for
158
+ more details.
156
159
  email: googleapis-packages@google.com
157
160
  executables: []
158
161
  extensions: []
@@ -195,6 +198,7 @@ files:
195
198
  - proto_docs/google/cloud/vision/v1/web_detection.rb
196
199
  - proto_docs/google/longrunning/operations.rb
197
200
  - proto_docs/google/protobuf/any.rb
201
+ - proto_docs/google/protobuf/duration.rb
198
202
  - proto_docs/google/protobuf/empty.rb
199
203
  - proto_docs/google/protobuf/field_mask.rb
200
204
  - proto_docs/google/protobuf/timestamp.rb
@@ -221,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
221
225
  - !ruby/object:Gem::Version
222
226
  version: '0'
223
227
  requirements: []
224
- rubygems_version: 3.1.3
228
+ rubygems_version: 3.2.6
225
229
  signing_key:
226
230
  specification_version: 4
227
231
  summary: API Client library for the Cloud Vision V1 API