Send feedback
Class v4.TenantServiceClient (3.3.0) Stay organized with collections
Save and categorize content based on your preferences.
Version 3.3.0 keyboard_arrow_down
A service that handles tenant management, including CRUD and enumeration. v4
Package
@google-cloud/talent!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of TenantServiceClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
tenantServiceStub
tenantServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
> void
;
Property Value
Methods
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns Type
Description
Promise
<void>
{Promise} A promise that resolves when the client is closed.
companyPath(project, tenant, company)
companyPath
(
project
:
string
,
tenant
:
string
,
company
:
string
)
:
string
;
Return a fully-qualified company resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
createTenant(request, options)
createTenant
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4
.
ICreateTenantRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
ICreateTenantRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4.ICreateTenantRequest
options
CallOptions
Returns
createTenant(request, options, callback)
createTenant
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
ICreateTenantRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
ICreateTenantRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.ICreateTenantRequest
options
CallOptions
callback
Callback
<protos. google.cloud.talent.v4.ITenant
, protos. google.cloud.talent.v4.ICreateTenantRequest
| null | undefined, {} | null | undefined>
Returns
createTenant(request, callback)
createTenant
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
ICreateTenantRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
ICreateTenantRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.ICreateTenantRequest
callback
Callback
<protos. google.cloud.talent.v4.ITenant
, protos. google.cloud.talent.v4.ICreateTenantRequest
| null | undefined, {} | null | undefined>
Returns
deleteTenant(request, options)
deleteTenant
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4
.
IDeleteTenantRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
talent
.
v4
.
IDeleteTenantRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IDeleteTenantRequest
options
CallOptions
Returns
deleteTenant(request, options, callback)
deleteTenant
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
IDeleteTenantRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
talent
.
v4
.
IDeleteTenantRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IDeleteTenantRequest
options
CallOptions
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.talent.v4.IDeleteTenantRequest
| null | undefined, {} | null | undefined>
Returns
deleteTenant(request, callback)
deleteTenant
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
IDeleteTenantRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
talent
.
v4
.
IDeleteTenantRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IDeleteTenantRequest
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.talent.v4.IDeleteTenantRequest
| null | undefined, {} | null | undefined>
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name
Description
callback
Callback
<string, undefined, undefined>
Returns
getTenant(request, options)
getTenant
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4
.
IGetTenantRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
IGetTenantRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IGetTenantRequest
options
CallOptions
Returns
getTenant(request, options, callback)
getTenant
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
IGetTenantRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
IGetTenantRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IGetTenantRequest
options
CallOptions
callback
Callback
<protos. google.cloud.talent.v4.ITenant
, protos. google.cloud.talent.v4.IGetTenantRequest
| null | undefined, {} | null | undefined>
Returns
getTenant(request, callback)
getTenant
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
IGetTenantRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
IGetTenantRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IGetTenantRequest
callback
Callback
<protos. google.cloud.talent.v4.ITenant
, protos. google.cloud.talent.v4.IGetTenantRequest
| null | undefined, {} | null | undefined>
Returns
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns Type
Description
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
jobPath(project, tenant, job)
jobPath
(
project
:
string
,
tenant
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified job resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
listTenants(request, options)
listTenants
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
[],
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsRequest
|
null
,
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsResponse
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IListTenantsRequest
options
CallOptions
Returns
listTenants(request, options, callback)
listTenants
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsRequest
,
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IListTenantsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.talent.v4.IListTenantsRequest
, protos. google.cloud.talent.v4.IListTenantsResponse
| null | undefined, protos. google.cloud.talent.v4.ITenant
>
Returns
listTenants(request, callback)
listTenants
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsRequest
,
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IListTenantsRequest
callback
PaginationCallback
<protos. google.cloud.talent.v4.IListTenantsRequest
, protos. google.cloud.talent.v4.IListTenantsResponse
| null | undefined, protos. google.cloud.talent.v4.ITenant
>
Returns
listTenantsAsync(request, options)
listTenantsAsync
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
> ;
Equivalent to listTenants
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters Name
Description
request
protos. google.cloud.talent.v4.IListTenantsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
AsyncIterable
<protos. google.cloud.talent.v4.ITenant
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Tenant]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listTenantsStream(request, options)
listTenantsStream
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4
.
IListTenantsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.talent.v4.IListTenantsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
Transform
{Stream} An object stream which emits an object representing [Tenant] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTenantsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
matchCompanyFromCompanyName(companyName)
matchCompanyFromCompanyName
(
companyName
:
string
)
:
string
|
number
;
Parse the company from Company resource.
Parameter Name
Description
companyName
string
A fully-qualified path representing Company resource.
Returns Type
Description
string | number
{string} A string representing the company.
matchJobFromJobName(jobName)
matchJobFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the job from Job resource.
Parameter Name
Description
jobName
string
A fully-qualified path representing Job resource.
Returns Type
Description
string | number
{string} A string representing the job.
matchProjectFromCompanyName(companyName)
matchProjectFromCompanyName
(
companyName
:
string
)
:
string
|
number
;
Parse the project from Company resource.
Parameter Name
Description
companyName
string
A fully-qualified path representing Company resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromJobName(jobName)
matchProjectFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the project from Job resource.
Parameter Name
Description
jobName
string
A fully-qualified path representing Job resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
Parameter Name
Description
projectName
string
A fully-qualified path representing Project resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromTenantName(tenantName)
matchProjectFromTenantName
(
tenantName
:
string
)
:
string
|
number
;
Parse the project from Tenant resource.
Parameter Name
Description
tenantName
string
A fully-qualified path representing Tenant resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchTenantFromCompanyName(companyName)
matchTenantFromCompanyName
(
companyName
:
string
)
:
string
|
number
;
Parse the tenant from Company resource.
Parameter Name
Description
companyName
string
A fully-qualified path representing Company resource.
Returns Type
Description
string | number
{string} A string representing the tenant.
matchTenantFromJobName(jobName)
matchTenantFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the tenant from Job resource.
Parameter Name
Description
jobName
string
A fully-qualified path representing Job resource.
Returns Type
Description
string | number
{string} A string representing the tenant.
matchTenantFromTenantName(tenantName)
matchTenantFromTenantName
(
tenantName
:
string
)
:
string
|
number
;
Parse the tenant from Tenant resource.
Parameter Name
Description
tenantName
string
A fully-qualified path representing Tenant resource.
Returns Type
Description
string | number
{string} A string representing the tenant.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
Parameter
Returns Type
Description
string
{string} Resource name string.
tenantPath(project, tenant)
tenantPath
(
project
:
string
,
tenant
:
string
)
:
string
;
Return a fully-qualified tenant resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
updateTenant(request, options)
updateTenant
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4
.
IUpdateTenantRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
IUpdateTenantRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IUpdateTenantRequest
options
CallOptions
Returns
updateTenant(request, options, callback)
updateTenant
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
IUpdateTenantRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
IUpdateTenantRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IUpdateTenantRequest
options
CallOptions
callback
Callback
<protos. google.cloud.talent.v4.ITenant
, protos. google.cloud.talent.v4.IUpdateTenantRequest
| null | undefined, {} | null | undefined>
Returns
updateTenant(request, callback)
updateTenant
(
request
:
protos
.
google
.
cloud
.
talent
.
v4
.
IUpdateTenantRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4
.
ITenant
,
protos
.
google
.
cloud
.
talent
.
v4
.
IUpdateTenantRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4.IUpdateTenantRequest
callback
Callback
<protos. google.cloud.talent.v4.ITenant
, protos. google.cloud.talent.v4.IUpdateTenantRequest
| null | undefined, {} | null | undefined>
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
