google-cloud-speech-v1p1beta1 0.19.0 → 0.20.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: ec2b958f9d54ff0bdda5f4573a525eb00428e3da9d85979cfcf7ed2344eb6784
4
- data.tar.gz: 894fb9c68b3f0ee9cbf2a5ca119943dfc433d9a24067ba56c662c4d1fe093481
3
+ metadata.gz: db3db855383a8eb4ea6cc4c138036234dd04f4cf1f5c8e9f31f24e0231534cc0
4
+ data.tar.gz: 5768b8051af65491f1086ea78ab84bcc6115ee130a2dc2018b99cce3ca4fffd6
5
5
  SHA512:
6
- metadata.gz: 44043d180200363d6d224350ea930f7189dffb3635cd252073375e5ac896b3f3d0283c5fcdab3977514007d345165b8ade35fabac3da1f27e19290ddaa84f812
7
- data.tar.gz: 4dafc2ea75e5313b4a5dda3f9fd0ed17badf1d56f2df421569cb5110c76c5db5e7ec62af88a43b19ec75a8e5583474213880f8d2e49e3c9eb2cf53b776f13343
6
+ metadata.gz: aba3dc19c80c9c7ced8550811c084e0889531c78df6ab2a789dd6e60e31e712d0c7825bb1d7476a58002c1775ba75668ecefc3d78f16ebee0da42788549a7694
7
+ data.tar.gz: '072825692f26189cf0337caf032d85db7f8ae3aa95db325db10cf12ef3f9f576ca35f3ab88e3be5e948acfc7885d59b5b1de15a5d6a4e2621ea9774f1128be59'
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-speech-v1p1beta1 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-speech-v1p1beta1 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 SPEECH_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/speech/v1p1beta1"
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::Speech::V1p1beta1::Speech::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-speech-v1p1beta1 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-speech-v1p1beta1 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-speech-v1p1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Speech::V1p1beta1::Speech::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `SPEECH_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `SPEECH_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/speech/v1p1beta1"
77
-
78
- ENV["SPEECH_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Speech::V1p1beta1::Speech::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/speech/v1p1beta1"
90
58
 
91
59
  client = ::Google::Cloud::Speech::V1p1beta1::Speech::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/speech/v1p1beta1"
100
68
 
101
69
  ::Google::Cloud::Speech::V1p1beta1::Speech::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::Speech::V1p1beta1::Speech::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-speech-v1p1beta1
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/speech/v1p1beta1"
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-speech-v1p1beta1.
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::Speech::V1p1beta1::Speech::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).
@@ -30,6 +30,9 @@ module Google
30
30
  # Service that implements Google Cloud Speech Adaptation API.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "speech.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -90,6 +93,15 @@ module Google
90
93
  @config
91
94
  end
92
95
 
96
+ ##
97
+ # The effective universe domain
98
+ #
99
+ # @return [String]
100
+ #
101
+ def universe_domain
102
+ @adaptation_stub.universe_domain
103
+ end
104
+
93
105
  ##
94
106
  # Create a new Adaptation client object.
95
107
  #
@@ -123,8 +135,9 @@ module Google
123
135
  credentials = @config.credentials
124
136
  # Use self-signed JWT if the endpoint is unchanged from default,
125
137
  # but only if the default endpoint does not have a region prefix.
126
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
127
- !@config.endpoint.split(".").first.include?("-")
138
+ enable_self_signed_jwt = @config.endpoint.nil? ||
139
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
+ !@config.endpoint.split(".").first.include?("-"))
128
141
  credentials ||= Credentials.default scope: @config.scope,
129
142
  enable_self_signed_jwt: enable_self_signed_jwt
130
143
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -135,8 +148,10 @@ module Google
135
148
 
