Class: Google::Cloud::Speech::V1p1beta1::Adaptation::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Speech::V1p1beta1::Adaptation::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb
Overview
REST client for the Adaptation service.
Service that implements Google Cloud Speech Adaptation API.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the Adaptation Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the Adaptation Client instance.
-
#create_custom_class(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass
Create a custom class.
-
#create_phrase_set(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet
Create a set of phrase hints.
-
#delete_custom_class(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Delete a custom class.
-
#delete_phrase_set(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Delete a phrase set.
-
#get_custom_class(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass
Get a custom class.
-
#get_phrase_set(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet
Get a phrase set.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new Adaptation REST client object.
-
#list_custom_classes(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::CustomClass>
List custom classes.
-
#list_phrase_set(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::PhraseSet>
List phrase sets.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_custom_class(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass
Update a custom class.
-
#update_phrase_set(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet
Update a phrase set.
Methods included from Paths
#custom_class_path, #location_path, #phrase_set_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new Adaptation REST client object.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 123 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @adaptation_stub = ::Google::Cloud::Speech::V1p1beta1::Adaptation::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the Adaptation Client class.
See Configuration for a description of the configuration fields.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 61 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Speech", "V1p1beta1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the Adaptation Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
93 94 95 96 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 93 def configure yield @config if block_given? @config end |
#create_custom_class(request, options = nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass #create_custom_class(parent: nil, custom_class_id: nil, custom_class: nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass
Create a custom class.
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 672 def create_custom_class request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::CreateCustomClassRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_custom_class..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_custom_class.timeout, metadata: , retry_policy: @config.rpcs.create_custom_class.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.create_custom_class request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#create_phrase_set(request, options = nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet #create_phrase_set(parent: nil, phrase_set_id: nil, phrase_set: nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet
Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 218 def create_phrase_set request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::CreatePhraseSetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_phrase_set..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_phrase_set.timeout, metadata: , retry_policy: @config.rpcs.create_phrase_set.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.create_phrase_set request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_custom_class(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_custom_class(name: nil) ⇒ ::Google::Protobuf::Empty
Delete a custom class.
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 1031 def delete_custom_class request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::DeleteCustomClassRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_custom_class..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.delete_custom_class.timeout, metadata: , retry_policy: @config.rpcs.delete_custom_class.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.delete_custom_class request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_phrase_set(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_phrase_set(name: nil) ⇒ ::Google::Protobuf::Empty
Delete a phrase set.
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 577 def delete_phrase_set request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::DeletePhraseSetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_phrase_set..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.delete_phrase_set.timeout, metadata: , retry_policy: @config.rpcs.delete_phrase_set.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.delete_phrase_set request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_custom_class(request, options = nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass #get_custom_class(name: nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass
Get a custom class.
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 752 def get_custom_class request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::GetCustomClassRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_custom_class..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_custom_class.timeout, metadata: , retry_policy: @config.rpcs.get_custom_class.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.get_custom_class request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_phrase_set(request, options = nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet #get_phrase_set(name: nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet
Get a phrase set.
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 304 def get_phrase_set request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::GetPhraseSetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_phrase_set..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_phrase_set.timeout, metadata: , retry_policy: @config.rpcs.get_phrase_set.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.get_phrase_set request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#list_custom_classes(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::CustomClass> #list_custom_classes(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::CustomClass>
List custom classes.
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 853 def list_custom_classes request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::ListCustomClassesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_custom_classes..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_custom_classes.timeout, metadata: , retry_policy: @config.rpcs.list_custom_classes.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.list_custom_classes request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @adaptation_stub, :list_custom_classes, "custom_classes", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#list_phrase_set(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::PhraseSet> #list_phrase_set(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::PhraseSet>
List phrase sets.
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 405 def list_phrase_set request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::ListPhraseSetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_phrase_set..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_phrase_set.timeout, metadata: , retry_policy: @config.rpcs.list_phrase_set.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.list_phrase_set request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @adaptation_stub, :list_phrase_set, "phrase_sets", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
103 104 105 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 103 def universe_domain @adaptation_stub.universe_domain end |
#update_custom_class(request, options = nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass #update_custom_class(custom_class: nil, update_mask: nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass
Update a custom class.
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 945 def update_custom_class request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::UpdateCustomClassRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_custom_class..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.update_custom_class.timeout, metadata: , retry_policy: @config.rpcs.update_custom_class.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.update_custom_class request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#update_phrase_set(request, options = nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet #update_phrase_set(phrase_set: nil, update_mask: nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::PhraseSet
Update a phrase set.
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
# File 'lib/google/cloud/speech/v1p1beta1/adaptation/rest/client.rb', line 497 def update_phrase_set request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::UpdatePhraseSetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_phrase_set..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.update_phrase_set.timeout, metadata: , retry_policy: @config.rpcs.update_phrase_set.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @adaptation_stub.update_phrase_set request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |