Class v4beta1.ProfileServiceClient (4.1.1)

A service that handles profile management, including profile CRUD, enumeration and search. v4beta1

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ProfileServiceClient.

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.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

profileServiceStub

profileServiceStub?: Promise<{
        [name: string]: Function;
    }>;

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

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

Name	Description
project	`string`
tenant	`string`
profile	`string`
application	`string`

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.

createProfile(request, options)

createProfile(request?: protos.google.cloud.talent.v4beta1.ICreateProfileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.talent.v4beta1.IProfile,
        protos.google.cloud.talent.v4beta1.ICreateProfileRequest | undefined,
        {} | undefined
    ]>;

Creates and returns a new profile.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.ICreateProfileRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.ICreateProfileRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Profile]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the tenant this profile belongs to.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Required. The profile to be created.
   */
  // const profile = {}

  // Imports the Talent library
  const {ProfileServiceClient} = require('@google-cloud/talent').v4beta1;

  // Instantiates a client
  const talentClient = new ProfileServiceClient();

  async function callCreateProfile() {
    // Construct request
    const request = {
      parent,
      profile,
    };

    // Run request
    const response = await talentClient.createProfile(request);
    console.log(response);
  }

  callCreateProfile();

createProfile(request, options, callback)

createProfile(request: protos.google.cloud.talent.v4beta1.ICreateProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.ICreateProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.ICreateProfileRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.ICreateProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createProfile(request, callback)

createProfile(request: protos.google.cloud.talent.v4beta1.ICreateProfileRequest, callback: Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.ICreateProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.ICreateProfileRequest`
callback	`Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.ICreateProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteProfile(request, options)

deleteProfile(request?: protos.google.cloud.talent.v4beta1.IDeleteProfileRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.talent.v4beta1.IDeleteProfileRequest | undefined,
        {} | undefined
    ]>;

Deletes the specified profile. Prerequisite: The profile has no associated applications or assignments associated.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IDeleteProfileRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteProfileRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the profile to be deleted.
   *  The format is
   *  "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For
   *  example, "projects/foo/tenants/bar/profiles/baz".
   */
  // const name = 'abc123'

  // Imports the Talent library
  const {ProfileServiceClient} = require('@google-cloud/talent').v4beta1;

  // Instantiates a client
  const talentClient = new ProfileServiceClient();

  async function callDeleteProfile() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await talentClient.deleteProfile(request);
    console.log(response);
  }

  callDeleteProfile();

deleteProfile(request, options, callback)

deleteProfile(request: protos.google.cloud.talent.v4beta1.IDeleteProfileRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IDeleteProfileRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteProfile(request, callback)

deleteProfile(request: protos.google.cloud.talent.v4beta1.IDeleteProfileRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IDeleteProfileRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProfile(request, options)

getProfile(request?: protos.google.cloud.talent.v4beta1.IGetProfileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.talent.v4beta1.IProfile,
        protos.google.cloud.talent.v4beta1.IGetProfileRequest | undefined,
        {} | undefined
    ]>;

Gets the specified profile.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IGetProfileRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IGetProfileRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Profile]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the profile to get.
   *  The format is
   *  "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For
   *  example, "projects/foo/tenants/bar/profiles/baz".
   */
  // const name = 'abc123'

  // Imports the Talent library
  const {ProfileServiceClient} = require('@google-cloud/talent').v4beta1;

  // Instantiates a client
  const talentClient = new ProfileServiceClient();

  async function callGetProfile() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await talentClient.getProfile(request);
    console.log(response);
  }

  callGetProfile();

getProfile(request, options, callback)

getProfile(request: protos.google.cloud.talent.v4beta1.IGetProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IGetProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IGetProfileRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IGetProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProfile(request, callback)

getProfile(request: protos.google.cloud.talent.v4beta1.IGetProfileRequest, callback: Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IGetProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IGetProfileRequest`
callback	`Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IGetProfileRequest \| 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.

listProfiles(request, options)

listProfiles(request?: protos.google.cloud.talent.v4beta1.IListProfilesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.talent.v4beta1.IProfile[],
        protos.google.cloud.talent.v4beta1.IListProfilesRequest | null,
        protos.google.cloud.talent.v4beta1.IListProfilesResponse
    ]>;

Lists profiles by filter. The order is unspecified.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IListProfilesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[ protos.google.cloud.talent.v4beta1.IProfile[], protos.google.cloud.talent.v4beta1.IListProfilesRequest | null, protos.google.cloud.talent.v4beta1.IListProfilesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Profile]. 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 listProfilesAsync() 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.

listProfiles(request, options, callback)

listProfiles(request: protos.google.cloud.talent.v4beta1.IListProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.talent.v4beta1.IListProfilesRequest, protos.google.cloud.talent.v4beta1.IListProfilesResponse | null | undefined, protos.google.cloud.talent.v4beta1.IProfile>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IListProfilesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.talent.v4beta1.IListProfilesRequest, protos.google.cloud.talent.v4beta1.IListProfilesResponse \| null \| undefined, protos.google.cloud.talent.v4beta1.IProfile>`

Returns

Type	Description
void

listProfiles(request, callback)

listProfiles(request: protos.google.cloud.talent.v4beta1.IListProfilesRequest, callback: PaginationCallback<protos.google.cloud.talent.v4beta1.IListProfilesRequest, protos.google.cloud.talent.v4beta1.IListProfilesResponse | null | undefined, protos.google.cloud.talent.v4beta1.IProfile>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IListProfilesRequest`
callback	`PaginationCallback<protos.google.cloud.talent.v4beta1.IListProfilesRequest, protos.google.cloud.talent.v4beta1.IListProfilesResponse \| null \| undefined, protos.google.cloud.talent.v4beta1.IProfile>`

Returns

Type	Description
void

listProfilesAsync(request, options)

listProfilesAsync(request?: protos.google.cloud.talent.v4beta1.IListProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.talent.v4beta1.IProfile>;

Equivalent to listProfiles, 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.IListProfilesRequest` 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.IProfile>

{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 [Profile]. 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.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the tenant under which the profile is created.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  The filter string specifies the profiles to be enumerated.
   *  Supported operator: =, AND
   *  The field(s) eligible for filtering are:
   *  * `externalId`
   *  * `groupId`
   *  externalId and groupId cannot be specified at the same time. If both
   *  externalId and groupId are provided, the API will return a bad request
   *  error.
   *  Sample Query:
   *  * externalId = "externalId-1"
   *  * groupId = "groupId-1"
   */
  // const filter = 'abc123'
  /**
   *  The token that specifies the current offset (that is, starting result).
   *  Please set the value to ListProfilesResponse.next_page_token google.cloud.talent.v4beta1.ListProfilesResponse.next_page_token  to
   *  continue the list.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of profiles to be returned, at most 100.
   *  Default is 100 unless a positive number smaller than 100 is specified.
   */
  // const pageSize = 1234
  /**
   *  A field mask to specify the profile fields to be listed in response.
   *  All fields are listed if it is unset.
   *  Valid values are:
   *  * name
   */
  // const readMask = {}

  // Imports the Talent library
  const {ProfileServiceClient} = require('@google-cloud/talent').v4beta1;

  // Instantiates a client
  const talentClient = new ProfileServiceClient();

  async function callListProfiles() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await talentClient.listProfilesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListProfiles();

listProfilesStream(request, options)

listProfilesStream(request?: protos.google.cloud.talent.v4beta1.IListProfilesRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IListProfilesRequest` 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 [Profile] 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 listProfilesAsync() 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

Name	Description
project	`string`
tenant	`string`
profile	`string`

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

Name	Description
project	`string`
company	`string`

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

Name	Description
project	`string`
job	`string`

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

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

Name	Description
project	`string`
tenant	`string`
company	`string`

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

Name	Description
project	`string`
tenant	`string`
job	`string`

Returns

Type	Description
string	{string} Resource name string.

searchProfiles(request, options)

searchProfiles(request?: protos.google.cloud.talent.v4beta1.ISearchProfilesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.talent.v4beta1.ISearchProfilesResponse,
        protos.google.cloud.talent.v4beta1.ISearchProfilesRequest | undefined,
        {} | undefined
    ]>;

Searches for profiles within a tenant.

For example, search by raw queries "software engineer in Mountain View" or search by structured filters (location filter, education filter, etc.).

See for more information.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.ISearchProfilesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.talent.v4beta1.ISearchProfilesResponse, protos.google.cloud.talent.v4beta1.ISearchProfilesRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [SearchProfilesResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the tenant to search within.
   *  The format is "projects/{project_id}/tenants/{tenant_id}". For example,
   *  "projects/foo/tenants/bar".
   */
  // const parent = 'abc123'
  /**
   *  Required. The meta information collected about the profile search user. This is used
   *  to improve the search quality of the service. These values are provided by
   *  users, and must be precise and consistent.
   */
  // const requestMetadata = {}
  /**
   *  Search query to execute. See ProfileQuery google.cloud.talent.v4beta1.ProfileQuery  for more details.
   */
  // const profileQuery = {}
  /**
   *  A limit on the number of profiles returned in the search results.
   *  A value above the default value 10 can increase search response time.
   *  The maximum value allowed is 100. Otherwise an error is thrown.
   */
  // const pageSize = 1234
  /**
   *  The pageToken, similar to offset enables users of the API to paginate
   *  through the search results. To retrieve the first page of results, set the
   *  pageToken to empty. The search response includes a
   *  nextPageToken google.cloud.talent.v4beta1.SearchProfilesResponse.next_page_token  field that can be
   *  used to populate the pageToken field for the next page of results. Using
   *  pageToken instead of offset increases the performance of the API,
   *  especially compared to larger offset values.
   */
  // const pageToken = 'abc123'
  /**
   *  An integer that specifies the current offset (that is, starting result) in
   *  search results. This field is only considered if page_token google.cloud.talent.v4beta1.SearchProfilesRequest.page_token  is unset.
   *  The maximum allowed value is 5000. Otherwise an error is thrown.
   *  For example, 0 means to search from the first profile, and 10 means to
   *  search from the 11th profile. This can be used for pagination, for example
   *  pageSize = 10 and offset = 10 means to search from the second page.
   */
  // const offset = 1234
  /**
   *  This flag controls the spell-check feature. If `false`, the
   *  service attempts to correct a misspelled query.
   *  For example, "enginee" is corrected to "engineer".
   */
  // const disableSpellCheck = true
  /**
   *  The criteria that determines how search results are sorted.
   *  Defaults is "relevance desc" if no value is specified.
   *  Supported options are:
   *  * "relevance desc": By descending relevance, as determined by the API
   *     algorithms.
   *  * "update_date desc": Sort by Profile.update_time google.cloud.talent.v4beta1.Profile.update_time  in descending order
   *    (recently updated profiles first).
   *  * "create_date desc": Sort by Profile.create_time google.cloud.talent.v4beta1.Profile.create_time  in descending order
   *    (recently created profiles first).
   *  * "first_name": Sort by PersonName.PersonStructuredName.given_name google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name  in
   *    ascending order.
   *  * "first_name desc": Sort by PersonName.PersonStructuredName.given_name google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name 
   *    in descending order.
   *  * "last_name": Sort by PersonName.PersonStructuredName.family_name google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name  in
   *    ascending order.
   *  * "last_name desc": Sort by PersonName.PersonStructuredName.family_name google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name 
   *    in ascending order.
   */
  // const orderBy = 'abc123'
  /**
   *  When sort by field is based on alphabetical order, sort values case
   *  sensitively (based on ASCII) when the value is set to true. Default value
   *  is case in-sensitive sort (false).
   */
  // const caseSensitiveSort = true
  /**
   *  A list of expressions specifies histogram requests against matching
   *  profiles for SearchProfilesRequest google.cloud.talent.v4beta1.SearchProfilesRequest.
   *  The expression syntax looks like a function definition with parameters.
   *  Function syntax: function_name(histogram_facet, list of buckets)
   *  Data types:
   *  * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`.
   *  * String: string like "any string with backslash escape for quote(\")."
   *  * Number: whole number and floating point number like 10, -1 and -0.01.
   *  * List: list of elements with comma(,) separator surrounded by square
   *  brackets. For example, 1, 2, 3 and "one", "two", "three".
   *  Built-in constants:
   *  * MIN (minimum number similar to java Double.MIN_VALUE)
   *  * MAX (maximum number similar to java Double.MAX_VALUE)
   *  Built-in functions:
   *  * bucket(start, end, label)
   *  Bucket build-in function creates a bucket with range of start, end). Note
   *  that the end is exclusive.
   *  For example, bucket(1, MAX, "positive number") or bucket(1, 10).
   *  Histogram Facets:
   *  * admin1: Admin1 is a global placeholder for referring to state, province,
   *  or the particular term a country uses to define the geographic structure
   *  below the country level. Examples include states codes such as "CA", "IL",
   *  "NY", and provinces, such as "BC".
   *  * locality: Locality is a global placeholder for referring to city, town,
   *  or the particular term a country uses to define the geographic structure
   *  below the admin1 level. Examples include city names such as
   *  "Mountain View" and "New York".
   *  * extended_locality: Extended locality is concatenated version of admin1
   *  and locality with comma separator. For example, "Mountain View, CA" and
   *  "New York, NY".
   *  * postal_code: Postal code of profile which follows locale code.
   *  * country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US,
   *   JP, GB.
   *  * job_title: Normalized job titles specified in EmploymentHistory.
   *  * company_name: Normalized company name of profiles to match on.
   *  * institution: The school name. For example, "MIT",
   *  "University of California, Berkeley"
   *  * degree: Highest education degree in ISCED code. Each value in degree
   *  covers a specific level of education, without any expansion to upper nor
   *  lower levels of education degree.
   *  * experience_in_months: experience in months. 0 means 0 month to 1 month
   *  (exclusive).
   *  * application_date: The application date specifies application start dates.
   *  See ApplicationDateFilter google.cloud.talent.v4beta1.ApplicationDateFilter  for more details.
   *  * application_outcome_notes: The application outcome reason specifies the
   *  reasons behind the outcome of the job application.
   *  See ApplicationOutcomeNotesFilter google.cloud.talent.v4beta1.ApplicationOutcomeNotesFilter  for more details.
   *  * application_job_title: The application job title specifies the job
   *  applied for in the application.
   *  See ApplicationJobFilter google.cloud.talent.v4beta1.ApplicationJobFilter  for more details.
   *  * hirable_status: Hirable status specifies the profile's hirable status.
   *  * string_custom_attribute: String custom attributes. Values can be accessed
   *  via square bracket notation like string_custom_attribute"key1".
   *  * numeric_custom_attribute: Numeric custom attributes. Values can be
   *  accessed via square bracket notation like numeric_custom_attribute"key1".
   *  Example expressions:
   *  * count(admin1)
   *  * count(experience_in_months, bucket(0, 12, "1 year"),
   *  bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years"))
   *  * count(string_custom_attribute"assigned_recruiter")
   *  * count(numeric_custom_attribute"favorite_number",
   *  bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"))
   */
  // const histogramQueries = 1234
  /**
   *  An id that uniquely identifies the result set of a
   *  SearchProfiles google.cloud.talent.v4beta1.ProfileService.SearchProfiles  call. The id should be
   *  retrieved from the
   *  SearchProfilesResponse google.cloud.talent.v4beta1.SearchProfilesResponse  message returned from a previous
   *  invocation of SearchProfiles google.cloud.talent.v4beta1.ProfileService.SearchProfiles.
   *  A result set is an ordered list of search results.
   *  If this field is not set, a new result set is computed based on the
   *  profile_query google.cloud.talent.v4beta1.SearchProfilesRequest.profile_query.  A new result_set_id google.cloud.talent.v4beta1.SearchProfilesRequest.result_set_id is returned as a handle to
   *  access this result set.
   *  If this field is set, the service will ignore the resource and
   *  profile_query google.cloud.talent.v4beta1.SearchProfilesRequest.profile_query  values, and simply retrieve a page of results from the
   *  corresponding result set.  In this case, one and only one of page_token google.cloud.talent.v4beta1.SearchProfilesRequest.page_token 
   *  or offset google.cloud.talent.v4beta1.SearchProfilesRequest.offset  must be set.
   *  A typical use case is to invoke SearchProfilesRequest google.cloud.talent.v4beta1.SearchProfilesRequest  without this
   *  field, then use the resulting result_set_id google.cloud.talent.v4beta1.SearchProfilesRequest.result_set_id  in
   *  SearchProfilesResponse google.cloud.talent.v4beta1.SearchProfilesResponse  to page through the results.
   */
  // const resultSetId = 'abc123'
  /**
   *  This flag is used to indicate whether the service will attempt to
   *  understand synonyms and terms related to the search query or treat the
   *  query "as is" when it generates a set of results. By default this flag is
   *  set to false, thus allowing expanded results to also be returned. For
   *  example a search for "software engineer" might also return candidates who
   *  have experience in jobs similar to software engineer positions. By setting
   *  this flag to true, the service will only attempt to deliver candidates has
   *  software engineer in his/her global fields by treating "software engineer"
   *  as a keyword.
   *  It is recommended to provide a feature in the UI (such as a checkbox) to
   *  allow recruiters to set this flag to true if they intend to search for
   *  longer boolean strings.
   */
  // const strictKeywordsSearch = true

  // Imports the Talent library
  const {ProfileServiceClient} = require('@google-cloud/talent').v4beta1;

  // Instantiates a client
  const talentClient = new ProfileServiceClient();

  async function callSearchProfiles() {
    // Construct request
    const request = {
      parent,
      requestMetadata,
    };

    // Run request
    const response = await talentClient.searchProfiles(request);
    console.log(response);
  }

  callSearchProfiles();

searchProfiles(request, options, callback)

searchProfiles(request: protos.google.cloud.talent.v4beta1.ISearchProfilesRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4beta1.ISearchProfilesResponse, protos.google.cloud.talent.v4beta1.ISearchProfilesRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.ISearchProfilesRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.talent.v4beta1.ISearchProfilesResponse, protos.google.cloud.talent.v4beta1.ISearchProfilesRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

searchProfiles(request, callback)

searchProfiles(request: protos.google.cloud.talent.v4beta1.ISearchProfilesRequest, callback: Callback<protos.google.cloud.talent.v4beta1.ISearchProfilesResponse, protos.google.cloud.talent.v4beta1.ISearchProfilesRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.ISearchProfilesRequest`
callback	`Callback<protos.google.cloud.talent.v4beta1.ISearchProfilesResponse, protos.google.cloud.talent.v4beta1.ISearchProfilesRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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.

updateProfile(request, options)

updateProfile(request?: protos.google.cloud.talent.v4beta1.IUpdateProfileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.talent.v4beta1.IProfile,
        protos.google.cloud.talent.v4beta1.IUpdateProfileRequest | undefined,
        {} | undefined
    ]>;

Updates the specified profile and returns the updated result.

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IUpdateProfileRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IUpdateProfileRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Profile]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Profile to be updated.
   */
  // const profile = {}
  /**
   *  A field mask to specify the profile fields to update.
   *  A full update is performed if it is unset.
   */
  // const updateMask = {}

  // Imports the Talent library
  const {ProfileServiceClient} = require('@google-cloud/talent').v4beta1;

  // Instantiates a client
  const talentClient = new ProfileServiceClient();

  async function callUpdateProfile() {
    // Construct request
    const request = {
      profile,
    };

    // Run request
    const response = await talentClient.updateProfile(request);
    console.log(response);
  }

  callUpdateProfile();

updateProfile(request, options, callback)

updateProfile(request: protos.google.cloud.talent.v4beta1.IUpdateProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IUpdateProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IUpdateProfileRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IUpdateProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateProfile(request, callback)

updateProfile(request: protos.google.cloud.talent.v4beta1.IUpdateProfileRequest, callback: Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IUpdateProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.talent.v4beta1.IUpdateProfileRequest`
callback	`Callback<protos.google.cloud.talent.v4beta1.IProfile, protos.google.cloud.talent.v4beta1.IUpdateProfileRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void