google-cloud-vision-v1 0.2.4 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 29e8475592f0c146fa079cd9c3f127b66bd24f6d03bcf9d3836861acc988462d
4
- data.tar.gz: 8485da3780f43bc429dd7c859e8ff2364a4a45c934b42356d1b17bcc691243c9
3
+ metadata.gz: 81a8ee6d7b1cf6d7efb61a53051398441483b10e202b863f7b6e1c18578fbb35
4
+ data.tar.gz: 49a2b391342fe68630872b33168a4643a6f08692f2c323394f28cc36df14f31d
5
5
  SHA512:
6
- metadata.gz: 53b94793dec3f34e30860e837715fba9595eb2ac8012a134e4acfbb2108bba306248786561e93ac856734815a7cee177b586f66194137dba4da5cf63d8149043
7
- data.tar.gz: 8168999030c38305747e25dbaa8333dff6df278a5685f6a5bf78e8e9d734ba91b77acb8a1a244bf695bb3ae89bb70fdaf1e118700ba4294950e0b5f4e7996c32
6
+ metadata.gz: ee9717796884954c82be442725d912f6f1818cc1ff722f0dd4d14bb12cb743e037c4e5ae6ae43e371689a6bfc12003b00d4265557db889ef0ce8087532f26125
7
+ data.tar.gz: 7fdfb2d8618c2d5637a757719a479c6db3907b9aaca2b90c47f3297ae670eddeebc8b31bdf072f751b5c05a340a2c9015b82244d36c410b3dda9bf9ca90538af
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
@@ -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
@@ -288,8 +294,8 @@ module Google
288
294
  # the default parameter values, pass an empty Hash as a request object (see above).
289
295
  #
290
296
  # @param requests [::Array<::Google::Cloud::Vision::V1::AnnotateFileRequest, ::Hash>]
291
- # Required. The list of file annotation requests. Right now we support only one
292
- # AnnotateFileRequest in BatchAnnotateFilesRequest.
297
+ # Required. The list of file annotation requests. Right now we support only
298
+ # one AnnotateFileRequest in BatchAnnotateFilesRequest.
293
299
  # @param parent [::String]
294
300
  # Optional. Target project and location to make a call.
295
301
  #
@@ -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
@@ -103,6 +103,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
103
103
  value :CHIN_GNATHION, 32
104
104
  value :CHIN_LEFT_GONION, 33
105
105
  value :CHIN_RIGHT_GONION, 34
106
+ value :LEFT_CHEEK_CENTER, 35
107
+ value :RIGHT_CHEEK_CENTER, 36
106
108
  end
107
109
  add_message "google.cloud.vision.v1.LocationInfo" do
108
110
  optional :lat_lng, :message, 1, "google.type.LatLng"
@@ -172,12 +174,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
172
174
  add_message "google.cloud.vision.v1.WebDetectionParams" do
173
175
  optional :include_geo_results, :bool, 2
174
176
  end
177
+ add_message "google.cloud.vision.v1.TextDetectionParams" do
178
+ optional :enable_text_detection_confidence_score, :bool, 9
179
+ end
175
180
  add_message "google.cloud.vision.v1.ImageContext" do
176
181
  optional :lat_long_rect, :message, 1, "google.cloud.vision.v1.LatLongRect"
177
182
  repeated :language_hints, :string, 2
178
183
  optional :crop_hints_params, :message, 4, "google.cloud.vision.v1.CropHintsParams"
179
184
  optional :product_search_params, :message, 5, "google.cloud.vision.v1.ProductSearchParams"
180
185
  optional :web_detection_params, :message, 6, "google.cloud.vision.v1.WebDetectionParams"
186
+ optional :text_detection_params, :message, 12, "google.cloud.vision.v1.TextDetectionParams"
181
187
  end
182
188
  add_message "google.cloud.vision.v1.AnnotateImageRequest" do
183
189
  optional :image, :message, 1, "google.cloud.vision.v1.Image"
@@ -316,6 +322,7 @@ module Google
316
322
  CropHintsAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHintsAnnotation").msgclass
317
323
  CropHintsParams = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHintsParams").msgclass
318
324
  WebDetectionParams = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.WebDetectionParams").msgclass
325
+ TextDetectionParams = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.TextDetectionParams").msgclass
319
326
  ImageContext = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageContext").msgclass
320
327
  AnnotateImageRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AnnotateImageRequest").msgclass
