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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Paths

#company_path, #project_path, #tenant_path

Constructor Details

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

Create a new CompanyService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the CompanyService client.

Yield Parameters:



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.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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, 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
  call_metadata = @config.rpcs.create_company.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_company.timeout,
                         metadata:     call_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.create_company request, options 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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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, 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
  call_metadata = @config.rpcs.delete_company.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_company.timeout,
                         metadata:     call_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.delete_company request, options 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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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, 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
  call_metadata = @config.rpcs.get_company.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_company.timeout,
                         metadata:     call_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.get_company request, options 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.

Overloads:

  • #list_companies(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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, 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
  call_metadata = @config.rpcs.list_companies.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_companies.timeout,
                         metadata:     call_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.list_companies request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @company_service_stub, :list_companies, "companies", request, result, options
    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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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, 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
  call_metadata = @config.rpcs.update_company.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_company.timeout,
                         metadata:     call_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.update_company request, options 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