google-cloud-speech-v1p1beta1 0.3.3 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Speech
23
23
  module V1p1beta1
24
- VERSION = "0.3.3"
24
+ VERSION = "0.5.0"
25
25
  end
26
26
  end
27
27
  end
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -92,6 +92,16 @@ module Google
92
92
  # `END_OF_SINGLE_UTTERANCE` event and cease recognition. It will return no
93
93
  # more than one `StreamingRecognitionResult` with the `is_final` flag set to
94
94
  # `true`.
95
+ #
96
+ # The `single_utterance` field can only be used with specified models,
97
+ # otherwise an error is thrown. The `model` field in [`RecognitionConfig`][]
98
+ # must be set to:
99
+ #
100
+ # * `command_and_search`
101
+ # * `phone_call` AND additional field `useEnhanced`=`true`
102
+ # * The `model` field is left undefined. In this case the API auto-selects
103
+ # a model based on any other parameters that you set in
104
+ # `RecognitionConfig`.
95
105
  # @!attribute [rw] interim_results
96
106
  # @return [::Boolean]
97
107
  # If `true`, interim results (tentative hypotheses) may be
@@ -346,7 +356,8 @@ module Google
346
356
  # wideband is supported. `sample_rate_hertz` must be 16000.
347
357
  SPEEX_WITH_HEADER_BYTE = 7
348
358
 
349
- # MP3 audio. Support all standard MP3 bitrates (which range from 32-320
359
+ # MP3 audio. MP3 encoding is a Beta feature and only available in
360
+ # v1p1beta1. Support all standard MP3 bitrates (which range from 32-320
350
361
  # kbps). When using this encoding, `sample_rate_hertz` has to match the
351
362
  # sample rate of the file being used.
352
363
  MP3 = 8
@@ -607,8 +618,8 @@ module Google
607
618
  # Time of the most recent processing update.
608
619
  # @!attribute [r] uri
609
620
  # @return [::String]
610
- # The URI of the audio file being transcribed. Empty if the audio was sent
611
- # as byte content.
621
+ # Output only. The URI of the audio file being transcribed. Empty if the
622
+ # audio was sent as byte content.
612
623
  class LongRunningRecognizeMetadata
613
624
  include ::Google::Protobuf::MessageExts