321
328
  ImageAnnotationContext = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageAnnotationContext").msgclass
@@ -1,7 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # Source: google/cloud/vision/v1/image_annotator.proto for package 'google.cloud.vision.v1'
3
3
  # Original file comments:
4
- # Copyright 2019 Google LLC.
4
+ # Copyright 2020 Google LLC
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
15
15
  # See the License for the specific language governing permissions and
16
16
  # limitations under the License.
17
17
  #
18
- #
19
18
 
20
19
  require 'grpc'
21
20
  require 'google/cloud/vision/v1/image_annotator_pb'
@@ -37,7 +36,7 @@ module Google
37
36
  self.service_name = 'google.cloud.vision.v1.ImageAnnotator'
38
37
 
39
38
  # Run image detection and annotation for a batch of images.
40
- rpc :BatchAnnotateImages, Google::Cloud::Vision::V1::BatchAnnotateImagesRequest, Google::Cloud::Vision::V1::BatchAnnotateImagesResponse
39
+ rpc :BatchAnnotateImages, ::Google::Cloud::Vision::V1::BatchAnnotateImagesRequest, ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse
41
40
  # Service that performs image detection and annotation for a batch of files.
42
41
  # Now only "application/pdf", "image/tiff" and "image/gif" are supported.
43
42
  #
@@ -45,7 +44,7 @@ module Google
45
44
  # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each
46
45
  # file provided and perform detection and annotation for each image
47
46
  # extracted.
48
- rpc :BatchAnnotateFiles, Google::Cloud::Vision::V1::BatchAnnotateFilesRequest, Google::Cloud::Vision::V1::BatchAnnotateFilesResponse
47
+ rpc :BatchAnnotateFiles, ::Google::Cloud::Vision::V1::BatchAnnotateFilesRequest, ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse
49
48
  # Run asynchronous image detection and annotation for a list of images.
50
49
  #
51
50
  # Progress and results can be retrieved through the
@@ -55,14 +54,14 @@ module Google
55
54
  #
56
55
  # This service will write image annotation outputs to json files in customer
57
56
  # GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
58
- rpc :AsyncBatchAnnotateImages, Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest, Google::Longrunning::Operation
57
+ rpc :AsyncBatchAnnotateImages, ::Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest, ::Google::Longrunning::Operation
59
58
  # Run asynchronous image detection and annotation for a list of generic
60
59
  # files, such as PDF files, which may contain multiple pages and multiple
61
60
  # images per page. Progress and results can be retrieved through the
62
61
  # `google.longrunning.Operations` interface.
63
62
  # `Operation.metadata` contains `OperationMetadata` (metadata).
64
63
  # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
65
- rpc :AsyncBatchAnnotateFiles, Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest, Google::Longrunning::Operation
64
+ rpc :AsyncBatchAnnotateFiles, ::Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest, ::Google::Longrunning::Operation
66
65
  end
67
66
 
68
67
  Stub = Service.rpc_stub_class
@@ -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
@@ -505,7 +511,7 @@ module Google
505
511
  # Required. Resource name of the ProductSet to get.
506
512
  #
507
513
  # Format is:
508
- # `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID`
514
+ # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
509
515
  #
510
516
  # @yield [response, operation] Access the result along with the RPC operation
511
517
  # @yieldparam response [::Google::Cloud::Vision::V1::ProductSet]
@@ -1219,7 +1225,6 @@ module Google
1219
1225
  # Required. The resource name of the reference image to delete.
1220
1226
  #
1221
1227
  # Format is:
1222
- #
1223
1228
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`
1224
1229
  #
1225
1230
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1376,7 +1381,6 @@ module Google
1376
1381
  # Required. The resource name of the ReferenceImage to get.
1377
1382
  #
1378
1383
  # Format is:
1379
- #
1380
1384
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
1381
1385
  #
1382
1386
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1925,7 +1929,7 @@ module Google
1925
1929
 
1926
1930
  config_attr :endpoint, "vision.googleapis.com", ::String
1927
1931
  config_attr :credentials, nil do |value|
1928
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1932
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1929
1933
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
1930
1934
  allowed.any? { |klass| klass === value }
1931
1935
  end
@@ -1965,7 +1969,7 @@ module Google
1965
1969
  # Each configuration object is of type `Gapic::Config::Method` and includes
1966
1970
  # the following configuration fields:
1967
1971
  #
1968
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
1972
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
1969
1973
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
1970
1974
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
1971
1975
  # 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
@@ -3,11 +3,11 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
+ require 'google/api/resource_pb'
6
7
  require 'google/cloud/vision/v1/geometry_pb'
7
8
  require 'google/cloud/vision/v1/product_search_service_pb'
8
9
  require 'google/protobuf/timestamp_pb'
9
10
  require 'google/api/annotations_pb'
10
- require 'google/api/resource_pb'
11
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
12
12
  add_file("google/cloud/vision/v1/product_search.proto", :syntax => :proto3) do
13
13
  add_message "google.cloud.vision.v1.ProductSearchParams" do
@@ -1,7 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # Source: google/cloud/vision/v1/product_search_service.proto for package 'google.cloud.vision.v1'
3
3
  # Original file comments:
4
- # Copyright 2019 Google LLC.
4
+ # Copyright 2020 Google LLC
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
15
15
  # See the License for the specific language governing permissions and
16
16
  # limitations under the License.
17
17
  #
18
- #
19
18
 
20
19
  require 'grpc'
21
20
  require 'google/cloud/vision/v1/product_search_service_pb'
@@ -53,20 +52,20 @@ module Google
53
52
  #
54
53
  # * Returns INVALID_ARGUMENT if display_name is missing, or is longer than
55
54
  # 4096 characters.
56
- rpc :CreateProductSet, Google::Cloud::Vision::V1::CreateProductSetRequest, Google::Cloud::Vision::V1::ProductSet
55
+ rpc :CreateProductSet, ::Google::Cloud::Vision::V1::CreateProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
57
56
  # Lists ProductSets in an unspecified order.
58
57
  #
59
58
  # Possible errors:
60
59
  #
61
60
  # * Returns INVALID_ARGUMENT if page_size is greater than 100, or less
62
61
  # than 1.
63
- rpc :ListProductSets, Google::Cloud::Vision::V1::ListProductSetsRequest, Google::Cloud::Vision::V1::ListProductSetsResponse
62
+ rpc :ListProductSets, ::Google::Cloud::Vision::V1::ListProductSetsRequest, ::Google::Cloud::Vision::V1::ListProductSetsResponse
64
63
  # Gets information associated with a ProductSet.
65
64
  #
66
65
  # Possible errors:
67
66
  #
68
67
  # * Returns NOT_FOUND if the ProductSet does not exist.
69
- rpc :GetProductSet, Google::Cloud::Vision::V1::GetProductSetRequest, Google::Cloud::Vision::V1::ProductSet
68
+ rpc :GetProductSet, ::Google::Cloud::Vision::V1::GetProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
70
69
  # Makes changes to a ProductSet resource.
71
70
  # Only display_name can be updated currently.
72
71
  #
@@ -75,12 +74,12 @@ module Google
75
74
  # * Returns NOT_FOUND if the ProductSet does not exist.
76
75
  # * Returns INVALID_ARGUMENT if display_name is present in update_mask but
77
76
  # missing from the request or longer than 4096 characters.
78
- rpc :UpdateProductSet, Google::Cloud::Vision::V1::UpdateProductSetRequest, Google::Cloud::Vision::V1::ProductSet
77
+ rpc :UpdateProductSet, ::Google::Cloud::Vision::V1::UpdateProductSetRequest, ::Google::Cloud::Vision::V1::ProductSet
79
78
  # Permanently deletes a ProductSet. Products and ReferenceImages in the
80
79
  # ProductSet are not deleted.
81
80
  #
82
81
  # The actual image files are not deleted from Google Cloud Storage.
83
- rpc :DeleteProductSet, Google::Cloud::Vision::V1::DeleteProductSetRequest, Google::Protobuf::Empty
82
+ rpc :DeleteProductSet, ::Google::Cloud::Vision::V1::DeleteProductSetRequest, ::Google::Protobuf::Empty
84
83
  # Creates and returns a new product resource.
85
84
  #
86
85
  # Possible errors:
@@ -89,19 +88,19 @@ module Google
89
88
  # characters.
90
89
  # * Returns INVALID_ARGUMENT if description is longer than 4096 characters.
91
90
  # * Returns INVALID_ARGUMENT if product_category is missing or invalid.
92
- rpc :CreateProduct, Google::Cloud::Vision::V1::CreateProductRequest, Google::Cloud::Vision::V1::Product
91
+ rpc :CreateProduct, ::Google::Cloud::Vision::V1::CreateProductRequest, ::Google::Cloud::Vision::V1::Product
93
92
  # Lists products in an unspecified order.
94
93
  #
95
94
  # Possible errors:
96
95
  #
97
96
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
98
- rpc :ListProducts, Google::Cloud::Vision::V1::ListProductsRequest, Google::Cloud::Vision::V1::ListProductsResponse
97
+ rpc :ListProducts, ::Google::Cloud::Vision::V1::ListProductsRequest, ::Google::Cloud::Vision::V1::ListProductsResponse
99
98
  # Gets information associated with a Product.
100
99
  #
101
100
  # Possible errors:
102
101
  #
103
102
  # * Returns NOT_FOUND if the Product does not exist.
104
- rpc :GetProduct, Google::Cloud::Vision::V1::GetProductRequest, Google::Cloud::Vision::V1::Product
103
+ rpc :GetProduct, ::Google::Cloud::Vision::V1::GetProductRequest, ::Google::Cloud::Vision::V1::Product
105
104
  # Makes changes to a Product resource.
106
105
  # Only the `display_name`, `description`, and `labels` fields can be updated
107
106
  # right now.
@@ -117,13 +116,13 @@ module Google
117
116
  # * Returns INVALID_ARGUMENT if description is present in update_mask but is
118
117
  # longer than 4096 characters.
119
118
  # * Returns INVALID_ARGUMENT if product_category is present in update_mask.
120
- rpc :UpdateProduct, Google::Cloud::Vision::V1::UpdateProductRequest, Google::Cloud::Vision::V1::Product
119
+ rpc :UpdateProduct, ::Google::Cloud::Vision::V1::UpdateProductRequest, ::Google::Cloud::Vision::V1::Product
121
120
  # Permanently deletes a product and its reference images.
122
121
  #
123
122
  # Metadata of the product and all its images will be deleted right away, but
124
123
  # search queries against ProductSets containing the product may still work
125
124
  # until all related caches are refreshed.
126
- rpc :DeleteProduct, Google::Cloud::Vision::V1::DeleteProductRequest, Google::Protobuf::Empty
125
+ rpc :DeleteProduct, ::Google::Cloud::Vision::V1::DeleteProductRequest, ::Google::Protobuf::Empty
127
126
  # Creates and returns a new ReferenceImage resource.
128
127
  #
129
128
  # The `bounding_poly` field is optional. If `bounding_poly` is not specified,
@@ -143,7 +142,7 @@ module Google
143
142
  # * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
144
143
  # compatible with the parent product's product_category is detected.
145
144
  # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
146
- rpc :CreateReferenceImage, Google::Cloud::Vision::V1::CreateReferenceImageRequest, Google::Cloud::Vision::V1::ReferenceImage
145
+ rpc :CreateReferenceImage, ::Google::Cloud::Vision::V1::CreateReferenceImageRequest, ::Google::Cloud::Vision::V1::ReferenceImage
147
146
  # Permanently deletes a reference image.
148
147
  #
149
148
  # The image metadata will be deleted right away, but search queries
@@ -151,7 +150,7 @@ module Google
151
150
  # caches are refreshed.
152
151
  #
153
152
  # The actual image files are not deleted from Google Cloud Storage.
154
- rpc :DeleteReferenceImage, Google::Cloud::Vision::V1::DeleteReferenceImageRequest, Google::Protobuf::Empty
153
+ rpc :DeleteReferenceImage, ::Google::Cloud::Vision::V1::DeleteReferenceImageRequest, ::Google::Protobuf::Empty
155
154
  # Lists reference images.
156
155
  #
157
156
  # Possible errors:
@@ -159,13 +158,13 @@ module Google
159
158
  # * Returns NOT_FOUND if the parent product does not exist.
160
159
  # * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
161
160
  # than 1.
162
- rpc :ListReferenceImages, Google::Cloud::Vision::V1::ListReferenceImagesRequest, Google::Cloud::Vision::V1::ListReferenceImagesResponse
161
+ rpc :ListReferenceImages, ::Google::Cloud::Vision::V1::ListReferenceImagesRequest, ::Google::Cloud::Vision::V1::ListReferenceImagesResponse
163
162
  # Gets information associated with a ReferenceImage.
164
163
  #
165
164
  # Possible errors:
166
165
  #
167
166
  # * Returns NOT_FOUND if the specified image does not exist.
168
- rpc :GetReferenceImage, Google::Cloud::Vision::V1::GetReferenceImageRequest, Google::Cloud::Vision::V1::ReferenceImage
167
+ rpc :GetReferenceImage, ::Google::Cloud::Vision::V1::GetReferenceImageRequest, ::Google::Cloud::Vision::V1::ReferenceImage
169
168
  # Adds a Product to the specified ProductSet. If the Product is already
170
169
  # present, no change is made.
171
170
  #
@@ -174,9 +173,9 @@ module Google
174
173
  # Possible errors:
175
174
  #
176
175
  # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
177
- rpc :AddProductToProductSet, Google::Cloud::Vision::V1::AddProductToProductSetRequest, Google::Protobuf::Empty
176
+ rpc :AddProductToProductSet, ::Google::Cloud::Vision::V1::AddProductToProductSetRequest, ::Google::Protobuf::Empty
178
177
  # Removes a Product from the specified ProductSet.
179
- rpc :RemoveProductFromProductSet, Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest, Google::Protobuf::Empty
178
+ rpc :RemoveProductFromProductSet, ::Google::Cloud::Vision::V1::RemoveProductFromProductSetRequest, ::Google::Protobuf::Empty
180
179
  # Lists the Products in a ProductSet, in an unspecified order. If the
181
180
  # ProductSet does not exist, the products field of the response will be
182
181
  # empty.
@@ -184,7 +183,7 @@ module Google
184
183
  # Possible errors:
185
184
  #
186
185
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
187
- rpc :ListProductsInProductSet, Google::Cloud::Vision::V1::ListProductsInProductSetRequest, Google::Cloud::Vision::V1::ListProductsInProductSetResponse
186
+ rpc :ListProductsInProductSet, ::Google::Cloud::Vision::V1::ListProductsInProductSetRequest, ::Google::Cloud::Vision::V1::ListProductsInProductSetResponse
188
187
  # Asynchronous API that imports a list of reference images to specified
189
188
  # product sets based on a list of image information.
190
189
  #
@@ -196,7 +195,7 @@ module Google
196
195
  # The input source of this method is a csv file on Google Cloud Storage.
197
196
  # For the format of the csv file please see
198
197
  # [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri].
199
- rpc :ImportProductSets, Google::Cloud::Vision::V1::ImportProductSetsRequest, Google::Longrunning::Operation
198
+ rpc :ImportProductSets, ::Google::Cloud::Vision::V1::ImportProductSetsRequest, ::Google::Longrunning::Operation
200
199
  # Asynchronous API to delete all Products in a ProductSet or all Products
201
200
  # that are in no ProductSet.
202
201
  #
@@ -221,7 +220,7 @@ module Google
221
220
  # The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
222
221
  # progress and results of the request.
223
222
  # `Operation.metadata` contains `BatchOperationMetadata`. (progress)
224
- rpc :PurgeProducts, Google::Cloud::Vision::V1::PurgeProductsRequest, Google::Longrunning::Operation
223
+ rpc :PurgeProducts, ::Google::Cloud::Vision::V1::PurgeProductsRequest, ::Google::Longrunning::Operation
225
224
  end
226
225
 
227
226
  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.4"
24
+ VERSION = "0.5.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
@@ -127,6 +127,9 @@ module Google
127
127
  # Image content, represented as a stream of bytes.
128
128
  # Note: As with all `bytes` fields, protobuffers use a pure binary
129
129
  # representation, whereas JSON representations use base64.
130
+ #
131
+ # Currently, this field only works for BatchAnnotateImages requests. It does
132
+ # not work for AsyncBatchAnnotateImages requests.
130
133
  # @!attribute [rw] source
131
134
  # @return [::Google::Cloud::Vision::V1::ImageSource]
132
135
  # Google Cloud Storage image location, or publicly-accessible image
@@ -323,6 +326,12 @@ module Google
323
326
 
324
327
  # Chin right gonion.
325
328
  CHIN_RIGHT_GONION = 34
329
+
330
+ # Left cheek center.
331
+ LEFT_CHEEK_CENTER = 35
332
+
333
+ # Right cheek center.
334
+ RIGHT_CHEEK_CENTER = 36
326
335
  end
327
336
  end
328
337
  end
@@ -574,6 +583,18 @@ module Google
574
583
  extend ::Google::Protobuf::MessageExts::ClassMethods
575
584
  end
576
585
 
586
+ # Parameters for text detections. This is used to control TEXT_DETECTION and
587
+ # DOCUMENT_TEXT_DETECTION features.
588
+ # @!attribute [rw] enable_text_detection_confidence_score
589
+ # @return [::Boolean]
590
+ # By default, Cloud Vision API only includes confidence score for
591
+ # DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence
592
+ # score for TEXT_DETECTION as well.
593
+ class TextDetectionParams
594
+ include ::Google::Protobuf::MessageExts
595
+ extend ::Google::Protobuf::MessageExts::ClassMethods
596
+ end
597
+
577
598
  # Image context and/or feature-specific parameters.
578
599
  # @!attribute [rw] lat_long_rect
579
600
  # @return [::Google::Cloud::Vision::V1::LatLongRect]
@@ -597,6 +618,9 @@ module Google
597
618
  # @!attribute [rw] web_detection_params
598
619
  # @return [::Google::Cloud::Vision::V1::WebDetectionParams]
599
620
  # Parameters for web detection.
621
+ # @!attribute [rw] text_detection_params
622
+ # @return [::Google::Cloud::Vision::V1::TextDetectionParams]
623
+ # Parameters for text detection and document text detection.
600
624
  class ImageContext
601
625
  include ::Google::Protobuf::MessageExts
602
626
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -774,8 +798,8 @@ module Google
774
798
  # A list of requests to annotate files using the BatchAnnotateFiles API.
775
799
  # @!attribute [rw] requests
776
800
  # @return [::Array<::Google::Cloud::Vision::V1::AnnotateFileRequest>]
777
- # Required. The list of file annotation requests. Right now we support only one
778
- # AnnotateFileRequest in BatchAnnotateFilesRequest.
801
+ # Required. The list of file annotation requests. Right now we support only
802
+ # one AnnotateFileRequest in BatchAnnotateFilesRequest.
779
803
  # @!attribute [rw] parent
780
804
  # @return [::String]
781
805
  # Optional. Target project and location to make a call.
@@ -25,7 +25,7 @@ module Google
25
25
  # @!attribute [rw] bounding_poly
26
26
  # @return [::Google::Cloud::Vision::V1::BoundingPoly]
27
27
  # The bounding polygon around the area of interest in the image.
28
- # Optional. If it is not specified, system discretion will be applied.
28
+ # If it is not specified, system discretion will be applied.
29
29
  # @!attribute [rw] product_set
30
30
  # @return [::String]
31
31
  # The resource name of a {::Google::Cloud::Vision::V1::ProductSet ProductSet} to be searched for similar images.
@@ -41,9 +41,9 @@ module Google
41
41
  # @!attribute [rw] product_category
42
42
  # @return [::String]
43
43
  # Immutable. The category for the product identified by the reference image. This should
44
- # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
45
- # "homegoods", "apparel", and "toys" are still supported, but these should
46
- # not be used for new products.
44
+ # be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or
45
+ # "general-v1". The legacy categories "homegoods", "apparel", and "toys" are
46
+ # still supported, but these should not be used for new products.
47
47
  # @!attribute [rw] product_labels
48
48
  # @return [::Array<::Google::Cloud::Vision::V1::Product::KeyValue>]
49
49
  # Key-value pairs that can be attached to a product. At query time,
@@ -119,7 +119,6 @@ module Google
119
119
  # The resource name of the reference image.
120
120
  #
121
121
  # Format is:
122
- #
123
122
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
124
123
  #
125
124
  # This field is ignored when creating a reference image.
@@ -292,7 +291,7 @@ module Google
292
291
  # Required. Resource name of the ProductSet to get.
293
292
  #
294
293
  # Format is:
295
- # `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID`
294
+ # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
296
295
  class GetProductSetRequest
297
296
  include ::Google::Protobuf::MessageExts
298
297
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -389,7 +388,6 @@ module Google
389
388
  # Required. The resource name of the ReferenceImage to get.
390
389
  #
391
390
  # Format is:
392
- #
393
391
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
394
392
  class GetReferenceImageRequest
395
393
  include ::Google::Protobuf::MessageExts
@@ -402,7 +400,6 @@ module Google
402
400
  # Required. The resource name of the reference image to delete.
403
401
  #
404
402
  # Format is:
405
- #
406
403
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`
407
404
  class DeleteReferenceImageRequest
408
405
  include ::Google::Protobuf::MessageExts
@@ -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.4
4
+ version: 0.5.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-08-06 00:00:00.000000000 Z
11
+ date: 2021-02-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -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