136
149
  @adaptation_stub = ::Gapic::ServiceStub.new(
137
150
  ::Google::Cloud::Speech::V1p1beta1::Adaptation::Stub,
138
- credentials: credentials,
139
- endpoint: @config.endpoint,
151
+ credentials: credentials,
152
+ endpoint: @config.endpoint,
153
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
154
+ universe_domain: @config.universe_domain,
140
155
  channel_args: @config.channel_args,
141
156
  interceptors: @config.interceptors,
142
157
  channel_pool_config: @config.channel_pool
@@ -1155,9 +1170,9 @@ module Google
1155
1170
  # end
1156
1171
  #
1157
1172
  # @!attribute [rw] endpoint
1158
- # The hostname or hostname:port of the service endpoint.
1159
- # Defaults to `"speech.googleapis.com"`.
1160
- # @return [::String]
1173
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1174
+ # nil, indicating to use the default endpoint in the current universe domain.
1175
+ # @return [::String,nil]
1161
1176
  # @!attribute [rw] credentials
1162
1177
  # Credentials to send with calls. You may provide any of the following types:
1163
1178
  # * (`String`) The path to a service account key file in JSON format
@@ -1203,13 +1218,20 @@ module Google
1203
1218
  # @!attribute [rw] quota_project
1204
1219
  # A separate project against which to charge quota.
1205
1220
  # @return [::String]
1221
+ # @!attribute [rw] universe_domain
1222
+ # The universe domain within which to make requests. This determines the
1223
+ # default endpoint URL. The default value of nil uses the environment
1224
+ # universe (usually the default "googleapis.com" universe).
1225
+ # @return [::String,nil]
1206
1226
  #
1207
1227
  class Configuration
1208
1228
  extend ::Gapic::Config
1209
1229
 
1230
+ # @private
1231
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1210
1232
  DEFAULT_ENDPOINT = "speech.googleapis.com"
1211
1233
 
1212
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1234
+ config_attr :endpoint, nil, ::String, nil
1213
1235
  config_attr :credentials, nil do |value|
1214
1236
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1215
1237
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1224,6 +1246,7 @@ module Google
1224
1246
  config_attr :metadata, nil, ::Hash, nil
1225
1247
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1226
1248
  config_attr :quota_project, nil, ::String, nil
1249
+ config_attr :universe_domain, nil, ::String, nil
1227
1250
 
1228
1251
  # @private
1229
1252
  def initialize parent_config = nil
@@ -32,6 +32,9 @@ module Google
32
32
  # Service that implements Google Cloud Speech Adaptation API.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "speech.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -92,6 +95,15 @@ module Google
92
95
  @config
93
96
  end
94
97
 
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @adaptation_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new Adaptation REST client object.
97
109
  #
@@ -119,8 +131,9 @@ module Google
119
131
  credentials = @config.credentials
120
132
  # Use self-signed JWT if the endpoint is unchanged from default,
121
133
  # but only if the default endpoint does not have a region prefix.
122
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
123
- !@config.endpoint.split(".").first.include?("-")
134
+ enable_self_signed_jwt = @config.endpoint.nil? ||
135
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
136
+ !@config.endpoint.split(".").first.include?("-"))
124
137
  credentials ||= Credentials.default scope: @config.scope,
125
138
  enable_self_signed_jwt: enable_self_signed_jwt
126
139
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -130,7 +143,12 @@ module Google
130
143
  @quota_project_id = @config.quota_project
131
144
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
132
145
 
133
- @adaptation_stub = ::Google::Cloud::Speech::V1p1beta1::Adaptation::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
146
+ @adaptation_stub = ::Google::Cloud::Speech::V1p1beta1::Adaptation::Rest::ServiceStub.new(
147
+ endpoint: @config.endpoint,
148
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
149
+ universe_domain: @config.universe_domain,
150
+ credentials: credentials
151
+ )
134
152
  end
135
153
 
136
154
  # Service calls
@@ -1075,9 +1093,9 @@ module Google
1075
1093
  # end
1076
1094
  #
1077
1095
  # @!attribute [rw] endpoint
1078
- # The hostname or hostname:port of the service endpoint.
1079
- # Defaults to `"speech.googleapis.com"`.
1080
- # @return [::String]
1096
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1097
+ # nil, indicating to use the default endpoint in the current universe domain.
1098
+ # @return [::String,nil]
1081
1099
  # @!attribute [rw] credentials
1082
1100
  # Credentials to send with calls. You may provide any of the following types:
1083
1101
  # * (`String`) The path to a service account key file in JSON format
@@ -1114,13 +1132,20 @@ module Google
1114
1132
  # @!attribute [rw] quota_project
1115
1133
  # A separate project against which to charge quota.
1116
1134
  # @return [::String]
1135
+ # @!attribute [rw] universe_domain
1136
+ # The universe domain within which to make requests. This determines the
1137
+ # default endpoint URL. The default value of nil uses the environment
1138
+ # universe (usually the default "googleapis.com" universe).
1139
+ # @return [::String,nil]
1117
1140
  #
1118
1141
  class Configuration
1119
1142
  extend ::Gapic::Config
1120
1143
 
1144
+ # @private
1145
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1121
1146
  DEFAULT_ENDPOINT = "speech.googleapis.com"
1122
1147
 
1123
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1148
+ config_attr :endpoint, nil, ::String, nil
1124
1149
  config_attr :credentials, nil do |value|
1125
1150
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1126
1151
  allowed.any? { |klass| klass === value }
@@ -1132,6 +1157,7 @@ module Google
1132
1157
  config_attr :metadata, nil, ::Hash, nil
1133
1158
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1134
1159
  config_attr :quota_project, nil, ::String, nil
1160
+ config_attr :universe_domain, nil, ::String, nil
1135
1161
 
1136
1162
  # @private
1137
1163
  def initialize parent_config = nil
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the create_phrase_set REST call
45
57
  #
@@ -30,6 +30,9 @@ module Google
30
30
  # Service that implements Google Cloud Speech API.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "speech.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @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
+ @speech_stub.universe_domain
115
+ end
116
+
105
117
  ##
106
118
  # Create a new Speech 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,12 +162,15 @@ 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
  @speech_stub = ::Gapic::ServiceStub.new(
155
169
  ::Google::Cloud::Speech::V1p1beta1::Speech::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
175
  interceptors: @config.interceptors,
160
176
  channel_pool_config: @config.channel_pool
@@ -455,9 +471,9 @@ module Google
455
471
  # end
456
472
  #
457
473
  # @!attribute [rw] endpoint
458
- # The hostname or hostname:port of the service endpoint.
459
- # Defaults to `"speech.googleapis.com"`.
460
- # @return [::String]
474
+ # A custom service endpoint, as a hostname or hostname:port. The default is
475
+ # nil, indicating to use the default endpoint in the current universe domain.
476
+ # @return [::String,nil]
461
477
  # @!attribute [rw] credentials
462
478
  # Credentials to send with calls. You may provide any of the following types:
463
479
  # * (`String`) The path to a service account key file in JSON format
@@ -503,13 +519,20 @@ module Google
503
519
  # @!attribute [rw] quota_project
504
520
  # A separate project against which to charge quota.
505
521
  # @return [::String]
522
+ # @!attribute [rw] universe_domain
523
+ # The universe domain within which to make requests. This determines the
524
+ # default endpoint URL. The default value of nil uses the environment
525
+ # universe (usually the default "googleapis.com" universe).
526
+ # @return [::String,nil]
506
527
  #
507
528
  class Configuration
508
529
  extend ::Gapic::Config
509
530
 
531
+ # @private
532
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
510
533
  DEFAULT_ENDPOINT = "speech.googleapis.com"
511
534
 
512
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
535
+ config_attr :endpoint, nil, ::String, nil
513
536
  config_attr :credentials, nil do |value|
514
537
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
515
538
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -524,6 +547,7 @@ module Google
524
547
  config_attr :metadata, nil, ::Hash, nil
525
548
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
526
549
  config_attr :quota_project, nil, ::String, nil
550
+ config_attr :universe_domain, nil, ::String, nil
527
551
 
528
552
  # @private
529
553
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module Speech
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "speech.$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,8 +102,10 @@ 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
110
  interceptors: @config.interceptors,
97
111
  channel_pool_config: @config.channel_pool
@@ -605,9 +619,9 @@ module Google
605
619
  # end
606
620
  #
607
621
  # @!attribute [rw] endpoint
608
- # The hostname or hostname:port of the service endpoint.
609
- # Defaults to `"speech.googleapis.com"`.
610
- # @return [::String]
622
+ # A custom service endpoint, as a hostname or hostname:port. The default is
623
+ # nil, indicating to use the default endpoint in the current universe domain.
624
+ # @return [::String,nil]
611
625
  # @!attribute [rw] credentials
612
626
  # Credentials to send with calls. You may provide any of the following types:
613
627
  # * (`String`) The path to a service account key file in JSON format
@@ -653,13 +667,20 @@ module Google
653
667
  # @!attribute [rw] quota_project
654
668
  # A separate project against which to charge quota.
655
669
  # @return [::String]
670
+ # @!attribute [rw] universe_domain
671
+ # The universe domain within which to make requests. This determines the
672
+ # default endpoint URL. The default value of nil uses the environment
673
+ # universe (usually the default "googleapis.com" universe).
674
+ # @return [::String,nil]
656
675
  #
657
676
  class Configuration
658
677
  extend ::Gapic::Config
659
678
 
679
+ # @private
680
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
660
681
  DEFAULT_ENDPOINT = "speech.googleapis.com"
661
682
 
662
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
683
+ config_attr :endpoint, nil, ::String, nil
663
684
  config_attr :credentials, nil do |value|
664
685
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
665
686
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -674,6 +695,7 @@ module Google
674
695
  config_attr :metadata, nil, ::Hash, nil
675
696
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
676
697
  config_attr :quota_project, nil, ::String, nil
698
+ config_attr :universe_domain, nil, ::String, nil
677
699
 
678
700
  # @private
679
701
  def initialize parent_config = nil
@@ -32,6 +32,9 @@ module Google
32
32
  # Service that implements Google Cloud Speech API.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "speech.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -99,6 +102,15 @@ module Google
99
102
  @config
100
103
  end
101
104
 
105
+ ##
106
+ # The effective universe domain
107
+ #
108
+ # @return [String]
109
+ #
110
+ def universe_domain
111
+ @speech_stub.universe_domain
112
+ end
113
+
102
114
  ##
103
115
  # Create a new Speech REST client object.
104
116
  #
@@ -126,8 +138,9 @@ module Google
126
138
  credentials = @config.credentials
127
139
  # Use self-signed JWT if the endpoint is unchanged from default,
128
140
  # but only if the default endpoint does not have a region prefix.
129
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
130
- !@config.endpoint.split(".").first.include?("-")
141
+ enable_self_signed_jwt = @config.endpoint.nil? ||
142
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
143
+ !@config.endpoint.split(".").first.include?("-"))
131
144
  credentials ||= Credentials.default scope: @config.scope,
132
145
  enable_self_signed_jwt: enable_self_signed_jwt
133
146
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -141,9 +154,15 @@ module Google
141
154
  config.credentials = credentials
142
155
  config.quota_project = @quota_project_id
143
156
  config.endpoint = @config.endpoint
157
+ config.universe_domain = @config.universe_domain
144
158
  end
145
159
 
146
- @speech_stub = ::Google::Cloud::Speech::V1p1beta1::Speech::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
160
+ @speech_stub = ::Google::Cloud::Speech::V1p1beta1::Speech::Rest::ServiceStub.new(
161
+ endpoint: @config.endpoint,
162
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
163
+ universe_domain: @config.universe_domain,
164
+ credentials: credentials
165
+ )
147
166
  end
148
167
 
149
168
  ##
@@ -363,9 +382,9 @@ module Google
363
382
  # end
364
383
  #
365
384
  # @!attribute [rw] endpoint
366
- # The hostname or hostname:port of the service endpoint.
367
- # Defaults to `"speech.googleapis.com"`.
368
- # @return [::String]
385
+ # A custom service endpoint, as a hostname or hostname:port. The default is
386
+ # nil, indicating to use the default endpoint in the current universe domain.
387
+ # @return [::String,nil]
369
388
  # @!attribute [rw] credentials
370
389
  # Credentials to send with calls. You may provide any of the following types:
371
390
  # * (`String`) The path to a service account key file in JSON format
@@ -402,13 +421,20 @@ module Google
402
421
  # @!attribute [rw] quota_project
403
422
  # A separate project against which to charge quota.
404
423
  # @return [::String]
424
+ # @!attribute [rw] universe_domain
425
+ # The universe domain within which to make requests. This determines the
426
+ # default endpoint URL. The default value of nil uses the environment
427
+ # universe (usually the default "googleapis.com" universe).
428
+ # @return [::String,nil]
405
429
  #
406
430
  class Configuration
407
431
  extend ::Gapic::Config
408
432
 
433
+ # @private
434
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
409
435
  DEFAULT_ENDPOINT = "speech.googleapis.com"
410
436
 
411
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
437
+ config_attr :endpoint, nil, ::String, nil
412
438
  config_attr :credentials, nil do |value|
413
439
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
414
440
  allowed.any? { |klass| klass === value }
@@ -420,6 +446,7 @@ module Google
420
446
  config_attr :metadata, nil, ::Hash, nil
421
447
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
422
448
  config_attr :quota_project, nil, ::String, nil
449
+ config_attr :universe_domain, nil, ::String, nil
423
450
 
424
451
  # @private
425
452
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "speech.$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
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"speech.googleapis.com"`.
483
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "speech.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
626
651
  end
627
652
 
628
653
  ##
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the recognize REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Speech
23
23
  module V1p1beta1
24
- VERSION = "0.19.0"
24
+ VERSION = "0.20.0"
25
25
  end
26
26
  end
27
27
  end
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -274,12 +274,14 @@ module Google
274
274
  # spoken emojis with the corresponding Unicode symbols in the final
275
275
  # transcript. If 'false', spoken emojis are not replaced.
276
276
  # @!attribute [rw] enable_speaker_diarization
277
+ # @deprecated This field is deprecated and may be removed in the next major version update.
277
278
  # @return [::Boolean]
278
279
  # If 'true', enables speaker detection for each recognized word in
279
280
  # the top alternative of the recognition result using a speaker_tag provided
280
281
  # in the WordInfo.
281
282
  # Note: Use diarization_config instead.
282
283
  # @!attribute [rw] diarization_speaker_count
284
+ # @deprecated This field is deprecated and may be removed in the next major version update.
283
285
  # @return [::Integer]
284
286
  # If set, specifies the estimated number of speakers in the conversation.
285
287
  # Defaults to '2'. Ignored unless enable_speaker_diarization is set to true.
@@ -462,6 +464,7 @@ module Google
462
464
  # flexibility by allowing the system to automatically determine the correct
463
465
  # number of speakers. If not set, the default value is 6.
464
466
  # @!attribute [r] speaker_tag
467
+ # @deprecated This field is deprecated and may be removed in the next major version update.
465
468
  # @return [::Integer]
466
469
  # Output only. Unused.
467
470
  class SpeakerDiarizationConfig
@@ -470,6 +473,7 @@ module Google
470
473
  end
471
474
 
472
475
  # Description of audio data to be recognized.
476
+ # @deprecated This message is deprecated and may be removed in the next major version update.
473
477
  # @!attribute [rw] interaction_type
474
478
  # @return [::Google::Cloud::Speech::V1p1beta1::RecognitionMetadata::InteractionType]
475
479
  # The use case most closely describing the audio content to be recognized.
@@ -500,6 +504,7 @@ module Google
500
504
  # A list of possible audio mime types is maintained at
501
505
  # http://www.iana.org/assignments/media-types/media-types.xhtml#audio
502
506
  # @!attribute [rw] obfuscated_id
507
+ # @deprecated This field is deprecated and may be removed in the next major version update.
503
508
  # @return [::Integer]
504
509
  # Obfuscated (privacy-protected) ID of the user, to identify number of
505
510
  # unique users using the service.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-speech-v1p1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.19.0
4
+ version: 0.20.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: 2023-09-12 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.20.0
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
233
233
  - !ruby/object:Gem::Version
234
234
  version: '0'
235
235
  requirements: []
236
- rubygems_version: 3.4.19
236
+ rubygems_version: 3.5.3
237
237
  signing_key:
238
238
  specification_version: 4
239
239
  summary: Converts audio to text by applying powerful neural network models.