google-cloud-speech-v1 0.7.3 → 0.8.0

data/proto_docs/google/cloud/speech/v1/cloud_speech_adaptation.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Speech
+      module V1
+        # Message sent by the client for the `CreatePhraseSet` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this phrase set will be created. Format:
+        #
+        #     `projects/{project}/locations/{location}/phraseSets`
+        #
+        #     Speech-to-Text supports three locations: `global`, `us` (US North America),
+        #     and `eu` (Europe). If you are calling the `speech.googleapis.com`
+        #     endpoint, use the `global` location. To specify a region, use a
+        #     [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+        #     with matching `us` or `eu` location value.
+        # @!attribute [rw] phrase_set_id
+        #   @return [::String]
+        #     Required. The ID to use for the phrase set, which will become the final
+        #     component of the phrase set's resource name.
+        #
+        #     This value should restrict to letters, numbers, and hyphens, with the first
+        #     character a letter, the last a letter or a number, and be 4-63 characters.
+        # @!attribute [rw] phrase_set
+        #   @return [::Google::Cloud::Speech::V1::PhraseSet]
+        #     Required. The phrase set to create.
+        class CreatePhraseSetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `UpdatePhraseSet` method.
+        # @!attribute [rw] phrase_set
+        #   @return [::Google::Cloud::Speech::V1::PhraseSet]
+        #     Required. The phrase set to update.
+        #
+        #     The phrase set's `name` field is used to identify the set to be
+        #     updated. Format:
+        #
+        #     `projects/{project}/locations/{location}/phraseSets/{phrase_set}`
+        #
+        #     Speech-to-Text supports three locations: `global`, `us` (US North America),
+        #     and `eu` (Europe). If you are calling the `speech.googleapis.com`
+        #     endpoint, use the `global` location. To specify a region, use a
+        #     [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+        #     with matching `us` or `eu` location value.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The list of fields to be updated.
+        class UpdatePhraseSetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `GetPhraseSet` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the phrase set to retrieve. Format:
+        #
+        #     `projects/{project}/locations/{location}/phraseSets/{phrase_set}`
+        #
+        #     Speech-to-Text supports three locations: `global`, `us` (US North America),
+        #     and `eu` (Europe). If you are calling the `speech.googleapis.com`
+        #     endpoint, use the `global` location. To specify a region, use a
+        #     [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+        #     with matching `us` or `eu` location value.
+        class GetPhraseSetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `ListPhraseSet` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of phrase set. Format:
+        #
+        #     `projects/{project}/locations/{location}`
+        #
+        #     Speech-to-Text supports three locations: `global`, `us` (US North America),
+        #     and `eu` (Europe). If you are calling the `speech.googleapis.com`
+        #     endpoint, use the `global` location. To specify a region, use a
+        #     [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+        #     with matching `us` or `eu` location value.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of phrase sets to return. The service may return
+        #     fewer than this value. If unspecified, at most 50 phrase sets will be
+        #     returned. The maximum value is 1000; values above 1000 will be coerced to
+        #     1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token, received from a previous `ListPhraseSet` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListPhraseSet` must
+        #     match the call that provided the page token.
+        class ListPhraseSetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message returned to the client by the `ListPhraseSet` method.
+        # @!attribute [rw] phrase_sets
+        #   @return [::Array<::Google::Cloud::Speech::V1::PhraseSet>]
+        #     The phrase set.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token, which can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        class ListPhraseSetResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `DeletePhraseSet` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the phrase set to delete. Format:
+        #
+        #     `projects/{project}/locations/{location}/phraseSets/{phrase_set}`
+        class DeletePhraseSetRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `CreateCustomClass` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this custom class will be created. Format:
+        #
+        #     `projects/{project}/locations/{location}/customClasses`
+        #
+        #     Speech-to-Text supports three locations: `global`, `us` (US North America),
+        #     and `eu` (Europe). If you are calling the `speech.googleapis.com`
+        #     endpoint, use the `global` location. To specify a region, use a
+        #     [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+        #     with matching `us` or `eu` location value.
+        # @!attribute [rw] custom_class_id
+        #   @return [::String]
+        #     Required. The ID to use for the custom class, which will become the final
+        #     component of the custom class' resource name.
+        #
+        #     This value should restrict to letters, numbers, and hyphens, with the first
+        #     character a letter, the last a letter or a number, and be 4-63 characters.
+        # @!attribute [rw] custom_class
+        #   @return [::Google::Cloud::Speech::V1::CustomClass]
+        #     Required. The custom class to create.
+        class CreateCustomClassRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `UpdateCustomClass` method.
+        # @!attribute [rw] custom_class
+        #   @return [::Google::Cloud::Speech::V1::CustomClass]
+        #     Required. The custom class to update.
+        #
+        #     The custom class's `name` field is used to identify the custom class to be
+        #     updated. Format:
+        #
+        #     `projects/{project}/locations/{location}/customClasses/{custom_class}`
+        #
+        #     Speech-to-Text supports three locations: `global`, `us` (US North America),
+        #     and `eu` (Europe). If you are calling the `speech.googleapis.com`
+        #     endpoint, use the `global` location. To specify a region, use a
+        #     [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+        #     with matching `us` or `eu` location value.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     The list of fields to be updated.
+        class UpdateCustomClassRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `GetCustomClass` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the custom class to retrieve. Format:
+        #
+        #     `projects/{project}/locations/{location}/customClasses/{custom_class}`
+        class GetCustomClassRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `ListCustomClasses` method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of custom classes. Format:
+        #
+        #     `projects/{project}/locations/{location}/customClasses`
+        #
+        #     Speech-to-Text supports three locations: `global`, `us` (US North America),
+        #     and `eu` (Europe). If you are calling the `speech.googleapis.com`
+        #     endpoint, use the `global` location. To specify a region, use a
+        #     [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+        #     with matching `us` or `eu` location value.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of custom classes to return. The service may return
+        #     fewer than this value. If unspecified, at most 50 custom classes will be
+        #     returned. The maximum value is 1000; values above 1000 will be coerced to
+        #     1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token, received from a previous `ListCustomClass` call.
+        #     Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListCustomClass` must
+        #     match the call that provided the page token.
+        class ListCustomClassesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message returned to the client by the `ListCustomClasses` method.
+        # @!attribute [rw] custom_classes
+        #   @return [::Array<::Google::Cloud::Speech::V1::CustomClass>]
+        #     The custom classes.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token, which can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        class ListCustomClassesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message sent by the client for the `DeleteCustomClass` method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the custom class to delete. Format:
+        #
+        #     `projects/{project}/locations/{location}/customClasses/{custom_class}`
+        #
+        #     Speech-to-Text supports three locations: `global`, `us` (US North America),
+        #     and `eu` (Europe). If you are calling the `speech.googleapis.com`
+        #     endpoint, use the `global` location. To specify a region, use a
+        #     [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+        #     with matching `us` or `eu` location value.
+        class DeleteCustomClassRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-speech-v1
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -175,6 +175,12 @@ files:
 - README.md
 - lib/google-cloud-speech-v1.rb
 - lib/google/cloud/speech/v1.rb
+- lib/google/cloud/speech/v1/adaptation.rb
+- lib/google/cloud/speech/v1/adaptation/client.rb
+- lib/google/cloud/speech/v1/adaptation/credentials.rb
+- lib/google/cloud/speech/v1/adaptation/paths.rb
+- lib/google/cloud/speech/v1/cloud_speech_adaptation_pb.rb
+- lib/google/cloud/speech/v1/cloud_speech_adaptation_services_pb.rb
 - lib/google/cloud/speech/v1/cloud_speech_pb.rb
 - lib/google/cloud/speech/v1/cloud_speech_services_pb.rb
 - lib/google/cloud/speech/v1/resource_pb.rb
@@ -188,11 +194,13 @@ files:
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/speech/v1/cloud_speech.rb
+- proto_docs/google/cloud/speech/v1/cloud_speech_adaptation.rb
 - proto_docs/google/cloud/speech/v1/resource.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
 - proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
+- proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/protobuf/wrappers.rb
 - proto_docs/google/rpc/status.rb