Class: Google::Cloud::Talent::V4beta1::CompanyService::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Talent::V4beta1::CompanyService::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/talent/v4beta1/company_service/rest/client.rb
Overview
REST client for the CompanyService service.
A service that handles company management, including CRUD and enumeration.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the CompanyService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the CompanyService Client instance.
-
#create_company(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Talent::V4beta1::Company
Creates a new company entity.
-
#delete_company(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes specified company.
-
#get_company(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Talent::V4beta1::Company
Retrieves specified company.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new CompanyService REST client object.
-
#list_companies(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Company>
Lists all companies associated with the project.
-
#update_company(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Talent::V4beta1::Company
Updates specified company.
Methods included from Paths
#company_path, #project_path, #tenant_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new CompanyService REST client object.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/google/cloud/talent/v4beta1/company_service/rest/client.rb', line 130 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 == Client.configure.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 @company_service_stub = ::Google::Cloud::Talent::V4beta1::CompanyService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the CompanyService Client class.
See Configuration for a description of the configuration fields.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/google/cloud/talent/v4beta1/company_service/rest/client.rb', line 58 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.create_company.timeout = 30.0 default_config.rpcs.get_company.timeout = 30.0 default_config.rpcs.get_company.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.update_company.timeout = 30.0 default_config.rpcs.delete_company.timeout = 30.0 default_config.rpcs.delete_company.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.list_companies.timeout = 30.0 default_config.rpcs.list_companies.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
#configure {|config| ... } ⇒ Client::Configuration
Configure the CompanyService 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.
109 110 111 112 |
# File 'lib/google/cloud/talent/v4beta1/company_service/rest/client.rb', line 109 def configure yield @config if block_given? @config end |
#create_company(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company #create_company(parent: nil, company: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company
Creates a new company entity.
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/google/cloud/talent/v4beta1/company_service/rest/client.rb', line 190 def create_company request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::CreateCompanyRequest # 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_company..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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_company.timeout, metadata: , retry_policy: @config.rpcs.create_company.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @company_service_stub.create_company 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_company(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_company(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes specified company. Prerequisite: The company has no jobs associated with it.
404 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 |
# File 'lib/google/cloud/talent/v4beta1/company_service/rest/client.rb', line 404 def delete_company request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::DeleteCompanyRequest # 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_company..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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.delete_company.timeout, metadata: , retry_policy: @config.rpcs.delete_company.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @company_service_stub.delete_company 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_company(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company #get_company(name: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company
Retrieves specified company.
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/google/cloud/talent/v4beta1/company_service/rest/client.rb', line 259 def get_company request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::GetCompanyRequest # 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_company..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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_company.timeout, metadata: , retry_policy: @config.rpcs.get_company.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @company_service_stub.get_company 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_companies(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Company> #list_companies(parent: nil, page_token: nil, page_size: nil, require_open_jobs: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Company>
Lists all companies associated with the project.
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'lib/google/cloud/talent/v4beta1/company_service/rest/client.rb', line 485 def list_companies request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::ListCompaniesRequest # 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_companies..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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_companies.timeout, metadata: , retry_policy: @config.rpcs.list_companies.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @company_service_stub.list_companies request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @company_service_stub, :list_companies, "companies", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#update_company(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company #update_company(company: nil, update_mask: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company
Updates specified company.
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/google/cloud/talent/v4beta1/company_service/rest/client.rb', line 334 def update_company request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::UpdateCompanyRequest # 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_company..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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.update_company.timeout, metadata: , retry_policy: @config.rpcs.update_company.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @company_service_stub.update_company 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 |