import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * A service that handles tenant management, including CRUD and enumeration. * @class * @memberof v4beta1 */ export declare class TenantServiceClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; pathTemplates: { [name: string]: gax.PathTemplate; }; tenantServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of TenantServiceClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - 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. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - 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 * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you * need to avoid loading the default gRPC version and want to use the fallback * HTTP implementation. Load only fallback version and pass it to the constructor: * ``` * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC * const client = new TenantServiceClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * 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 {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * Creates a new tenant entity. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Resource name of the project under which the tenant is created. * * The format is "projects/{project_id}", for example, * "projects/foo". * @param {google.cloud.talent.v4beta1.Tenant} request.tenant * Required. The tenant to be created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.talent.v4beta1.Tenant|Tenant}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v4beta1/tenant_service.create_tenant.js * region_tag:jobs_v4beta1_generated_TenantService_CreateTenant_async */ createTenant(request?: protos.google.cloud.talent.v4beta1.ICreateTenantRequest, options?: CallOptions): Promise<[ protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.ICreateTenantRequest | undefined, {} | undefined ]>; createTenant(request: protos.google.cloud.talent.v4beta1.ICreateTenantRequest, options: CallOptions, callback: Callback): void; createTenant(request: protos.google.cloud.talent.v4beta1.ICreateTenantRequest, callback: Callback): void; /** * Retrieves specified tenant. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * 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". * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.talent.v4beta1.Tenant|Tenant}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v4beta1/tenant_service.get_tenant.js * region_tag:jobs_v4beta1_generated_TenantService_GetTenant_async */ getTenant(request?: protos.google.cloud.talent.v4beta1.IGetTenantRequest, options?: CallOptions): Promise<[ protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IGetTenantRequest | undefined, {} | undefined ]>; getTenant(request: protos.google.cloud.talent.v4beta1.IGetTenantRequest, options: CallOptions, callback: Callback): void; getTenant(request: protos.google.cloud.talent.v4beta1.IGetTenantRequest, callback: Callback): void; /** * Updates specified tenant. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.talent.v4beta1.Tenant} request.tenant * Required. The tenant resource to replace the current resource in the * system. * @param {google.protobuf.FieldMask} request.updateMask * Strongly recommended for the best service experience. * * If * {@link protos.google.cloud.talent.v4beta1.UpdateTenantRequest.update_mask|update_mask} * is provided, only the specified fields in * {@link protos.google.cloud.talent.v4beta1.UpdateTenantRequest.tenant|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 {@link protos.google.cloud.talent.v4beta1.Tenant|Tenant} are * supported. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.talent.v4beta1.Tenant|Tenant}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v4beta1/tenant_service.update_tenant.js * region_tag:jobs_v4beta1_generated_TenantService_UpdateTenant_async */ updateTenant(request?: protos.google.cloud.talent.v4beta1.IUpdateTenantRequest, options?: CallOptions): Promise<[ protos.google.cloud.talent.v4beta1.ITenant, protos.google.cloud.talent.v4beta1.IUpdateTenantRequest | undefined, {} | undefined ]>; updateTenant(request: protos.google.cloud.talent.v4beta1.IUpdateTenantRequest, options: CallOptions, callback: Callback): void; updateTenant(request: protos.google.cloud.talent.v4beta1.IUpdateTenantRequest, callback: Callback): void; /** * Deletes specified tenant. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * 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". * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v4beta1/tenant_service.delete_tenant.js * region_tag:jobs_v4beta1_generated_TenantService_DeleteTenant_async */ deleteTenant(request?: protos.google.cloud.talent.v4beta1.IDeleteTenantRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.talent.v4beta1.IDeleteTenantRequest | undefined, {} | undefined ]>; deleteTenant(request: protos.google.cloud.talent.v4beta1.IDeleteTenantRequest, options: CallOptions, callback: Callback): void; deleteTenant(request: protos.google.cloud.talent.v4beta1.IDeleteTenantRequest, callback: Callback): void; /** * Lists all tenants associated with the project. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Resource name of the project under which the tenant is created. * * The format is "projects/{project_id}", for example, * "projects/foo". * @param {string} request.pageToken * The starting indicator from which to return results. * @param {number} request.pageSize * The maximum number of tenants to be returned, at most 100. * Default is 100 if a non-positive number is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.talent.v4beta1.Tenant|Tenant}. * 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 `listTenantsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTenants(request?: protos.google.cloud.talent.v4beta1.IListTenantsRequest, options?: CallOptions): Promise<[ protos.google.cloud.talent.v4beta1.ITenant[], protos.google.cloud.talent.v4beta1.IListTenantsRequest | null, protos.google.cloud.talent.v4beta1.IListTenantsResponse ]>; listTenants(request: protos.google.cloud.talent.v4beta1.IListTenantsRequest, options: CallOptions, callback: PaginationCallback): void; listTenants(request: protos.google.cloud.talent.v4beta1.IListTenantsRequest, callback: PaginationCallback): void; /** * Equivalent to `listTenants`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Resource name of the project under which the tenant is created. * * The format is "projects/{project_id}", for example, * "projects/foo". * @param {string} request.pageToken * The starting indicator from which to return results. * @param {number} request.pageSize * The maximum number of tenants to be returned, at most 100. * Default is 100 if a non-positive number is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.talent.v4beta1.Tenant|Tenant} 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 `listTenantsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTenantsStream(request?: protos.google.cloud.talent.v4beta1.IListTenantsRequest, options?: CallOptions): Transform; /** * Equivalent to `listTenants`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Resource name of the project under which the tenant is created. * * The format is "projects/{project_id}", for example, * "projects/foo". * @param {string} request.pageToken * The starting indicator from which to return results. * @param {number} request.pageSize * The maximum number of tenants to be returned, at most 100. * Default is 100 if a non-positive number is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.talent.v4beta1.Tenant|Tenant}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v4beta1/tenant_service.list_tenants.js * region_tag:jobs_v4beta1_generated_TenantService_ListTenants_async */ listTenantsAsync(request?: protos.google.cloud.talent.v4beta1.IListTenantsRequest, options?: CallOptions): AsyncIterable; /** * Return a fully-qualified project resource name string. * * @param {string} project * @returns {string} Resource name string. */ projectPath(project: string): string; /** * Parse the project from Project resource. * * @param {string} projectName * A fully-qualified path representing Project resource. * @returns {string} A string representing the project. */ matchProjectFromProjectName(projectName: string): string | number; /** * Return a fully-qualified projectCompany resource name string. * * @param {string} project * @param {string} company * @returns {string} Resource name string. */ projectCompanyPath(project: string, company: string): string; /** * Parse the project from ProjectCompany resource. * * @param {string} projectCompanyName * A fully-qualified path representing project_company resource. * @returns {string} A string representing the project. */ matchProjectFromProjectCompanyName(projectCompanyName: string): string | number; /** * Parse the company from ProjectCompany resource. * * @param {string} projectCompanyName * A fully-qualified path representing project_company resource. * @returns {string} A string representing the company. */ matchCompanyFromProjectCompanyName(projectCompanyName: string): string | number; /** * Return a fully-qualified projectJob resource name string. * * @param {string} project * @param {string} job * @returns {string} Resource name string. */ projectJobPath(project: string, job: string): string; /** * Parse the project from ProjectJob resource. * * @param {string} projectJobName * A fully-qualified path representing project_job resource. * @returns {string} A string representing the project. */ matchProjectFromProjectJobName(projectJobName: string): string | number; /** * Parse the job from ProjectJob resource. * * @param {string} projectJobName * A fully-qualified path representing project_job resource. * @returns {string} A string representing the job. */ matchJobFromProjectJobName(projectJobName: string): string | number; /** * Return a fully-qualified projectTenantCompany resource name string. * * @param {string} project * @param {string} tenant * @param {string} company * @returns {string} Resource name string. */ projectTenantCompanyPath(project: string, tenant: string, company: string): string; /** * Parse the project from ProjectTenantCompany resource. * * @param {string} projectTenantCompanyName * A fully-qualified path representing project_tenant_company resource. * @returns {string} A string representing the project. */ matchProjectFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number; /** * Parse the tenant from ProjectTenantCompany resource. * * @param {string} projectTenantCompanyName * A fully-qualified path representing project_tenant_company resource. * @returns {string} A string representing the tenant. */ matchTenantFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number; /** * Parse the company from ProjectTenantCompany resource. * * @param {string} projectTenantCompanyName * A fully-qualified path representing project_tenant_company resource. * @returns {string} A string representing the company. */ matchCompanyFromProjectTenantCompanyName(projectTenantCompanyName: string): string | number; /** * Return a fully-qualified projectTenantJob resource name string. * * @param {string} project * @param {string} tenant * @param {string} job * @returns {string} Resource name string. */ projectTenantJobPath(project: string, tenant: string, job: string): string; /** * Parse the project from ProjectTenantJob resource. * * @param {string} projectTenantJobName * A fully-qualified path representing project_tenant_job resource. * @returns {string} A string representing the project. */ matchProjectFromProjectTenantJobName(projectTenantJobName: string): string | number; /** * Parse the tenant from ProjectTenantJob resource. * * @param {string} projectTenantJobName * A fully-qualified path representing project_tenant_job resource. * @returns {string} A string representing the tenant. */ matchTenantFromProjectTenantJobName(projectTenantJobName: string): string | number; /** * Parse the job from ProjectTenantJob resource. * * @param {string} projectTenantJobName * A fully-qualified path representing project_tenant_job resource. * @returns {string} A string representing the job. */ matchJobFromProjectTenantJobName(projectTenantJobName: string): string | number; /** * Return a fully-qualified tenant resource name string. * * @param {string} project * @param {string} tenant * @returns {string} Resource name string. */ tenantPath(project: string, tenant: string): string; /** * Parse the project from Tenant resource. * * @param {string} tenantName * A fully-qualified path representing Tenant resource. * @returns {string} A string representing the project. */ matchProjectFromTenantName(tenantName: string): string | number; /** * Parse the tenant from Tenant resource. * * @param {string} tenantName * A fully-qualified path representing Tenant resource. * @returns {string} A string representing the tenant. */ matchTenantFromTenantName(tenantName: string): string | number; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }