Class v4.CompanyServiceClient (3.2.7)

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

Package

@google-cloud/talent!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CompanyServiceClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

companyServiceStub

companyServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

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
Name Description
project string
tenant string
company string
Returns
Type Description
string

{string} Resource name string.

createCompany(request, options)

createCompany(request?: protos.google.cloud.talent.v4.ICreateCompanyRequest, options?: CallOptions): Promise<[protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.ICreateCompanyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.talent.v4.ICreateCompanyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.ICreateCompanyRequest | undefined, {} | undefined]>

createCompany(request, options, callback)

createCompany(request: protos.google.cloud.talent.v4.ICreateCompanyRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.ICreateCompanyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.ICreateCompanyRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.ICreateCompanyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createCompany(request, callback)

createCompany(request: protos.google.cloud.talent.v4.ICreateCompanyRequest, callback: Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.ICreateCompanyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.ICreateCompanyRequest
callback Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.ICreateCompanyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteCompany(request, options)

deleteCompany(request?: protos.google.cloud.talent.v4.IDeleteCompanyRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteCompanyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.talent.v4.IDeleteCompanyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteCompanyRequest | undefined, {} | undefined]>

deleteCompany(request, options, callback)

deleteCompany(request: protos.google.cloud.talent.v4.IDeleteCompanyRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteCompanyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.IDeleteCompanyRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteCompanyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteCompany(request, callback)

deleteCompany(request: protos.google.cloud.talent.v4.IDeleteCompanyRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteCompanyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.IDeleteCompanyRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4.IDeleteCompanyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCompany(request, options)

getCompany(request?: protos.google.cloud.talent.v4.IGetCompanyRequest, options?: CallOptions): Promise<[protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IGetCompanyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.talent.v4.IGetCompanyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IGetCompanyRequest | undefined, {} | undefined]>

getCompany(request, options, callback)

getCompany(request: protos.google.cloud.talent.v4.IGetCompanyRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IGetCompanyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.IGetCompanyRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IGetCompanyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCompany(request, callback)

getCompany(request: protos.google.cloud.talent.v4.IGetCompanyRequest, callback: Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IGetCompanyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.IGetCompanyRequest
callback Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IGetCompanyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

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
Name Description
project string
tenant string
job string
Returns
Type Description
string

{string} Resource name string.

listCompanies(request, options)

listCompanies(request?: protos.google.cloud.talent.v4.IListCompaniesRequest, options?: CallOptions): Promise<[protos.google.cloud.talent.v4.ICompany[], protos.google.cloud.talent.v4.IListCompaniesRequest | null, protos.google.cloud.talent.v4.IListCompaniesResponse]>;
Parameters
Name Description
request protos.google.cloud.talent.v4.IListCompaniesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.talent.v4.ICompany[], protos.google.cloud.talent.v4.IListCompaniesRequest | null, protos.google.cloud.talent.v4.IListCompaniesResponse]>

listCompanies(request, options, callback)

listCompanies(request: protos.google.cloud.talent.v4.IListCompaniesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.talent.v4.IListCompaniesRequest, protos.google.cloud.talent.v4.IListCompaniesResponse | null | undefined, protos.google.cloud.talent.v4.ICompany>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.IListCompaniesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.talent.v4.IListCompaniesRequest, protos.google.cloud.talent.v4.IListCompaniesResponse | null | undefined, protos.google.cloud.talent.v4.ICompany>
Returns
Type Description
void

listCompanies(request, callback)

listCompanies(request: protos.google.cloud.talent.v4.IListCompaniesRequest, callback: PaginationCallback<protos.google.cloud.talent.v4.IListCompaniesRequest, protos.google.cloud.talent.v4.IListCompaniesResponse | null | undefined, protos.google.cloud.talent.v4.ICompany>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.IListCompaniesRequest
callback PaginationCallback<protos.google.cloud.talent.v4.IListCompaniesRequest, protos.google.cloud.talent.v4.IListCompaniesResponse | null | undefined, protos.google.cloud.talent.v4.ICompany>
Returns
Type Description
void

listCompaniesAsync(request, options)

listCompaniesAsync(request?: protos.google.cloud.talent.v4.IListCompaniesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.talent.v4.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.v4.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.v4.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.v4.IListCompaniesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.talent.v4.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.

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.

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.

tenantPath(project, tenant)

tenantPath(project: string, tenant: string): string;

Return a fully-qualified tenant resource name string.

Parameters
Name Description
project string
tenant string
Returns
Type Description
string

{string} Resource name string.

updateCompany(request, options)

updateCompany(request?: protos.google.cloud.talent.v4.IUpdateCompanyRequest, options?: CallOptions): Promise<[protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IUpdateCompanyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.talent.v4.IUpdateCompanyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IUpdateCompanyRequest | undefined, {} | undefined]>

updateCompany(request, options, callback)

updateCompany(request: protos.google.cloud.talent.v4.IUpdateCompanyRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IUpdateCompanyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.IUpdateCompanyRequest
options CallOptions
callback Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IUpdateCompanyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateCompany(request, callback)

updateCompany(request: protos.google.cloud.talent.v4.IUpdateCompanyRequest, callback: Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IUpdateCompanyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.talent.v4.IUpdateCompanyRequest
callback Callback<protos.google.cloud.talent.v4.ICompany, protos.google.cloud.talent.v4.IUpdateCompanyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void