614
625
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -0,0 +1,218 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Speech
23
+ module V1p1beta1
24
+ # Message sent by the client for the `CreatePhraseSet` method.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The parent resource where this phrase set will be created.
28
+ # Format:
29
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/phraseSets
30
+ # @!attribute [rw] phrase_set_id
31
+ # @return [::String]
32
+ # The ID to use for the phrase set, which will become the final
33
+ # component of the phrase set's resource name.
34
+ #
35
+ # This value should be 4-63 characters, and valid characters
36
+ # are /[a-z][0-9]-/.
37
+ # @!attribute [rw] phrase_set
38
+ # @return [::Google::Cloud::Speech::V1p1beta1::PhraseSet]
39
+ # Required. The phrase set to create.
40
+ class CreatePhraseSetRequest
41
+ include ::Google::Protobuf::MessageExts
42
+ extend ::Google::Protobuf::MessageExts::ClassMethods
43
+ end
44
+
45
+ # Message sent by the client for the `UpdatePhraseSet` method.
46
+ # @!attribute [rw] phrase_set
47
+ # @return [::Google::Cloud::Speech::V1p1beta1::PhraseSet]
48
+ # Required. The phrase set to update.
49
+ #
50
+ # The phrase set's `name` field is used to identify the set to be
51
+ # updated. Format:
52
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/phraseSets/\\{phrase_set}
53
+ # @!attribute [rw] update_mask
54
+ # @return [::Google::Protobuf::FieldMask]
55
+ # The list of fields to be updated.
56
+ class UpdatePhraseSetRequest
57
+ include ::Google::Protobuf::MessageExts
58
+ extend ::Google::Protobuf::MessageExts::ClassMethods
59
+ end
60
+
61
+ # Message sent by the client for the `GetPhraseSet` method.
62
+ # @!attribute [rw] name
63
+ # @return [::String]
64
+ # Required. The name of the phrase set to retrieve.
65
+ # Format:
66
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/phraseSets/\\{phrase_set}
67
+ class GetPhraseSetRequest
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+
72
+ # Message sent by the client for the `ListPhraseSet` method.
73
+ # @!attribute [rw] parent
74
+ # @return [::String]
75
+ # Required. The parent, which owns this collection of phrase set.
76
+ # Format:
77
+ # projects/\\{project}/locations/\\{location}
78
+ # @!attribute [rw] page_size
79
+ # @return [::Integer]
80
+ # The maximum number of phrase sets to return. The service may return
81
+ # fewer than this value. If unspecified, at most 50 phrase sets will be
82
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
83
+ # 1000.
84
+ # @!attribute [rw] page_token
85
+ # @return [::String]
86
+ # A page token, received from a previous `ListPhraseSet` call.
87
+ # Provide this to retrieve the subsequent page.
88
+ #
89
+ # When paginating, all other parameters provided to `ListPhraseSet` must
90
+ # match the call that provided the page token.
91
+ class ListPhraseSetRequest
92
+ include ::Google::Protobuf::MessageExts
93
+ extend ::Google::Protobuf::MessageExts::ClassMethods
94
+ end
95
+
96
+ # Message returned to the client by the `ListPhraseSet` method.
97
+ # @!attribute [rw] phrase_sets
98
+ # @return [::Array<::Google::Cloud::Speech::V1p1beta1::PhraseSet>]
99
+ # The phrase set.
100
+ # @!attribute [rw] next_page_token
101
+ # @return [::String]
102
+ # A token, which can be sent as `page_token` to retrieve the next page.
103
+ # If this field is omitted, there are no subsequent pages.
104
+ class ListPhraseSetResponse
105
+ include ::Google::Protobuf::MessageExts
106
+ extend ::Google::Protobuf::MessageExts::ClassMethods
107
+ end
108
+
109
+ # Message sent by the client for the `DeletePhraseSet` method.
110
+ # @!attribute [rw] name
111
+ # @return [::String]
112
+ # Required. The name of the phrase set to delete.
113
+ # Format:
114
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/phraseSets/\\{phrase_set}
115
+ class DeletePhraseSetRequest
116
+ include ::Google::Protobuf::MessageExts
117
+ extend ::Google::Protobuf::MessageExts::ClassMethods
118
+ end
119
+
120
+ # Message sent by the client for the `CreateCustomClass` method.
121
+ # @!attribute [rw] parent
122
+ # @return [::String]
123
+ # Required. The parent resource where this custom class will be created.
124
+ # Format:
125
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses
126
+ # @!attribute [rw] custom_class_id
127
+ # @return [::String]
128
+ # The ID to use for the custom class, which will become the final
129
+ # component of the custom class' resource name.
130
+ #
131
+ # This value should be 4-63 characters, and valid characters
132
+ # are /[a-z][0-9]-/.
133
+ # @!attribute [rw] custom_class
134
+ # @return [::Google::Cloud::Speech::V1p1beta1::CustomClass]
135
+ # Required. The custom class to create.
136
+ class CreateCustomClassRequest
137
+ include ::Google::Protobuf::MessageExts
138
+ extend ::Google::Protobuf::MessageExts::ClassMethods
139
+ end
140
+
141
+ # Message sent by the client for the `UpdateCustomClass` method.
142
+ # @!attribute [rw] custom_class
143
+ # @return [::Google::Cloud::Speech::V1p1beta1::CustomClass]
144
+ # Required. The custom class to update.
145
+ #
146
+ # The custom class's `name` field is used to identify the custom class to be
147
+ # updated. Format:
148
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses/\\{custom_class}
149
+ # @!attribute [rw] update_mask
150
+ # @return [::Google::Protobuf::FieldMask]
151
+ # The list of fields to be updated.
152
+ class UpdateCustomClassRequest
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+ end
156
+
157
+ # Message sent by the client for the `GetCustomClass` method.
158
+ # @!attribute [rw] name
159
+ # @return [::String]
160
+ # Required. The name of the custom class to retrieve.
161
+ # Format:
162
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses/\\{custom_class}
163
+ class GetCustomClassRequest
164
+ include ::Google::Protobuf::MessageExts
165
+ extend ::Google::Protobuf::MessageExts::ClassMethods
166
+ end
167
+
168
+ # Message sent by the client for the `ListCustomClasses` method.
169
+ # @!attribute [rw] parent
170
+ # @return [::String]
171
+ # Required. The parent, which owns this collection of custom classes.
172
+ # Format:
173
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses
174
+ # @!attribute [rw] page_size
175
+ # @return [::Integer]
176
+ # The maximum number of custom classes to return. The service may return
177
+ # fewer than this value. If unspecified, at most 50 custom classes will be
178
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
179
+ # 1000.
180
+ # @!attribute [rw] page_token
181
+ # @return [::String]
182
+ # A page token, received from a previous `ListCustomClass` call.
183
+ # Provide this to retrieve the subsequent page.
184
+ #
185
+ # When paginating, all other parameters provided to `ListCustomClass` must
186
+ # match the call that provided the page token.
187
+ class ListCustomClassesRequest
188
+ include ::Google::Protobuf::MessageExts
189
+ extend ::Google::Protobuf::MessageExts::ClassMethods
190
+ end
191
+
192
+ # Message returned to the client by the `ListCustomClasses` method.
193
+ # @!attribute [rw] custom_classes
194
+ # @return [::Array<::Google::Cloud::Speech::V1p1beta1::CustomClass>]
195
+ # The custom classes.
196
+ # @!attribute [rw] next_page_token
197
+ # @return [::String]
198
+ # A token, which can be sent as `page_token` to retrieve the next page.
199
+ # If this field is omitted, there are no subsequent pages.
200
+ class ListCustomClassesResponse
201
+ include ::Google::Protobuf::MessageExts
202
+ extend ::Google::Protobuf::MessageExts::ClassMethods
203
+ end
204
+
205
+ # Message sent by the client for the `DeleteCustomClass` method.
206
+ # @!attribute [rw] name
207
+ # @return [::String]
208
+ # Required. The name of the custom class to delete.
209
+ # Format:
210
+ # \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses/\\{custom_class}
211
+ class DeleteCustomClassRequest
212
+ include ::Google::Protobuf::MessageExts
213
+ extend ::Google::Protobuf::MessageExts::ClassMethods
214
+ end
215
+ end
216
+ end
217
+ end
218
+ end
@@ -30,7 +30,7 @@ module Google
30
30
  # @!attribute [rw] custom_class_id
31
31
  # @return [::String]
32
32
  # If this custom class is a resource, the custom_class_id is the resource id
33
- # of the CustomClass.
33
+ # of the CustomClass. Case sensitive.
34
34
  # @!attribute [rw] items
35
35
  # @return [::Array<::Google::Cloud::Speech::V1p1beta1::CustomClass::ClassItem>]
36
36
  # A collection of class items.
@@ -117,6 +117,9 @@ module Google
117
117
  # A collection of phrase sets. To specify the hints inline, leave the
118
118
  # phrase set's `name` blank and fill in the rest of its fields. Any
119
119
  # phrase set can use any custom class.
120
+ # @!attribute [rw] phrase_set_references
121
+ # @return [::Array<::String>]
122
+ # A collection of phrase set resource names to use.
120
123
  # @!attribute [rw] custom_classes
121
124
  # @return [::Array<::Google::Cloud::Speech::V1p1beta1::CustomClass>]
122
125
  # A collection of custom classes. To specify the classes inline, leave the
@@ -25,7 +25,7 @@ module Google
25
25
  # @return [::String]
26
26
  # The server-assigned name, which is only unique within the same service that
27
27
  # originally returns it. If you use the default HTTP mapping, the
28
- # `name` should have the format of `operations/some/unique/name`.
28
+ # `name` should be a resource name ending with `operations/{unique_id}`.
29
29
  # @!attribute [rw] metadata
30
30
  # @return [::Google::Protobuf::Any]
31
31
  # Service-specific metadata associated with the operation. It typically
@@ -35,7 +35,7 @@ module Google
35
35
  # @!attribute [rw] done
36
36
  # @return [::Boolean]
37
37
  # If the value is `false`, it means the operation is still in progress.
38
- # If true, the operation is completed, and either `error` or `response` is
38
+ # If `true`, the operation is completed, and either `error` or `response` is
39
39
  # available.
40
40
  # @!attribute [rw] error
41
41
  # @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
67
67
  # The request message for Operations.ListOperations.
68
68
  # @!attribute [rw] name
69
69
  # @return [::String]
70
- # The name of the operation collection.
70
+ # The name of the operation's parent resource.
71
71
  # @!attribute [rw] filter
72
72
  # @return [::String]
73
73
  # The standard list filter.
@@ -112,6 +112,20 @@ module Google
112
112
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
113
  end
114
114
 
115
+ # The request message for Operations.WaitOperation.
116
+ # @!attribute [rw] name
117
+ # @return [::String]
118
+ # The name of the operation resource to wait on.
119
+ # @!attribute [rw] timeout
120
+ # @return [::Google::Protobuf::Duration]
121
+ # The maximum duration to wait before timing out. If left blank, the wait
122
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
123
+ # If RPC context deadline is also specified, the shorter one will be used.
124
+ class WaitOperationRequest
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+
115
129
  # A message representing the message types used by a long-running operation.
116
130
  #
117
131
  # Example: