google-cloud-text_to_speech-v1 0.2.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b01d2242a31a9c15b0935ac4a595c4e32dfe06a8163b5efe4525c937f94a670f
4
- data.tar.gz: ccbf998ba86a7cac7e633fea93ee3fb819482b5b1ec96a61656db96c52128322
3
+ metadata.gz: 68dae178047fabda5d9b1fb1c7d95b79a6f00caf8c26e94241f7919b823cd061
4
+ data.tar.gz: b41464a424e4ba7e6dd9e31a1cac2afde27f72957fac946468c287b4041f15f5
5
5
  SHA512:
6
- metadata.gz: fab6e4618a05c37848869e7565d7178d2339ad0b5b302f4e695c420b5297b2eb696333387b76e07548ae8a1d0032ec7e581a87b88000f28abc8ba6ac980663ee
7
- data.tar.gz: d68d7d8bf79e021078c8d02830c1572f72468c82548924f6cf58f3dc738fa136ec597d81b731e670f93fd3f91d3f4535638b8940611ecfc78e51f7fb01bce27c
6
+ metadata.gz: 7d1f6c7fe890bfa613b2b6d16e7ae96be70834c6cc0cc3b6d0b4ff0525524af45843a6182a59e8a62af76bff6302ac7c22069755c479cb46098f42770fb4c184
7
+ data.tar.gz: 9d55b21aaa431847e421c726b21b0c493ea6501de30c7943228236ab658097004fcf9e426b9a98d9e99dda20430ca29a014bc08c921fbe19f3f9f9410b7ed7e8
data/README.md CHANGED
@@ -6,6 +6,12 @@ Text-to-Speech converts text or Speech Synthesis Markup Language (SSML) input in
6
6
 
7
7
  https://github.com/googleapis/google-cloud-ruby
8
8
 
9
+ This gem is a _versioned_ client. It provides basic client classes for a
10
+ specific version of the Cloud Text-to-Speech V1 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-text_to_speech](https://rubygems.org/gems/google-cloud-text_to_speech).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
9
15
  ## Installation
10
16
 
11
17
  ```
@@ -18,6 +24,7 @@ In order to use this library, you first need to go through the following steps:
18
24
 
19
25
  1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
20
26
  1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
27
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/texttospeech.googleapis.com)
21
28
  1. {file:AUTHENTICATION.md Set up authentication.}
22
29
 
23
30
  ## Quick Start
@@ -33,6 +40,9 @@ response = client.list_voices request
33
40
  View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-text_to_speech-v1/latest)
34
41
  for class and method documentation.
35
42
 
43
+ See also the [Product Documentation](https://cloud.google.com/text-to-speech)
44
+ for general usage information.
45
+
36
46
  ## Enabling Logging
37
47
 
38
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
@@ -69,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
69
79
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
70
80
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
71
81
  about the Ruby support schedule.
82
+
83
+ ## Which client should I use?
84
+
85
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
86
+ client library with a name such as `google-cloud-text_to_speech`,
87
+ and lower-level _versioned_ client libraries with names such as
88
+ `google-cloud-text_to_speech-v1`.
89
+ _In most cases, you should install the main client._
90
+
91
+ ### What's the difference between the main client and a versioned client?
92
+
93
+ A _versioned client_ provides a basic set of data types and client classes for
94
+ a _single version_ of a specific service. (That is, for a service with multiple
95
+ versions, there might be a separate versioned client for each service version.)
96
+ Most versioned clients are written and maintained by a code generator.
97
+
98
+ The _main client_ is designed to provide you with the _recommended_ client
99
+ interfaces for the service. There will be only one main client for any given
100
+ service, even a service with multiple versions. The main client includes
101
+ factory methods for constructing the client objects we recommend for most
102
+ users. In some cases, those will be classes provided by an underlying versioned
103
+ client; in other cases, they will be handwritten higher-level client objects
104
+ with additional capabilities, convenience methods, or best practices built in.
105
+ Generally, the main client will default to a recommended service version,
106
+ although in some cases you can override this if you need to talk to a specific
107
+ service version.
108
+
109
+ ### Why would I want to use the main client?
110
+
111
+ We recommend that most users install the main client gem for a service. You can
112
+ identify this gem as the one _without_ a version in its name, e.g.
113
+ `google-cloud-text_to_speech`.
114
+ The main client is recommended because it will embody the best practices for
115
+ accessing the service, and may also provide more convenient interfaces or
116
+ tighter integration into frameworks and third-party libraries. In addition, the
117
+ documentation and samples published by Google will generally demonstrate use of
118
+ the main client.
119
+
120
+ ### Why would I want to use a versioned client?
121
+
122
+ You can use a versioned client if you are content with a possibly lower-level
123
+ class interface, you explicitly want to avoid features provided by the main
124
+ client, or you want to access a specific service version not be covered by the
125
+ main client. You can identify versioned client gems because the service version
126
+ is part of the name, e.g. `google-cloud-text_to_speech-v1`.
127
+
128
+ ### What about the google-apis-<name> clients?
129
+
130
+ Client library gems with names that begin with `google-apis-` are based on an
131
+ older code generation technology. They talk to a REST/JSON backend (whereas
132
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
133
+ not offer the same performance, features, and ease of use provided by more
134
+ modern clients.
135
+
136
+ The `google-apis-` clients have wide coverage across Google services, so you
137
+ might need to use one if there is no modern client available for the service.
138
+ However, if a modern client is available, we generally recommend it over the
139
+ older `google-apis-` clients.
@@ -33,3 +33,6 @@ module Google
33
33
  end
34
34
  end
35
35
  end
36
+
37
+ helper_path = ::File.join __dir__, "v1", "_helpers.rb"
38
+ require "google/cloud/text_to_speech/v1/_helpers" if ::File.file? helper_path
@@ -68,7 +68,7 @@ module Google
68
68
  initial_delay: 0.1,
69
69
  max_delay: 60.0,
70
70
  multiplier: 1.3,
71
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
71
+ retry_codes: [14, 4]
72
72
  }
73
73
 
74
74
  default_config.rpcs.synthesize_speech.timeout = 600.0
@@ -76,7 +76,7 @@ module Google
76
76
  initial_delay: 0.1,
77
77
  max_delay: 60.0,
78
78
  multiplier: 1.3,
79
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
79
+ retry_codes: [14, 4]
80
80
  }
81
81
 
82
82
  default_config
@@ -140,7 +140,13 @@ module Google
140
140
 
141
141
  # Create credentials
142
142
  credentials = @config.credentials
143
- credentials ||= Credentials.default scope: @config.scope
143
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
144
+ # but only if the default endpoint does not have a region prefix.
145
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
146
+ @config.endpoint == Client.configure.endpoint &&
147
+ !@config.endpoint.split(".").first.include?("-")
148
+ credentials ||= Credentials.default scope: @config.scope,
149
+ enable_self_signed_jwt: enable_self_signed_jwt
144
150
  if credentials.is_a?(String) || credentials.is_a?(Hash)
145
151
  credentials = Credentials.new credentials, scope: @config.scope
146
152
  end
@@ -181,10 +187,10 @@ module Google
181
187
  # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
182
188
  # specified, the ListVoices call will only return voices that can be used to
183
189
  # synthesize this language_code. E.g. when specifying "en-NZ", you will get
184
- # supported "en-*" voices; when specifying "no", you will get supported
185
- # "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh"
186
- # will also get supported "cmn-*" voices; specifying "zh-hk" will also get
187
- # supported "yue-*" voices.
190
+ # supported "en-\*" voices; when specifying "no", you will get supported
191
+ # "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices; specifying "zh"
192
+ # will also get supported "cmn-\*" voices; specifying "zh-hk" will also get
193
+ # supported "yue-\*" voices.
188
194
  #
189
195
  # @yield [response, operation] Access the result along with the RPC operation
190
196
  # @yieldparam response [::Google::Cloud::TextToSpeech::V1::ListVoicesResponse]
@@ -375,7 +381,7 @@ module Google
375
381
 
376
382
  config_attr :endpoint, "texttospeech.googleapis.com", ::String
377
383
  config_attr :credentials, nil do |value|
378
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
384
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
379
385
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
380
386
  allowed.any? { |klass| klass === value }
381
387
  end
@@ -415,7 +421,7 @@ module Google
415
421
  # Each configuration object is of type `Gapic::Config::Method` and includes
416
422
  # the following configuration fields:
417
423
  #
418
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
424
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
419
425
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
420
426
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
421
427
  # include the following keys:
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module TextToSpeech
23
23
  module V1
24
- VERSION = "0.2.2"
24
+ VERSION = "0.3.0"
25
25
  end
26
26
  end
27
27
  end
@@ -35,10 +35,10 @@ module Google
35
35
  self.service_name = 'google.cloud.texttospeech.v1.TextToSpeech'
36
36
 
37
37
  # Returns a list of Voice supported for synthesis.
38
- rpc :ListVoices, Google::Cloud::TextToSpeech::V1::ListVoicesRequest, Google::Cloud::TextToSpeech::V1::ListVoicesResponse
38
+ rpc :ListVoices, ::Google::Cloud::TextToSpeech::V1::ListVoicesRequest, ::Google::Cloud::TextToSpeech::V1::ListVoicesResponse
39
39
  # Synthesizes speech synchronously: receive results after all text input
40
40
  # has been processed.
41
- rpc :SynthesizeSpeech, Google::Cloud::TextToSpeech::V1::SynthesizeSpeechRequest, Google::Cloud::TextToSpeech::V1::SynthesizeSpeechResponse
41
+ rpc :SynthesizeSpeech, ::Google::Cloud::TextToSpeech::V1::SynthesizeSpeechRequest, ::Google::Cloud::TextToSpeech::V1::SynthesizeSpeechResponse
42
42
  end
43
43
 
44
44
  Stub = Service.rpc_stub_class
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -28,10 +28,10 @@ module Google
28
28
  # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
29
29
  # specified, the ListVoices call will only return voices that can be used to
30
30
  # synthesize this language_code. E.g. when specifying "en-NZ", you will get
31
- # supported "en-*" voices; when specifying "no", you will get supported
32
- # "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh"
33
- # will also get supported "cmn-*" voices; specifying "zh-hk" will also get
34
- # supported "yue-*" voices.
31
+ # supported "en-\*" voices; when specifying "no", you will get supported
32
+ # "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices; specifying "zh"
33
+ # will also get supported "cmn-\*" voices; specifying "zh-hk" will also get
34
+ # supported "yue-\*" voices.
35
35
  class ListVoicesRequest
36
36
  include ::Google::Protobuf::MessageExts
37
37
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-text_to_speech-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-06 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '0.2'
19
+ version: '0.3'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '0.2'
26
+ version: '0.3'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: google-cloud-errors
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -151,7 +151,10 @@ dependencies:
151
151
  - !ruby/object:Gem::Version
152
152
  version: '0.9'
153
153
  description: Text-to-Speech converts text or Speech Synthesis Markup Language (SSML)
154
- input into audio data of natural human speech.
154
+ input into audio data of natural human speech. Note that google-cloud-text_to_speech-v1
155
+ is a version-specific client library. For most uses, we recommend installing the
156
+ main client library google-cloud-text_to_speech instead. See the readme for more
157
+ details.
155
158
  email: googleapis-packages@google.com
156
159
  executables: []
157
160
  extensions: []
@@ -192,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
192
195
  - !ruby/object:Gem::Version
193
196
  version: '0'
194
197
  requirements: []
195
- rubygems_version: 3.1.3
198
+ rubygems_version: 3.2.6
196
199
  signing_key:
197
200
  specification_version: 4
198
201
  summary: API Client library for the Cloud Text-to-Speech V1 API