google-cloud-vision-v1p3beta1 0.10.1 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (16) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/vision/v1p3beta1/image_annotator/client.rb +42 -9
  4. data/lib/google/cloud/vision/v1p3beta1/image_annotator/operations.rb +38 -7
  5. data/lib/google/cloud/vision/v1p3beta1/image_annotator/rest/client.rb +73 -7
  6. data/lib/google/cloud/vision/v1p3beta1/image_annotator/rest/operations.rb +108 -8
  7. data/lib/google/cloud/vision/v1p3beta1/image_annotator/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/vision/v1p3beta1/product_search/client.rb +42 -9
  9. data/lib/google/cloud/vision/v1p3beta1/product_search/operations.rb +38 -7
  10. data/lib/google/cloud/vision/v1p3beta1/product_search/rest/client.rb +345 -7
  11. data/lib/google/cloud/vision/v1p3beta1/product_search/rest/operations.rb +108 -8
  12. data/lib/google/cloud/vision/v1p3beta1/product_search/rest/service_stub.rb +14 -2
  13. data/lib/google/cloud/vision/v1p3beta1/version.rb +1 -1
  14. data/proto_docs/google/api/client.rb +14 -0
  15. data/proto_docs/google/api/field_behavior.rb +14 -0
  16. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '062897241eb7b3a013e6a423ef4264a84b8747e4e5e1132c609d9df0aab732c1'
4
- data.tar.gz: daafbd080b5ce3179e256079aa7724d12b897fab42f9f1ee7128426706fecf9a
3
+ metadata.gz: 8b56669ca0a96280eef7ec01098530178ec5fd6beb92b51de719487ceb976015
4
+ data.tar.gz: 3467adf061a4adf5a54ef010b018d2c19bc88fc1ad4fbe5d820aae0e72fc7245
5
5
  SHA512:
6
- metadata.gz: 0c7cba6481a4a5fe98fc1c04846ea3f70ded029901d615e2713fef7b148dd4b8c3059fc4af112f40b619abf794ad5743ed0c3755e11d3aec5439b1b291c4aaf9
7
- data.tar.gz: c95707ab16346bbaeeca57fe72851b71fa9b8c52aa84ef26fb09274431466253b3ab7151b269c52da166bfa828308cb35ff1b3d55c53e323242237c4e0b457bf
6
+ metadata.gz: ea3d6bc86e7d8b83ae82bb31121b97b0b6ffe3822e6078274ef68ea8060244a69d4ec46c89bbd8c9ad430e2cc56281ba49257175c5f5e56b5726940c3013fe62
7
+ data.tar.gz: 024b65422cba328440877b4b7242106241f66cf7dc950d4fa2a728fb025ba5e65114d4ee7c018de12349ad1fe909f624e0e57aa5e8541a63a95912631d15a0a9
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-vision-v1p3beta1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-vision-v1p3beta1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export VISION_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/vision/v1p3beta1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-vision-v1p3beta1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-vision-v1p3beta1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-vision-v1p3beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Vision::V1p3beta1::ProductSearch::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `VISION_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `VISION_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/vision/v1p3beta1"
77
-
78
- ENV["VISION_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
81
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
82
49
 
83
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/vision/v1p3beta1"
90
58
 
91
59
  client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/vision/v1p3beta1"
100
68
 
101
69
  ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-vision-v1p3beta1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/vision/v1p3beta1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-vision-v1p3beta1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/lib/google/cloud/vision/v1p3beta1/image_annotator/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # ImageAnnotator service returns detected entities from the images.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "vision.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -102,6 +105,15 @@ module Google
102
105
  @config
103
106
  end
104
107
 
108
+ ##
109
+ # The effective universe domain
110
+ #
111
+ # @return [String]
112
+ #
113
+ def universe_domain
114
+ @image_annotator_stub.universe_domain
115
+ end
116
+
105
117
  ##
106
118
  # Create a new ImageAnnotator client object.
107
119
  #
@@ -135,8 +147,9 @@ module Google
135
147
  credentials = @config.credentials
136
148
  # Use self-signed JWT if the endpoint is unchanged from default,
137
149
  # but only if the default endpoint does not have a region prefix.
138
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
139
- !@config.endpoint.split(".").first.include?("-")
150
+ enable_self_signed_jwt = @config.endpoint.nil? ||
151
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
152
+ !@config.endpoint.split(".").first.include?("-"))
140
153
  credentials ||= Credentials.default scope: @config.scope,
141
154
  enable_self_signed_jwt: enable_self_signed_jwt
142
155
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -149,14 +162,18 @@ module Google
149
162
  config.credentials = credentials
150
163
  config.quota_project = @quota_project_id
151
164
  config.endpoint = @config.endpoint
165
+ config.universe_domain = @config.universe_domain
152
166
  end
153
167
 
154
168
  @image_annotator_stub = ::Gapic::ServiceStub.new(
155
169
  ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Stub,
156
- credentials: credentials,
157
- endpoint: @config.endpoint,
170
+ credentials: credentials,
171
+ endpoint: @config.endpoint,
172
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
173
+ universe_domain: @config.universe_domain,
158
174
  channel_args: @config.channel_args,
159
- interceptors: @config.interceptors
175
+ interceptors: @config.interceptors,
176
+ channel_pool_config: @config.channel_pool
160
177
  )
161
178
  end
162
179
 
@@ -366,9 +383,9 @@ module Google
366
383
  # end
367
384
  #
368
385
  # @!attribute [rw] endpoint
369
- # The hostname or hostname:port of the service endpoint.
370
- # Defaults to `"vision.googleapis.com"`.
371
- # @return [::String]
386
+ # A custom service endpoint, as a hostname or hostname:port. The default is
387
+ # nil, indicating to use the default endpoint in the current universe domain.
388
+ # @return [::String,nil]
372
389
  # @!attribute [rw] credentials
373
390
  # Credentials to send with calls. You may provide any of the following types:
374
391
  # * (`String`) The path to a service account key file in JSON format
@@ -414,13 +431,20 @@ module Google
414
431
  # @!attribute [rw] quota_project
415
432
  # A separate project against which to charge quota.
416
433
  # @return [::String]
434
+ # @!attribute [rw] universe_domain
435
+ # The universe domain within which to make requests. This determines the
436
+ # default endpoint URL. The default value of nil uses the environment
437
+ # universe (usually the default "googleapis.com" universe).
438
+ # @return [::String,nil]
417
439
  #
418
440
  class Configuration
419
441
  extend ::Gapic::Config
420
442
 
443
+ # @private
444
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
421
445
  DEFAULT_ENDPOINT = "vision.googleapis.com"
422
446
 
423
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
447
+ config_attr :endpoint, nil, ::String, nil
424
448
  config_attr :credentials, nil do |value|
425
449
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
426
450
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -435,6 +459,7 @@ module Google
435
459
  config_attr :metadata, nil, ::Hash, nil
436
460
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
437
461
  config_attr :quota_project, nil, ::String, nil
462
+ config_attr :universe_domain, nil, ::String, nil
438
463
 
439
464
  # @private
440
465
  def initialize parent_config = nil
@@ -455,6 +480,14 @@ module Google
455
480
  end
456
481
  end
457
482
 
483
+ ##
484
+ # Configuration for the channel pool
485
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
486
+ #
487
+ def channel_pool
488
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
489
+ end
490
+
458
491
  ##
459
492
  # Configuration RPC class for the ImageAnnotator API.
460
493
  #
data/lib/google/cloud/vision/v1p3beta1/image_annotator/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module ImageAnnotator
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "vision.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,10 +102,13 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
- interceptors: @config.interceptors
110
+ interceptors: @config.interceptors,
111
+ channel_pool_config: @config.channel_pool
97
112
  )
98
113
 
99
114
  # Used by an LRO wrapper for some methods of this service
@@ -612,9 +627,9 @@ module Google
612
627
  # end
613
628
  #
614
629
  # @!attribute [rw] endpoint
615
- # The hostname or hostname:port of the service endpoint.
616
- # Defaults to `"vision.googleapis.com"`.
617
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
618
633
  # @!attribute [rw] credentials
619
634
  # Credentials to send with calls. You may provide any of the following types:
620
635
  # * (`String`) The path to a service account key file in JSON format
@@ -660,13 +675,20 @@ module Google
660
675
  # @!attribute [rw] quota_project
661
676
  # A separate project against which to charge quota.
662
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
663
683
  #
664
684
  class Configuration
665
685
  extend ::Gapic::Config
666
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
667
689
  DEFAULT_ENDPOINT = "vision.googleapis.com"
668
690
 
669
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
670
692
  config_attr :credentials, nil do |value|
671
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
672
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -681,6 +703,7 @@ module Google
681
703
  config_attr :metadata, nil, ::Hash, nil
682
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
683
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
684
707
 
685
708
  # @private
686
709
  def initialize parent_config = nil
@@ -701,6 +724,14 @@ module Google
701
724
  end
702
725
  end
703
726
 
727
+ ##
728
+ # Configuration for the channel pool
729
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
730
+ #
731
+ def channel_pool
732
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
733
+ end
734
+
704
735
  ##
705
736
  # Configuration RPC class for the Operations API.
706
737
  #
data/lib/google/cloud/vision/v1p3beta1/image_annotator/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # ImageAnnotator service returns detected entities from the images.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "vision.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -104,6 +107,15 @@ module Google
104
107
  @config
105
108
  end
106
109
 
110
+ ##
111
+ # The effective universe domain
112
+ #
113
+ # @return [String]
114
+ #
115
+ def universe_domain
116
+ @image_annotator_stub.universe_domain
117
+ end
118
+
107
119
  ##
108
120
  # Create a new ImageAnnotator REST client object.
109
121
  #
@@ -131,8 +143,9 @@ module Google
131
143
  credentials = @config.credentials
132
144
  # Use self-signed JWT if the endpoint is unchanged from default,
133
145
  # but only if the default endpoint does not have a region prefix.
134
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
135
- !@config.endpoint.split(".").first.include?("-")
146
+ enable_self_signed_jwt = @config.endpoint.nil? ||
147
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
148
+ !@config.endpoint.split(".").first.include?("-"))
136
149
  credentials ||= Credentials.default scope: @config.scope,
137
150
  enable_self_signed_jwt: enable_self_signed_jwt
138
151
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -146,9 +159,15 @@ module Google
146
159
  config.credentials = credentials
147
160
  config.quota_project = @quota_project_id
148
161
  config.endpoint = @config.endpoint
162
+ config.universe_domain = @config.universe_domain
149
163
  end
150
164
 
151
- @image_annotator_stub = ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
165
+ @image_annotator_stub = ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::ServiceStub.new(
166
+ endpoint: @config.endpoint,
167
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
168
+ universe_domain: @config.universe_domain,
169
+ credentials: credentials
170
+ )
152
171
  end
153
172
 
154
173
  ##
@@ -187,6 +206,22 @@ module Google
187
206
  # @return [::Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse]
188
207
  #
189
208
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
209
+ #
210
+ # @example Basic example
211
+ # require "google/cloud/vision/v1p3beta1"
212
+ #
213
+ # # Create a client object. The client can be reused for multiple calls.
214
+ # client = Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Client.new
215
+ #
216
+ # # Create a request. To set request fields, pass in keyword arguments.
217
+ # request = Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesRequest.new
218
+ #
219
+ # # Call the batch_annotate_images method.
220
+ # result = client.batch_annotate_images request
221
+ #
222
+ # # The returned object is of type Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse.
223
+ # p result
224
+ #
190
225
  def batch_annotate_images request, options = nil
191
226
  raise ::ArgumentError, "request must be provided" if request.nil?
192
227
 
@@ -254,6 +289,29 @@ module Google
254
289
  # @return [::Gapic::Operation]
255
290
  #
256
291
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
292
+ #
293
+ # @example Basic example
294
+ # require "google/cloud/vision/v1p3beta1"
295
+ #
296
+ # # Create a client object. The client can be reused for multiple calls.
297
+ # client = Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Client.new
298
+ #
299
+ # # Create a request. To set request fields, pass in keyword arguments.
300
+ # request = Google::Cloud::Vision::V1p3beta1::AsyncBatchAnnotateFilesRequest.new
301
+ #
302
+ # # Call the async_batch_annotate_files method.
303
+ # result = client.async_batch_annotate_files request
304
+ #
305
+ # # The returned object is of type Gapic::Operation. You can use it to
306
+ # # check the status of an operation, cancel it, or wait for results.
307
+ # # Here is how to wait for a response.
308
+ # result.wait_until_done! timeout: 60
309
+ # if result.response?
310
+ # p result.response
311
+ # else
312
+ # puts "No response received."
313
+ # end
314
+ #
257
315
  def async_batch_annotate_files request, options = nil
258
316
  raise ::ArgumentError, "request must be provided" if request.nil?
259
317
 
@@ -320,9 +378,9 @@ module Google
320
378
  # end
321
379
  #
322
380
  # @!attribute [rw] endpoint
323
- # The hostname or hostname:port of the service endpoint.
324
- # Defaults to `"vision.googleapis.com"`.
325
- # @return [::String]
381
+ # A custom service endpoint, as a hostname or hostname:port. The default is
382
+ # nil, indicating to use the default endpoint in the current universe domain.
383
+ # @return [::String,nil]
326
384
  # @!attribute [rw] credentials
327
385
  # Credentials to send with calls. You may provide any of the following types:
328
386
  # * (`String`) The path to a service account key file in JSON format
@@ -359,13 +417,20 @@ module Google
359
417
  # @!attribute [rw] quota_project
360
418
  # A separate project against which to charge quota.
361
419
  # @return [::String]
420
+ # @!attribute [rw] universe_domain
421
+ # The universe domain within which to make requests. This determines the
422
+ # default endpoint URL. The default value of nil uses the environment
423
+ # universe (usually the default "googleapis.com" universe).
424
+ # @return [::String,nil]
362
425
  #
363
426
  class Configuration
364
427
  extend ::Gapic::Config
365
428
 
429
+ # @private
430
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
366
431
  DEFAULT_ENDPOINT = "vision.googleapis.com"
367
432
 
368
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
433
+ config_attr :endpoint, nil, ::String, nil
369
434
  config_attr :credentials, nil do |value|
370
435
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
371
436
  allowed.any? { |klass| klass === value }
@@ -377,6 +442,7 @@ module Google
377
442
  config_attr :metadata, nil, ::Hash, nil
378
443
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
379
444
  config_attr :quota_project, nil, ::String, nil
445
+ config_attr :universe_domain, nil, ::String, nil
380
446
 
381
447
  # @private
382
448
  def initialize parent_config = nil