class Google::Cloud::Talent::V4::CompanyService::Client

Client for the CompanyService service.

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

Attributes

company_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the CompanyService Client class.

See {::Google::Cloud::Talent::V4::CompanyService::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/talent/v4/company_service/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Talent", "V4"]
    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
new() { |config| ... } click to toggle source

Create a new CompanyService client object.

@example

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

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

@yield [config] Configure the CompanyService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/talent/v4/company_service/client.rb, line 128
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/v4/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 == 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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Talent::V4::CompanyService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {Client.configure}.

See {::Google::Cloud::Talent::V4::CompanyService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/talent/v4/company_service/client.rb, line 107
def configure
  yield @config if block_given?
  @config
end
create_company(request, options = nil) { |response, operation| ... } click to toggle source

Creates a new company entity.

@overload create_company(request, options = nil)

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

@param request [::Google::Cloud::Talent::V4::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_company(parent: nil, company: nil)

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

@param parent [::String]
  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/tenants/bar".
@param company [::Google::Cloud::Talent::V4::Company, ::Hash]
  Required. The company to be created.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Talent::V4::Company] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Talent::V4::Company]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/talent/v4/company_service/client.rb, line 200
def create_company request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4::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 and x-goog-user-project 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::V4::VERSION
  metadata[:"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("&")
  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) { |response, operation| ... } click to toggle source

Deletes specified company. Prerequisite: The company has no jobs associated with it.

@overload delete_company(request, options = nil)

Pass arguments to `delete_company` via a request object, either of type
{::Google::Cloud::Talent::V4::DeleteCompanyRequest} or an equivalent Hash.

@param request [::Google::Cloud::Talent::V4::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload delete_company(name: nil)

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

@param name [::String]
  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".

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/talent/v4/company_service/client.rb, line 421
def delete_company request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4::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 and x-goog-user-project 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::V4::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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) { |response, operation| ... } click to toggle source

Retrieves specified company.

@overload get_company(request, options = nil)

Pass arguments to `get_company` via a request object, either of type
{::Google::Cloud::Talent::V4::GetCompanyRequest} or an equivalent Hash.

@param request [::Google::Cloud::Talent::V4::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_company(name: nil)

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

@param name [::String]
  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".

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Talent::V4::Company] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Talent::V4::Company]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/talent/v4/company_service/client.rb, line 272
def get_company request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4::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 and x-goog-user-project 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::V4::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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) { |response, operation| ... } click to toggle source

Lists all companies associated with the project.

@overload list_companies(request, options = nil)

Pass arguments to `list_companies` via a request object, either of type
{::Google::Cloud::Talent::V4::ListCompaniesRequest} or an equivalent Hash.

@param request [::Google::Cloud::Talent::V4::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_companies(parent: nil, page_token: nil, page_size: nil, require_open_jobs: nil)

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

@param parent [::String]
  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/tenants/bar".
@param page_token [::String]
  The starting indicator from which to return results.
@param page_size [::Integer]
  The maximum number of companies to be returned, at most 100.
  Default is 100 if a non-positive number is provided.
@param require_open_jobs [::Boolean]
  Set to true if the companies requested must have open jobs.

  Defaults to false.

  If true, at most {::Google::Cloud::Talent::V4::ListCompaniesRequest#page_size page_size} of companies are fetched, among which
  only those with open jobs are returned.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4::Company>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4::Company>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/talent/v4/company_service/client.rb, line 504
def list_companies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4::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 and x-goog-user-project 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::V4::VERSION
  metadata[:"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("&")
  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
update_company(request, options = nil) { |response, operation| ... } click to toggle source

Updates specified company.

@overload update_company(request, options = nil)

Pass arguments to `update_company` via a request object, either of type
{::Google::Cloud::Talent::V4::UpdateCompanyRequest} or an equivalent Hash.

@param request [::Google::Cloud::Talent::V4::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_company(company: nil, update_mask: nil)

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

@param company [::Google::Cloud::Talent::V4::Company, ::Hash]
  Required. The company resource to replace the current resource in the system.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Strongly recommended for the best service experience.

  If {::Google::Cloud::Talent::V4::UpdateCompanyRequest#update_mask update_mask} is provided, only the specified fields in
  {::Google::Cloud::Talent::V4::UpdateCompanyRequest#company 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 {::Google::Cloud::Talent::V4::Company Company} are supported.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Talent::V4::Company] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Talent::V4::Company]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/talent/v4/company_service/client.rb, line 348
def update_company request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4::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 and x-goog-user-project 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::V4::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "company.name" => request.company.name
  }
  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