TenantServiceClient

TenantServiceClient

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

Constructor

new TenantServiceClient(optionsopt)

Construct an instance of TenantServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

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.
promise function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

createTenant(request, optionsopt, callbackopt) → {Promise}

Creates a new tenant 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 project under which the tenant is created.

The format is "projects/{project_id}", for example, "projects/foo".
tenant Object

Required. The tenant to be created.

This object should have the same structure as Tenant
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Tenant.
Source:
Example
const talent = require('@google-cloud/talent');

const client = new talent.v4beta1.TenantServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
const tenant = {};
const request = {
  parent: formattedParent,
  tenant: tenant,
};
client.createTenant(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteTenant(request, optionsopt, callbackopt) → {Promise}

Deletes specified tenant.

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 tenant to be deleted.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Source:
Example
const talent = require('@google-cloud/talent');

const client = new talent.v4beta1.TenantServiceClient({
  // optional auth parameters.
});

const formattedName = client.tenantPath('[PROJECT]', '[TENANT]');
client.deleteTenant({name: formattedName}).catch(err => {
  console.error(err);
});

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

getTenant(request, optionsopt, callbackopt) → {Promise}

Retrieves specified tenant.

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 tenant to be retrieved.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Tenant.
Source:
Example
const talent = require('@google-cloud/talent');

const client = new talent.v4beta1.TenantServiceClient({
  // optional auth parameters.
});

const formattedName = client.tenantPath('[PROJECT]', '[TENANT]');
client.getTenant({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

listTenants(request, optionsopt, callbackopt) → {Promise}

Lists all tenants associated with the project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Resource name of the project under which the tenant is created.

The format is "projects/{project_id}", for example, "projects/foo".
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is Array of Tenant.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListTenantsResponse.
Source:
Example
const talent = require('@google-cloud/talent');

const client = new talent.v4beta1.TenantServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.projectPath('[PROJECT]');

client.listTenants({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.projectPath('[PROJECT]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listTenants(nextRequest, options).then(callback);
  }
}
client.listTenants({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listTenantsStream(request, optionsopt) → {Stream}

Equivalent to listTenants, but returns a NodeJS Stream object.

This fetches the paged responses for listTenants continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Resource name of the project under which the tenant is created.

The format is "projects/{project_id}", for example, "projects/foo".
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Source:
See:
Example
const talent = require('@google-cloud/talent');

const client = new talent.v4beta1.TenantServiceClient({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.listTenantsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

matchProjectFromProjectName(projectName) → {String}

Parse the projectName from a project resource.

Parameters:
Name Type Description
projectName String

A fully-qualified path representing a project resources.
Source:

matchProjectFromTenantName(tenantName) → {String}

Parse the tenantName from a tenant resource.

Parameters:
Name Type Description
tenantName String

A fully-qualified path representing a tenant resources.
Source:

matchTenantFromTenantName(tenantName) → {String}

Parse the tenantName from a tenant resource.

Parameters:
Name Type Description
tenantName String

A fully-qualified path representing a tenant resources.
Source:

projectPath(project) → {String}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project String
Source:

tenantPath(project, tenant) → {String}

Return a fully-qualified tenant resource name string.

Parameters:
Name Type Description
project String
tenant String
Source:

updateTenant(request, optionsopt, callbackopt) → {Promise}

Updates specified tenant.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
tenant Object

Required. The tenant resource to replace the current resource in the system.

This object should have the same structure as Tenant
updateMask Object <optional>

Strongly recommended for the best service experience.

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

A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported.

This object should have the same structure as FieldMask
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Tenant.
Source:
Example
const talent = require('@google-cloud/talent');

const client = new talent.v4beta1.TenantServiceClient({
  // optional auth parameters.
});

const tenant = {};
client.updateTenant({tenant: tenant})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });