google-cloud-vision-v1p4beta1 0.5.1 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/vision/v1p4beta1/image_annotator/client.rb +42 -9
  4. data/lib/google/cloud/vision/v1p4beta1/image_annotator/operations.rb +38 -7
  5. data/lib/google/cloud/vision/v1p4beta1/image_annotator/rest/client.rb +112 -7
  6. data/lib/google/cloud/vision/v1p4beta1/image_annotator/rest/operations.rb +108 -8
  7. data/lib/google/cloud/vision/v1p4beta1/image_annotator/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/vision/v1p4beta1/product_search/client.rb +42 -9
  9. data/lib/google/cloud/vision/v1p4beta1/product_search/operations.rb +38 -7
  10. data/lib/google/cloud/vision/v1p4beta1/product_search/rest/client.rb +368 -7
  11. data/lib/google/cloud/vision/v1p4beta1/product_search/rest/operations.rb +108 -8
  12. data/lib/google/cloud/vision/v1p4beta1/product_search/rest/service_stub.rb +14 -2
  13. data/lib/google/cloud/vision/v1p4beta1/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. data/proto_docs/google/cloud/vision/v1p4beta1/image_annotator.rb +1 -0
  17. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f370201a606248d43c548d7441897b825425c66a825b2a03f5e95a1fd5a2946d
4
- data.tar.gz: f7ef13de6359d5cd23501df29f496b99ecb7b017c977313fa31423cb9d8cbd0b
3
+ metadata.gz: 6075813be25817fa0ee92d5938d37ca1a9e1b965916c5af6c93973d3a819727c
4
+ data.tar.gz: 64c269cdd9a2c2ae29779793e88cf6071d5834f1dacd450987f9e7a2fc109958
5
5
  SHA512:
6
- metadata.gz: 14a4aee95422ded5162fe879e8a3f35175f67e9842bcb492367ffcd3d428f4689d093ad854d1b050147e36f15ed9d4d336a2a391fe3553b117221439b2034825
7
- data.tar.gz: bbc2fae0ee89bfafb9f3467351a648cda07bd66bb281453a8845364d21c7c584fac1a62be032471bd1908bbf395f966ad379eef1a7345b24a7262aea8ccfcb94
6
+ metadata.gz: a8899e74b9588da09058188f59845de1db1f9e5aa8a2f8509eaa4b54e7b04eb802f53ffbc6b225207e2e12abd37986be7ad405aa9d4e4ac39134ceeea796cd06
7
+ data.tar.gz: 1cff650df21f75ba1a4794cc44e4491697ea5a2f0a5d2d2b11a675e8a65bebe17a50fa59a70c3f45ad1e1318aa0f853795f130f1a52f21e503ae0cb0fbfeff68
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-vision-v1p4beta1 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-v1p4beta1 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/v1p4beta1"
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::V1p4beta1::ProductSearch::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-vision-v1p4beta1 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-v1p4beta1 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-v1p4beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Vision::V1p4beta1::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/v1p4beta1"
77
-
78
- ENV["VISION_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Vision::V1p4beta1::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/v1p4beta1"
90
58
 
91
59
  client = ::Google::Cloud::Vision::V1p4beta1::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/v1p4beta1"
100
68
 
101
69
  ::Google::Cloud::Vision::V1p4beta1::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::V1p4beta1::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-v1p4beta1
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/v1p4beta1"
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-v1p4beta1.
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::V1p4beta1::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/v1p4beta1/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
@@ -112,6 +115,15 @@ module Google
112
115
  @config
113
116
  end
114
117
 
118
+ ##
119
+ # The effective universe domain
120
+ #
121
+ # @return [String]
122
+ #
123
+ def universe_domain
124
+ @image_annotator_stub.universe_domain
125
+ end
126
+
115
127
  ##
116
128
  # Create a new ImageAnnotator client object.
117
129
  #
@@ -145,8 +157,9 @@ module Google
145
157
  credentials = @config.credentials
146
158
  # Use self-signed JWT if the endpoint is unchanged from default,
147
159
  # but only if the default endpoint does not have a region prefix.
148
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
149
- !@config.endpoint.split(".").first.include?("-")
160
+ enable_self_signed_jwt = @config.endpoint.nil? ||
161
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
162
+ !@config.endpoint.split(".").first.include?("-"))
150
163
  credentials ||= Credentials.default scope: @config.scope,
151
164
  enable_self_signed_jwt: enable_self_signed_jwt
152
165
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -159,14 +172,18 @@ module Google
159
172
  config.credentials = credentials
160
173
  config.quota_project = @quota_project_id
161
174
  config.endpoint = @config.endpoint
175
+ config.universe_domain = @config.universe_domain
162
176
  end
163
177
 
164
178
  @image_annotator_stub = ::Gapic::ServiceStub.new(
165
179
  ::Google::Cloud::Vision::V1p4beta1::ImageAnnotator::Stub,
166
- credentials: credentials,
167
- endpoint: @config.endpoint,
180
+ credentials: credentials,
181
+ endpoint: @config.endpoint,
182
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
183
+ universe_domain: @config.universe_domain,
168
184
  channel_args: @config.channel_args,
169
- interceptors: @config.interceptors
185
+ interceptors: @config.interceptors,
186
+ channel_pool_config: @config.channel_pool
170
187
  )
171
188
  end
172
189
 
@@ -555,9 +572,9 @@ module Google
555
572
  # end
556
573
  #
557
574
  # @!attribute [rw] endpoint
558
- # The hostname or hostname:port of the service endpoint.
559
- # Defaults to `"vision.googleapis.com"`.
560
- # @return [::String]
575
+ # A custom service endpoint, as a hostname or hostname:port. The default is
576
+ # nil, indicating to use the default endpoint in the current universe domain.
577
+ # @return [::String,nil]
561
578
  # @!attribute [rw] credentials
562
579
  # Credentials to send with calls. You may provide any of the following types:
563
580
  # * (`String`) The path to a service account key file in JSON format
@@ -603,13 +620,20 @@ module Google
603
620
  # @!attribute [rw] quota_project
604
621
  # A separate project against which to charge quota.
605
622
  # @return [::String]
623
+ # @!attribute [rw] universe_domain
624
+ # The universe domain within which to make requests. This determines the
625
+ # default endpoint URL. The default value of nil uses the environment
626
+ # universe (usually the default "googleapis.com" universe).
627
+ # @return [::String,nil]
606
628
  #
607
629
  class Configuration
608
630
  extend ::Gapic::Config
609
631
 
632
+ # @private
633
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
610
634
  DEFAULT_ENDPOINT = "vision.googleapis.com"
611
635
 
612
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
636
+ config_attr :endpoint, nil, ::String, nil
613
637
  config_attr :credentials, nil do |value|
614
638
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
615
639
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -624,6 +648,7 @@ module Google
624
648
  config_attr :metadata, nil, ::Hash, nil
625
649
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
626
650
  config_attr :quota_project, nil, ::String, nil
651
+ config_attr :universe_domain, nil, ::String, nil
627
652
 
628
653
  # @private
629
654
  def initialize parent_config = nil
@@ -644,6 +669,14 @@ module Google
644
669
  end
645
670
  end
646
671
 
672
+ ##
673
+ # Configuration for the channel pool
674
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
675
+ #
676
+ def channel_pool
677
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
678
+ end
679
+
647
680
  ##
648
681
  # Configuration RPC class for the ImageAnnotator API.
649
682
  #
data/lib/google/cloud/vision/v1p4beta1/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/v1p4beta1/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
@@ -114,6 +117,15 @@ module Google
114
117
  @config
115
118
  end
116
119
 
120
+ ##
121
+ # The effective universe domain
122
+ #
123
+ # @return [String]
124
+ #
125
+ def universe_domain
126
+ @image_annotator_stub.universe_domain
127
+ end
128
+
117
129
  ##
118
130
  # Create a new ImageAnnotator REST client object.
119
131
  #
@@ -141,8 +153,9 @@ module Google
141
153
  credentials = @config.credentials
142
154
  # Use self-signed JWT if the endpoint is unchanged from default,
143
155
  # but only if the default endpoint does not have a region prefix.
144
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
145
- !@config.endpoint.split(".").first.include?("-")
156
+ enable_self_signed_jwt = @config.endpoint.nil? ||
157
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
158
+ !@config.endpoint.split(".").first.include?("-"))
146
159
  credentials ||= Credentials.default scope: @config.scope,
147
160
  enable_self_signed_jwt: enable_self_signed_jwt
148
161
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -156,9 +169,15 @@ module Google
156
169
  config.credentials = credentials
157
170
  config.quota_project = @quota_project_id
158
171
  config.endpoint = @config.endpoint
172
+ config.universe_domain = @config.universe_domain
159
173
  end
160
174
 
161
- @image_annotator_stub = ::Google::Cloud::Vision::V1p4beta1::ImageAnnotator::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
175
+ @image_annotator_stub = ::Google::Cloud::Vision::V1p4beta1::ImageAnnotator::Rest::ServiceStub.new(
176
+ endpoint: @config.endpoint,
177
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
+ universe_domain: @config.universe_domain,
179
+ credentials: credentials
180
+ )
162
181
  end
163
182
 
164
183
  ##
@@ -197,6 +216,22 @@ module Google
197
216
  # @return [::Google::Cloud::Vision::V1p4beta1::BatchAnnotateImagesResponse]
198
217
  #
199
218
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
219
+ #
220
+ # @example Basic example
221
+ # require "google/cloud/vision/v1p4beta1"
222
+ #
223
+ # # Create a client object. The client can be reused for multiple calls.
224
+ # client = Google::Cloud::Vision::V1p4beta1::ImageAnnotator::Rest::Client.new
225
+ #
226
+ # # Create a request. To set request fields, pass in keyword arguments.
227
+ # request = Google::Cloud::Vision::V1p4beta1::BatchAnnotateImagesRequest.new
228
+ #
229
+ # # Call the batch_annotate_images method.
230
+ # result = client.batch_annotate_images request
231
+ #
232
+ # # The returned object is of type Google::Cloud::Vision::V1p4beta1::BatchAnnotateImagesResponse.
233
+ # p result
234
+ #
200
235
  def batch_annotate_images request, options = nil
201
236
  raise ::ArgumentError, "request must be provided" if request.nil?
202
237
 
@@ -266,6 +301,22 @@ module Google
266
301
  # @return [::Google::Cloud::Vision::V1p4beta1::BatchAnnotateFilesResponse]
267
302
  #
268
303
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
304
+ #
305
+ # @example Basic example
306
+ # require "google/cloud/vision/v1p4beta1"
307
+ #
308
+ # # Create a client object. The client can be reused for multiple calls.
309
+ # client = Google::Cloud::Vision::V1p4beta1::ImageAnnotator::Rest::Client.new
310
+ #
311
+ # # Create a request. To set request fields, pass in keyword arguments.
312
+ # request = Google::Cloud::Vision::V1p4beta1::BatchAnnotateFilesRequest.new
313
+ #
314
+ # # Call the batch_annotate_files method.
315
+ # result = client.batch_annotate_files request
316
+ #
317
+ # # The returned object is of type Google::Cloud::Vision::V1p4beta1::BatchAnnotateFilesResponse.
318
+ # p result
319
+ #
269
320
  def batch_annotate_files request, options = nil
270
321
  raise ::ArgumentError, "request must be provided" if request.nil?
271
322
 
@@ -338,6 +389,29 @@ module Google
338
389
  # @return [::Gapic::Operation]
339
390
  #
340
391
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
392
+ #
393
+ # @example Basic example
394
+ # require "google/cloud/vision/v1p4beta1"
395
+ #
396
+ # # Create a client object. The client can be reused for multiple calls.
397
+ # client = Google::Cloud::Vision::V1p4beta1::ImageAnnotator::Rest::Client.new
398
+ #
399
+ # # Create a request. To set request fields, pass in keyword arguments.
400
+ # request = Google::Cloud::Vision::V1p4beta1::AsyncBatchAnnotateImagesRequest.new
401
+ #
402
+ # # Call the async_batch_annotate_images method.
403
+ # result = client.async_batch_annotate_images request
404
+ #
405
+ # # The returned object is of type Gapic::Operation. You can use it to
406
+ # # check the status of an operation, cancel it, or wait for results.
407
+ # # Here is how to wait for a response.
408
+ # result.wait_until_done! timeout: 60
409
+ # if result.response?
410
+ # p result.response
411
+ # else
412
+ # puts "No response received."
413
+ # end
414
+ #
341
415
  def async_batch_annotate_images request, options = nil
342
416
  raise ::ArgumentError, "request must be provided" if request.nil?
343
417
 
@@ -406,6 +480,29 @@ module Google
406
480
  # @return [::Gapic::Operation]
407
481
  #
408
482
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
483
+ #
484
+ # @example Basic example
485
+ # require "google/cloud/vision/v1p4beta1"
486
+ #
487
+ # # Create a client object. The client can be reused for multiple calls.
488
+ # client = Google::Cloud::Vision::V1p4beta1::ImageAnnotator::Rest::Client.new
489
+ #
490
+ # # Create a request. To set request fields, pass in keyword arguments.
491
+ # request = Google::Cloud::Vision::V1p4beta1::AsyncBatchAnnotateFilesRequest.new
492
+ #
493
+ # # Call the async_batch_annotate_files method.
494
+ # result = client.async_batch_annotate_files request
495
+ #
496
+ # # The returned object is of type Gapic::Operation. You can use it to
497
+ # # check the status of an operation, cancel it, or wait for results.
498
+ # # Here is how to wait for a response.
499
+ # result.wait_until_done! timeout: 60
500
+ # if result.response?
501
+ # p result.response
502
+ # else
503
+ # puts "No response received."
504
+ # end
505
+ #
409
506
  def async_batch_annotate_files request, options = nil
410
507
  raise ::ArgumentError, "request must be provided" if request.nil?
411
508
 
@@ -472,9 +569,9 @@ module Google
472
569
  # end
473
570
  #
474
571
  # @!attribute [rw] endpoint
475
- # The hostname or hostname:port of the service endpoint.
476
- # Defaults to `"vision.googleapis.com"`.
477
- # @return [::String]
572
+ # A custom service endpoint, as a hostname or hostname:port. The default is
573
+ # nil, indicating to use the default endpoint in the current universe domain.
574
+ # @return [::String,nil]
478
575
  # @!attribute [rw] credentials
479
576
  # Credentials to send with calls. You may provide any of the following types:
480
577
  # * (`String`) The path to a service account key file in JSON format
@@ -511,13 +608,20 @@ module Google
511
608
  # @!attribute [rw] quota_project
512
609
  # A separate project against which to charge quota.
513
610
  # @return [::String]
611
+ # @!attribute [rw] universe_domain
612
+ # The universe domain within which to make requests. This determines the
613
+ # default endpoint URL. The default value of nil uses the environment
614
+ # universe (usually the default "googleapis.com" universe).
615
+ # @return [::String,nil]
514
616
  #
515
617
  class Configuration
516
618
  extend ::Gapic::Config
517
619
 
620
+ # @private
621
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
518
622
  DEFAULT_ENDPOINT = "vision.googleapis.com"
519
623
 
520
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
624
+ config_attr :endpoint, nil, ::String, nil
521
625
  config_attr :credentials, nil do |value|
522
626
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
523
627
  allowed.any? { |klass| klass === value }
@@ -529,6 +633,7 @@ module Google
529
633
  config_attr :metadata, nil, ::Hash, nil
530
634
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
531
635
  config_attr :quota_project, nil, ::String, nil
636
+ config_attr :universe_domain, nil, ::String, nil
532
637
 
533
638
  # @private
534
639
  def initialize parent_config = nil