Class: Google::Cloud::Talent::V4beta1::TenantServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/talent/v4beta1/tenant_service_client.rb,
lib/google/cloud/talent/v4beta1/helpers.rb

Overview

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

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"jobs.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/jobs"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ TenantServiceClient

Returns a new instance of TenantServiceClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

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

    Override for the service hostname, or nil to leave as the default.

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

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



137
138
139
140
141
142
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
182
183
184
185
186
187
188
189
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
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
 
# File 'lib/google/cloud/talent/v4beta1/tenant_service_client.rb', line 137

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # 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 "google/gax/grpc"
  require "google/cloud/talent/v4beta1/tenant_service_services_pb"

  credentials ||= Google::Cloud::Talent::V4beta1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Talent::V4beta1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Google::Cloud::Talent::VERSION

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "tenant_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.talent.v4beta1.TenantService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @tenant_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Talent::V4beta1::TenantService::Stub.method(:new)
  )

  @create_tenant = Google::Gax.create_api_call(
    @tenant_service_stub.method(:create_tenant),
    defaults["create_tenant"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_tenant = Google::Gax.create_api_call(
    @tenant_service_stub.method(:get_tenant),
    defaults["get_tenant"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @update_tenant = Google::Gax.create_api_call(
    @tenant_service_stub.method(:update_tenant),
    defaults["update_tenant"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'tenant.name' => request.tenant.name}
    end
  )
  @delete_tenant = Google::Gax.create_api_call(
    @tenant_service_stub.method(:delete_tenant),
    defaults["delete_tenant"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_tenants = Google::Gax.create_api_call(
    @tenant_service_stub.method(:list_tenants),
    defaults["list_tenants"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
end

Class Method Details

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


87
88
89
90
91
 
# File 'lib/google/cloud/talent/v4beta1/tenant_service_client.rb', line 87

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

.tenant_path(project, tenant) ⇒ String

Returns a fully-qualified tenant resource name string.

Parameters:

  • project (String)
  • tenant (String)

Returns:

  • (String) 


97
98
99
100
101
102
 
# File 'lib/google/cloud/talent/v4beta1/tenant_service_client.rb', line 97

def self.tenant_path project, tenant
  TENANT_PATH_TEMPLATE.render(
    :"project" => project,
    :"tenant" => tenant
  )
end

Instance Method Details

#create_tenant(parent, tenant, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Talent::V4beta1::Tenant

Creates a new tenant entity.

Examples:

require "google/cloud/talent"

tenant_client = Google::Cloud::Talent::TenantService.new(version: :v4beta1)
formatted_parent = Google::Cloud::Talent::V4beta1::TenantServiceClient.project_path("[PROJECT]")

# TODO: Initialize `tenant`:
tenant = {}
response = tenant_client.create_tenant(formatted_parent, tenant)

Parameters:

  • parent (String) —

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

    The format is "projects/project_id", for example, "projects/foo".

  • tenant (Google::Cloud::Talent::V4beta1::Tenant | Hash) —

    Required. The tenant to be created. A hash of the same form as Google::Cloud::Talent::V4beta1::Tenant can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/google/cloud/talent/v4beta1/tenant_service_client.rb', line 286

def create_tenant \
    parent,
    tenant,
    options: nil,
    &block
  req = {
    parent: parent,
    tenant: tenant
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Talent::V4beta1::CreateTenantRequest)
  @create_tenant.call(req, options, &block)
end

#delete_tenant(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes specified tenant.

Examples:

require "google/cloud/talent"

tenant_client = Google::Cloud::Talent::TenantService.new(version: :v4beta1)
formatted_name = Google::Cloud::Talent::V4beta1::TenantServiceClient.tenant_path("[PROJECT]", "[TENANT]")
tenant_client.delete_tenant(formatted_name)

Parameters:

  • name (String) —

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

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/google/cloud/talent/v4beta1/tenant_service_client.rb', line 404

def delete_tenant \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Talent::V4beta1::DeleteTenantRequest)
  @delete_tenant.call(req, options, &block)
  nil
end

#get_tenant(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Talent::V4beta1::Tenant

Retrieves specified tenant.

Examples:

require "google/cloud/talent"

tenant_client = Google::Cloud::Talent::TenantService.new(version: :v4beta1)
formatted_name = Google::Cloud::Talent::V4beta1::TenantServiceClient.tenant_path("[PROJECT]", "[TENANT]")
response = tenant_client.get_tenant(formatted_name)

Parameters:

  • name (String) —

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

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



321
322
323
324
325
326
327
328
329
330
 
# File 'lib/google/cloud/talent/v4beta1/tenant_service_client.rb', line 321

def get_tenant \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Talent::V4beta1::GetTenantRequest)
  @get_tenant.call(req, options, &block)
end

#list_tenants(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Talent::V4beta1::Tenant>

Lists all tenants associated with the project.

Examples:

require "google/cloud/talent"

tenant_client = Google::Cloud::Talent::TenantService.new(version: :v4beta1)
formatted_parent = Google::Cloud::Talent::V4beta1::TenantServiceClient.project_path("[PROJECT]")

# Iterate over all results.
tenant_client.list_tenants(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
tenant_client.list_tenants(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

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

    The format is "projects/project_id", for example, "projects/foo".

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

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Talent::V4beta1::Tenant>) —

    An enumerable of Google::Cloud::Talent::V4beta1::Tenant instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/google/cloud/talent/v4beta1/tenant_service_client.rb', line 460

def list_tenants \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Talent::V4beta1::ListTenantsRequest)
  @list_tenants.call(req, options, &block)
end

#project_path(project) ⇒ String

Alias for Google::Cloud::Talent::V4beta1::TenantServiceClient.project_path.

Parameters:

  • project (String)

Returns:

  • (String) 


147
148
149
 
# File 'lib/google/cloud/talent/v4beta1/helpers.rb', line 147

def project_path project
  self.class.project_path project
end

#tenant_path(project, tenant) ⇒ String

Alias for Google::Cloud::Talent::V4beta1::TenantServiceClient.tenant_path.

Parameters:

  • project (String)
  • tenant (String)

Returns:

  • (String) 


155
156
157
 
# File 'lib/google/cloud/talent/v4beta1/helpers.rb', line 155

def tenant_path project, tenant
  self.class.tenant_path project, tenant
end

#update_tenant(tenant, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Talent::V4beta1::Tenant

Updates specified tenant.

Examples:

require "google/cloud/talent"

tenant_client = Google::Cloud::Talent::TenantService.new(version: :v4beta1)

# TODO: Initialize `tenant`:
tenant = {}
response = tenant_client.update_tenant(tenant)

Parameters:

  • tenant (Google::Cloud::Talent::V4beta1::Tenant | Hash) —

    Required. The tenant resource to replace the current resource in the system. A hash of the same form as Google::Cloud::Talent::V4beta1::Tenant can also be provided.

  • 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 tenant are updated. Otherwise all the fields are updated.

    A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/google/cloud/talent/v4beta1/tenant_service_client.rb', line 370

def update_tenant \
    tenant,
    update_mask: nil,
    options: nil,
    &block
  req = {
    tenant: tenant,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Talent::V4beta1::UpdateTenantRequest)
  @update_tenant.call(req, options, &block)
end