Send feedback
Class v4beta1.CompanyServiceClient (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 company management, including CRUD and enumeration. v4beta1
Package
@google-cloud/talent!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of CompanyServiceClient.
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
companyServiceStub
companyServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
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
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
> void
;
Property Value
Methods
applicationPath(project, tenant, profile, application)
applicationPath
(
project
:
string
,
tenant
:
string
,
profile
:
string
,
application
:
string
)
:
string
;
Return a fully-qualified application resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
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.
createCompany(request, options)
createCompany
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICreateCompanyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICreateCompanyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.ICreateCompanyRequest
options
CallOptions
Returns
createCompany(request, options, callback)
createCompany
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICreateCompanyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICreateCompanyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.ICreateCompanyRequest
options
CallOptions
callback
Callback
<protos. google.cloud.talent.v4beta1.ICompany
, protos. google.cloud.talent.v4beta1.ICreateCompanyRequest
| null | undefined, {} | null | undefined>
Returns
createCompany(request, callback)
createCompany
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICreateCompanyRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICreateCompanyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.ICreateCompanyRequest
callback
Callback
<protos. google.cloud.talent.v4beta1.ICompany
, protos. google.cloud.talent.v4beta1.ICreateCompanyRequest
| null | undefined, {} | null | undefined>
Returns
deleteCompany(request, options)
deleteCompany
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IDeleteCompanyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IDeleteCompanyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IDeleteCompanyRequest
options
CallOptions
Returns
deleteCompany(request, options, callback)
deleteCompany
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IDeleteCompanyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IDeleteCompanyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IDeleteCompanyRequest
options
CallOptions
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.talent.v4beta1.IDeleteCompanyRequest
| null | undefined, {} | null | undefined>
Returns
deleteCompany(request, callback)
deleteCompany
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IDeleteCompanyRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IDeleteCompanyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IDeleteCompanyRequest
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.talent.v4beta1.IDeleteCompanyRequest
| null | undefined, {} | null | undefined>
Returns
getCompany(request, options)
getCompany
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IGetCompanyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IGetCompanyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IGetCompanyRequest
options
CallOptions
Returns
getCompany(request, options, callback)
getCompany
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IGetCompanyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IGetCompanyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IGetCompanyRequest
options
CallOptions
callback
Callback
<protos. google.cloud.talent.v4beta1.ICompany
, protos. google.cloud.talent.v4beta1.IGetCompanyRequest
| null | undefined, {} | null | undefined>
Returns
getCompany(request, callback)
getCompany
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IGetCompanyRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IGetCompanyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IGetCompanyRequest
callback
Callback
<protos. google.cloud.talent.v4beta1.ICompany
, protos. google.cloud.talent.v4beta1.IGetCompanyRequest
| 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
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.
listCompanies(request, options)
listCompanies
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
[],
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesRequest
|
null
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesResponse
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IListCompaniesRequest
options
CallOptions
Returns
listCompanies(request, options, callback)
listCompanies
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesRequest
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IListCompaniesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.talent.v4beta1.IListCompaniesRequest
, protos. google.cloud.talent.v4beta1.IListCompaniesResponse
| null | undefined, protos. google.cloud.talent.v4beta1.ICompany
>
Returns
listCompanies(request, callback)
listCompanies
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesRequest
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IListCompaniesRequest
callback
PaginationCallback
<protos. google.cloud.talent.v4beta1.IListCompaniesRequest
, protos. google.cloud.talent.v4beta1.IListCompaniesResponse
| null | undefined, protos. google.cloud.talent.v4beta1.ICompany
>
Returns
listCompaniesAsync(request, options)
listCompaniesAsync
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
> ;
Equivalent to listCompanies
, 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.v4beta1.IListCompaniesRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
AsyncIterable
<protos. google.cloud.talent.v4beta1.ICompany
>
{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 [Company]. 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.
listCompaniesStream(request, options)
listCompaniesStream
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IListCompaniesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IListCompaniesRequest
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 [Company] 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 listCompaniesAsync()
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.
matchApplicationFromApplicationName(applicationName)
matchApplicationFromApplicationName
(
applicationName
:
string
)
:
string
|
number
;
Parse the application from Application resource.
Parameter Name
Description
applicationName
string
A fully-qualified path representing Application resource.
Returns Type
Description
string | number
{string} A string representing the application.
matchCompanyFromProjectCompanyName(projectCompanyName)
matchCompanyFromProjectCompanyName
(
projectCompanyName
:
string
)
:
string
|
number
;
Parse the company from ProjectCompany resource.
Parameter Name
Description
projectCompanyName
string
A fully-qualified path representing project_company resource.
Returns Type
Description
string | number
{string} A string representing the company.
matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName)
matchCompanyFromProjectTenantCompanyName
(
projectTenantCompanyName
:
string
)
:
string
|
number
;
Parse the company from ProjectTenantCompany resource.
Parameter Name
Description
projectTenantCompanyName
string
A fully-qualified path representing project_tenant_company resource.
Returns Type
Description
string | number
{string} A string representing the company.
matchJobFromProjectJobName(projectJobName)
matchJobFromProjectJobName
(
projectJobName
:
string
)
:
string
|
number
;
Parse the job from ProjectJob resource.
Parameter Name
Description
projectJobName
string
A fully-qualified path representing project_job resource.
Returns Type
Description
string | number
{string} A string representing the job.
matchJobFromProjectTenantJobName(projectTenantJobName)
matchJobFromProjectTenantJobName
(
projectTenantJobName
:
string
)
:
string
|
number
;
Parse the job from ProjectTenantJob resource.
Parameter Name
Description
projectTenantJobName
string
A fully-qualified path representing project_tenant_job resource.
Returns Type
Description
string | number
{string} A string representing the job.
matchProfileFromApplicationName(applicationName)
matchProfileFromApplicationName
(
applicationName
:
string
)
:
string
|
number
;
Parse the profile from Application resource.
Parameter Name
Description
applicationName
string
A fully-qualified path representing Application resource.
Returns Type
Description
string | number
{string} A string representing the profile.
matchProfileFromProfileName(profileName)
matchProfileFromProfileName
(
profileName
:
string
)
:
string
|
number
;
Parse the profile from Profile resource.
Parameter Name
Description
profileName
string
A fully-qualified path representing Profile resource.
Returns Type
Description
string | number
{string} A string representing the profile.
matchProjectFromApplicationName(applicationName)
matchProjectFromApplicationName
(
applicationName
:
string
)
:
string
|
number
;
Parse the project from Application resource.
Parameter Name
Description
applicationName
string
A fully-qualified path representing Application resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromProfileName(profileName)
matchProjectFromProfileName
(
profileName
:
string
)
:
string
|
number
;
Parse the project from Profile resource.
Parameter Name
Description
profileName
string
A fully-qualified path representing Profile resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromProjectCompanyName(projectCompanyName)
matchProjectFromProjectCompanyName
(
projectCompanyName
:
string
)
:
string
|
number
;
Parse the project from ProjectCompany resource.
Parameter Name
Description
projectCompanyName
string
A fully-qualified path representing project_company resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromProjectJobName(projectJobName)
matchProjectFromProjectJobName
(
projectJobName
:
string
)
:
string
|
number
;
Parse the project from ProjectJob resource.
Parameter Name
Description
projectJobName
string
A fully-qualified path representing project_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.
matchProjectFromProjectTenantCompanyName(projectTenantCompanyName)
matchProjectFromProjectTenantCompanyName
(
projectTenantCompanyName
:
string
)
:
string
|
number
;
Parse the project from ProjectTenantCompany resource.
Parameter Name
Description
projectTenantCompanyName
string
A fully-qualified path representing project_tenant_company resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromProjectTenantJobName(projectTenantJobName)
matchProjectFromProjectTenantJobName
(
projectTenantJobName
:
string
)
:
string
|
number
;
Parse the project from ProjectTenantJob resource.
Parameter Name
Description
projectTenantJobName
string
A fully-qualified path representing project_tenant_job 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.
matchTenantFromApplicationName(applicationName)
matchTenantFromApplicationName
(
applicationName
:
string
)
:
string
|
number
;
Parse the tenant from Application resource.
Parameter Name
Description
applicationName
string
A fully-qualified path representing Application resource.
Returns Type
Description
string | number
{string} A string representing the tenant.
matchTenantFromProfileName(profileName)
matchTenantFromProfileName
(
profileName
:
string
)
:
string
|
number
;
Parse the tenant from Profile resource.
Parameter Name
Description
profileName
string
A fully-qualified path representing Profile resource.
Returns Type
Description
string | number
{string} A string representing the tenant.
matchTenantFromProjectTenantCompanyName(projectTenantCompanyName)
matchTenantFromProjectTenantCompanyName
(
projectTenantCompanyName
:
string
)
:
string
|
number
;
Parse the tenant from ProjectTenantCompany resource.
Parameter Name
Description
projectTenantCompanyName
string
A fully-qualified path representing project_tenant_company resource.
Returns Type
Description
string | number
{string} A string representing the tenant.
matchTenantFromProjectTenantJobName(projectTenantJobName)
matchTenantFromProjectTenantJobName
(
projectTenantJobName
:
string
)
:
string
|
number
;
Parse the tenant from ProjectTenantJob resource.
Parameter Name
Description
projectTenantJobName
string
A fully-qualified path representing project_tenant_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.
profilePath(project, tenant, profile)
profilePath
(
project
:
string
,
tenant
:
string
,
profile
:
string
)
:
string
;
Return a fully-qualified profile resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
projectCompanyPath(project, company)
projectCompanyPath
(
project
:
string
,
company
:
string
)
:
string
;
Return a fully-qualified projectCompany resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
projectJobPath(project, job)
projectJobPath
(
project
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified projectJob resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
Parameter
Returns Type
Description
string
{string} Resource name string.
projectTenantCompanyPath(project, tenant, company)
projectTenantCompanyPath
(
project
:
string
,
tenant
:
string
,
company
:
string
)
:
string
;
Return a fully-qualified projectTenantCompany resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
projectTenantJobPath(project, tenant, job)
projectTenantJobPath
(
project
:
string
,
tenant
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified projectTenantJob resource name string.
Parameters
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.
updateCompany(request, options)
updateCompany
(
request
?:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IUpdateCompanyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IUpdateCompanyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IUpdateCompanyRequest
options
CallOptions
Returns
updateCompany(request, options, callback)
updateCompany
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IUpdateCompanyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IUpdateCompanyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IUpdateCompanyRequest
options
CallOptions
callback
Callback
<protos. google.cloud.talent.v4beta1.ICompany
, protos. google.cloud.talent.v4beta1.IUpdateCompanyRequest
| null | undefined, {} | null | undefined>
Returns
updateCompany(request, callback)
updateCompany
(
request
:
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IUpdateCompanyRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
talent
.
v4beta1
.
ICompany
,
protos
.
google
.
cloud
.
talent
.
v4beta1
.
IUpdateCompanyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.talent.v4beta1.IUpdateCompanyRequest
callback
Callback
<protos. google.cloud.talent.v4beta1.ICompany
, protos. google.cloud.talent.v4beta1.IUpdateCompanyRequest
| 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,[]]
