ApplicationServiceClient

ApplicationServiceClient

A service that handles application management, including CRUD and enumeration.

Constructor

new ApplicationServiceClient(optionsopt)

Construct an instance of ApplicationServiceClient.

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
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

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

applicationPath(project, tenant, profile, application) → {string}

Return a fully-qualified application resource name string.

Parameters:
Name Type Description
project string
tenant string
profile string
application string
Returns:
Type Description
string

Resource name string.

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.

createApplication(request, optionsopt) → {Promise}

Creates a new application entity.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
application google.cloud.talent.v4beta1.Application

Required. The application to be created.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Application. Please see the documentation for more details and examples.
Example
const [response] = await client.createApplication(request);

deleteApplication(request, optionsopt) → {Promise}

Deletes specified application.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The resource name of the application to be deleted.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteApplication(request);

getApplication(request, optionsopt) → {Promise}

Retrieves specified application.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The resource name of the application to be retrieved.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Application. Please see the documentation for more details and examples.
Example
const [response] = await client.getApplication(request);

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.

listApplications(request, optionsopt) → {Promise}

Lists all applications associated with the profile.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
pageToken string

The starting indicator from which to return results.
pageSize number

The maximum number of applications to be returned, at most 100. Default is 100 if a non-positive number is provided.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Application. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listApplicationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApplicationsAsync(request, optionsopt) → {Object}

Equivalent to listApplications, 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
Name Type Description
parent string

Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
pageToken string

The starting indicator from which to return results.
pageSize number

The maximum number of applications to be returned, at most 100. Default is 100 if a non-positive number is provided.
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 Application. 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
const iterable = client.listApplicationsAsync(request);
for await (const response of iterable) {
  // process response
}

listApplicationsStream(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
Name Type Description
parent string

Required. Resource name of the profile under which the application is created.

The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
pageToken string

The starting indicator from which to return results.
pageSize number

The maximum number of applications to be returned, at most 100. Default is 100 if a non-positive number is provided.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Application 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 listApplicationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchApplicationFromApplicationName(applicationName) → {string}

Parse the application from Application resource.

Parameters:
Name Type Description
applicationName string

A fully-qualified path representing Application resource.
Returns:
Type Description
string

A string representing the application.

matchCompanyFromProjectCompanyName(projectCompanyName) → {string}

Parse the company from ProjectCompany resource.

Parameters:
Name Type Description
projectCompanyName string

A fully-qualified path representing project_company resource.
Returns:
Type Description
string

A string representing the company.

matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName) → {string}

Parse the company from ProjectTenantCompany resource.

Parameters:
Name Type Description
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.
Returns:
Type Description
string

A string representing the company.

matchJobFromProjectJobName(projectJobName) → {string}

Parse the job from ProjectJob resource.

Parameters:
Name Type Description
projectJobName string

A fully-qualified path representing project_job resource.
Returns:
Type Description
string

A string representing the job.

matchJobFromProjectTenantJobName(projectTenantJobName) → {string}

Parse the job from ProjectTenantJob resource.

Parameters:
Name Type Description
projectTenantJobName string

A fully-qualified path representing project_tenant_job resource.
Returns:
Type Description
string

A string representing the job.

matchProfileFromApplicationName(applicationName) → {string}

Parse the profile from Application resource.

Parameters:
Name Type Description
applicationName string

A fully-qualified path representing Application resource.
Returns:
Type Description
string

A string representing the profile.

matchProfileFromProfileName(profileName) → {string}

Parse the profile from Profile resource.

Parameters:
Name Type Description
profileName string

A fully-qualified path representing Profile resource.
Returns:
Type Description
string

A string representing the profile.

matchProjectFromApplicationName(applicationName) → {string}

Parse the project from Application resource.

Parameters:
Name Type Description
applicationName string

A fully-qualified path representing Application resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProfileName(profileName) → {string}

Parse the project from Profile resource.

Parameters:
Name Type Description
profileName string

A fully-qualified path representing Profile resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectCompanyName(projectCompanyName) → {string}

Parse the project from ProjectCompany resource.

Parameters:
Name Type Description
projectCompanyName string

A fully-qualified path representing project_company resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectJobName(projectJobName) → {string}

Parse the project from ProjectJob resource.

Parameters:
Name Type Description
projectJobName string

A fully-qualified path representing project_job resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectTenantCompanyName(projectTenantCompanyName) → {string}

Parse the project from ProjectTenantCompany resource.

Parameters:
Name Type Description
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectTenantJobName(projectTenantJobName) → {string}

Parse the project from ProjectTenantJob resource.

Parameters:
Name Type Description
projectTenantJobName string

A fully-qualified path representing project_tenant_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.

matchTenantFromApplicationName(applicationName) → {string}

Parse the tenant from Application resource.

Parameters:
Name Type Description
applicationName string

A fully-qualified path representing Application resource.
Returns:
Type Description
string

A string representing the tenant.

matchTenantFromProfileName(profileName) → {string}

Parse the tenant from Profile resource.

Parameters:
Name Type Description
profileName string

A fully-qualified path representing Profile resource.
Returns:
Type Description
string

A string representing the tenant.

matchTenantFromProjectTenantCompanyName(projectTenantCompanyName) → {string}

Parse the tenant from ProjectTenantCompany resource.

Parameters:
Name Type Description
projectTenantCompanyName string

A fully-qualified path representing project_tenant_company resource.
Returns:
Type Description
string

A string representing the tenant.

matchTenantFromProjectTenantJobName(projectTenantJobName) → {string}

Parse the tenant from ProjectTenantJob resource.

Parameters:
Name Type Description
projectTenantJobName string

A fully-qualified path representing project_tenant_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.

profilePath(project, tenant, profile) → {string}

Return a fully-qualified profile resource name string.

Parameters:
Name Type Description
project string
tenant string
profile string
Returns:
Type Description
string

Resource name string.

projectCompanyPath(project, company) → {string}

Return a fully-qualified projectCompany resource name string.

Parameters:
Name Type Description
project string
company string
Returns:
Type Description
string

Resource name string.

projectJobPath(project, job) → {string}

Return a fully-qualified projectJob resource name string.

Parameters:
Name Type Description
project string
job string
Returns:
Type Description
string

Resource name string.

projectTenantCompanyPath(project, tenant, company) → {string}

Return a fully-qualified projectTenantCompany resource name string.

Parameters:
Name Type Description
project string
tenant string
company string
Returns:
Type Description
string

Resource name string.

projectTenantJobPath(project, tenant, job) → {string}

Return a fully-qualified projectTenantJob resource name string.

Parameters:
Name Type Description
project string
tenant string
job string
Returns:
Type Description
string

Resource name string.

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.

updateApplication(request, optionsopt) → {Promise}

Updates specified application.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
application google.cloud.talent.v4beta1.Application

Required. The application resource to replace the current resource in the system.
updateMask google.protobuf.FieldMask

Strongly recommended for the best service experience.

If update_mask is provided, only the specified fields in application are updated. Otherwise all the fields are updated.

A field mask to specify the application fields to be updated. Only top level fields of Application are supported.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Application. Please see the documentation for more details and examples.
Example
const [response] = await client.updateApplication(request);