Constructor
new CompanyServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of CompanyServiceClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
close() → {Promise}
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 |
A promise that resolves when the client is closed. |
companyPath(project, tenant, company) → {string}
Return a fully-qualified company resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
tenant |
string | |
company |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
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 |
A promise that resolves to an authenticated service stub. |
jobPath(project, tenant, job) → {string}
Return a fully-qualified job resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
tenant |
string | |
job |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
listCompaniesAsync(request, optionsopt) → {Object}
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 | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. 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 for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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".
*/
// const parent = 'abc123'
/**
* The starting indicator from which to return results.
*/
// const pageToken = 'abc123'
/**
* The maximum number of companies to be returned, at most 100.
* Default is 100 if a non-positive number is provided.
*/
// const pageSize = 1234
/**
* Set to true if the companies requested must have open jobs.
* Defaults to false.
* If true, at most
* page_size google.cloud.talent.v4.ListCompaniesRequest.page_size of
* companies are fetched, among which only those with open jobs are returned.
*/
// const requireOpenJobs = true
// Imports the Talent library
const {CompanyServiceClient} = require('@google-cloud/talent').v4;
// Instantiates a client
const talentClient = new CompanyServiceClient();
async function callListCompanies() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await talentClient.listCompaniesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCompanies();
listCompaniesStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
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 |
matchCompanyFromCompanyName(companyName) → {string}
Parse the company from Company resource.
Parameters:
Name | Type | Description |
---|---|---|
companyName |
string |
A fully-qualified path representing Company resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the company. |
matchJobFromJobName(jobName) → {string}
Parse the job from Job resource.
Parameters:
Name | Type | Description |
---|---|---|
jobName |
string |
A fully-qualified path representing Job resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the job. |
matchProjectFromCompanyName(companyName) → {string}
Parse the project from Company resource.
Parameters:
Name | Type | Description |
---|---|---|
companyName |
string |
A fully-qualified path representing Company resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromJobName(jobName) → {string}
Parse the project from Job resource.
Parameters:
Name | Type | Description |
---|---|---|
jobName |
string |
A fully-qualified path representing Job resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromTenantName(tenantName) → {string}
Parse the project from Tenant resource.
Parameters:
Name | Type | Description |
---|---|---|
tenantName |
string |
A fully-qualified path representing Tenant resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchTenantFromCompanyName(companyName) → {string}
Parse the tenant from Company resource.
Parameters:
Name | Type | Description |
---|---|---|
companyName |
string |
A fully-qualified path representing Company resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the tenant. |
matchTenantFromJobName(jobName) → {string}
Parse the tenant from Job resource.
Parameters:
Name | Type | Description |
---|---|---|
jobName |
string |
A fully-qualified path representing Job resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the tenant. |
matchTenantFromTenantName(tenantName) → {string}
Parse the tenant from Tenant resource.
Parameters:
Name | Type | Description |
---|---|---|
tenantName |
string |
A fully-qualified path representing Tenant resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the tenant. |
tenantPath(project, tenant) → {string}
Return a fully-qualified tenant resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
tenant |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |