Class: Google::Cloud::Talent::V4beta1::CompanyService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/talent/v4beta1/company_service/client.rb

Overview

Client for the CompanyService service.

A service that handles company management, including CRUD and enumeration.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#company_path, #project_path, #tenant_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new CompanyService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Talent::V4beta1::CompanyService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Talent::V4beta1::CompanyService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CompanyService client.

Yield Parameters:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 143

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/company_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
  # 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

  @company_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Talent::V4beta1::CompanyService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the CompanyService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CompanyService clients
::Google::Cloud::Talent::V4beta1::CompanyService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
93
94
95
96
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 62

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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



113
114
115
116
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 113

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.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::CompanyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::CreateCompanyRequest.new

# Call the create_company method.
result = client.create_company request

# The returned object is of type Google::Cloud::Talent::V4beta1::Company.
p result

Overloads:

  • #create_company(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company

    Pass arguments to create_company via a request object, either of type Google::Cloud::Talent::V4beta1::CreateCompanyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::CreateCompanyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_company(parent: nil, company: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company

    Pass arguments to create_company via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Resource name of the tenant under which the company is created.

      The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo".

    • company (::Google::Cloud::Talent::V4beta1::Company, ::Hash) (defaults to: nil) —

      Required. The company to be created.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 235

def create_company request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_company.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_company.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_company.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @company_service_stub.call_rpc :create_company, request, options: 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

#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.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::CompanyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::DeleteCompanyRequest.new

# Call the delete_company method.
result = client.delete_company request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_company(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_company via a request object, either of type DeleteCompanyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::DeleteCompanyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_company(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_company via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the company to be deleted.

      The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz".

      If tenant id is unspecified, the default tenant is used, for example, "projects/foo/companies/bar".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 521

def delete_company request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_company.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_company.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_company.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @company_service_stub.call_rpc :delete_company, request, options: 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

#get_company(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company #get_company(name: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company

Retrieves specified company.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::CompanyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::GetCompanyRequest.new

# Call the get_company method.
result = client.get_company request

# The returned object is of type Google::Cloud::Talent::V4beta1::Company.
p result

Overloads:

  • #get_company(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company

    Pass arguments to get_company via a request object, either of type GetCompanyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::GetCompanyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_company(name: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company

    Pass arguments to get_company via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the company to be retrieved.

      The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/api-test-project/tenants/foo/companies/bar".

      If tenant id is unspecified, the default tenant is used, for example, "projects/api-test-project/companies/bar".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



328
329
330
331
332
333
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
368
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 328

def get_company request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_company.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_company.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_company.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @company_service_stub.call_rpc :get_company, request, options: 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

#list_companies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Company> #list_companies(parent: nil, page_token: nil, page_size: nil, require_open_jobs: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Company>

Lists all companies associated with the project.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::CompanyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::ListCompaniesRequest.new

# Call the list_companies method.
result = client.list_companies request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Talent::V4beta1::Company.
  p item
end

Overloads:

  • #list_companies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Company>

    Pass arguments to list_companies via a request object, either of type ListCompaniesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::ListCompaniesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_companies(parent: nil, page_token: nil, page_size: nil, require_open_jobs: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Company>

    Pass arguments to list_companies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Resource name of the tenant under which the company is created.

      The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar".

      If tenant id is unspecified, the default tenant will be used, for example, "projects/foo".

    • page_token (::String) (defaults to: nil) —

      The starting indicator from which to return results.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.

    • require_open_jobs (::Boolean) (defaults to: nil) —

      Set to true if the companies requested must have open jobs.

      Defaults to false.

      If true, at most page_size of companies are fetched, among which only those with open jobs are returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 630

def list_companies request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_companies.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_companies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_companies.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @company_service_stub.call_rpc :list_companies, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @company_service_stub, :list_companies, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


123
124
125
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 123

def universe_domain
  @company_service_stub.universe_domain
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.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4beta1::CompanyService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4beta1::UpdateCompanyRequest.new

# Call the update_company method.
result = client.update_company request

# The returned object is of type Google::Cloud::Talent::V4beta1::Company.
p result

Overloads:

  • #update_company(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company

    Pass arguments to update_company via a request object, either of type UpdateCompanyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::UpdateCompanyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_company(company: nil, update_mask: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Company

    Pass arguments to update_company via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • company (::Google::Cloud::Talent::V4beta1::Company, ::Hash) (defaults to: nil) —

      Required. The company resource to replace the current resource in the system.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Strongly recommended for the best service experience.

      If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated.

      A field mask to specify the company fields to be updated. Only top level fields of Company are supported.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/google/cloud/talent/v4beta1/company_service/client.rb', line 427

def update_company request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_company.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.company&.name
    header_params["company.name"] = request.company.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_company.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_company.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @company_service_stub.call_rpc :update_company, request, options: 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