Class: Google::Cloud::Talent::V4beta1::Completion::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Talent::V4beta1::Completion::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/talent/v4beta1/completion/client.rb
Overview
Client for the Completion service.
A service handles auto completion.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the Completion Client class.
Instance Method Summary collapse
-
#complete_query(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Talent::V4beta1::CompleteQueryResponse
Completes the specified prefix with keyword suggestions.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the Completion Client instance.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new Completion client object.
Methods included from Paths
#company_path, #project_path, #tenant_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new Completion client object.
Examples
To create a new Completion client with the default configuration:
client = ::Google::Cloud::Talent::V4beta1::Completion::Client.new
To create a new Completion client with a custom configuration:
client = ::Google::Cloud::Talent::V4beta1::Completion::Client.new do |config|
config.timeout = 10.0
end
122 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 |
# File 'lib/google/cloud/talent/v4beta1/completion/client.rb', line 122 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/talent/v4beta1/completion_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope 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 @completion_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Talent::V4beta1::Completion::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the Completion Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all Completion clients:
::Google::Cloud::Talent::V4beta1::Completion::Client.configure do |config|
config.timeout = 10.0
end
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/google/cloud/talent/v4beta1/completion/client.rb', line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Talent", "V4beta1"] 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.rpcs.complete_query.timeout = 30.0 default_config.rpcs.complete_query.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#complete_query(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::CompleteQueryResponse #complete_query(parent: nil, query: nil, language_codes: nil, page_size: nil, company: nil, scope: nil, type: nil) ⇒ ::Google::Cloud::Talent::V4beta1::CompleteQueryResponse
Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.
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 252 253 254 |
# File 'lib/google/cloud/talent/v4beta1/completion/client.rb', line 219 def complete_query request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::CompleteQueryRequest # 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.complete_query..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::Talent::V4beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.complete_query.timeout, metadata: , retry_policy: @config.rpcs.complete_query.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @completion_stub.call_rpc :complete_query, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#configure {|config| ... } ⇒ Client::Configuration
Configure the Completion 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.
97 98 99 100 |
# File 'lib/google/cloud/talent/v4beta1/completion/client.rb', line 97 def configure yield @config if block_given? @config end |