Constructor
new CompletionClient(optionsopt, gaxInstanceopt)
Construct an instance of CompletionClient.
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. |
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. |