import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * The IDS Service * @class * @memberof v1 */ export declare class IDSClient { 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; }; operationsClient: gax.OperationsClient; iDSStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of IDSClient. * * @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 IDSClient({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; /** * Gets details of a single Endpoint. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the endpoint to retrieve. * Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` * @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.ids.v1.Endpoint|Endpoint}. * 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/v1/i_d_s.get_endpoint.js * region_tag:ids_v1_generated_IDS_GetEndpoint_async */ getEndpoint(request?: protos.google.cloud.ids.v1.IGetEndpointRequest, options?: CallOptions): Promise<[ protos.google.cloud.ids.v1.IEndpoint, protos.google.cloud.ids.v1.IGetEndpointRequest | undefined, {} | undefined ]>; getEndpoint(request: protos.google.cloud.ids.v1.IGetEndpointRequest, options: CallOptions, callback: Callback): void; getEndpoint(request: protos.google.cloud.ids.v1.IGetEndpointRequest, callback: Callback): void; /** * Creates a new Endpoint in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The endpoint's parent. * @param {string} request.endpointId * Required. The endpoint identifier. This will be part of the endpoint's * resource name. * This value must start with a lowercase letter followed by up to 62 * lowercase letters, numbers, or hyphens, and cannot end with a hyphen. * Values that do not match this pattern will trigger an INVALID_ARGUMENT * error. * @param {google.cloud.ids.v1.Endpoint} request.endpoint * Required. The endpoint to create. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID * so that if you must retry your request, the server will know to ignore * the request if it has already been completed. The server will guarantee * that for at least 60 minutes since the first request. * * For example, consider a situation where you make an initial request and t * he request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. * * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @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 * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/i_d_s.create_endpoint.js * region_tag:ids_v1_generated_IDS_CreateEndpoint_async */ createEndpoint(request?: protos.google.cloud.ids.v1.ICreateEndpointRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createEndpoint(request: protos.google.cloud.ids.v1.ICreateEndpointRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createEndpoint(request: protos.google.cloud.ids.v1.ICreateEndpointRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createEndpoint()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/i_d_s.create_endpoint.js * region_tag:ids_v1_generated_IDS_CreateEndpoint_async */ checkCreateEndpointProgress(name: string): Promise>; /** * Deletes a single Endpoint. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the endpoint to delete. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID * so that if you must retry your request, the server will know to ignore * the request if it has already been completed. The server will guarantee * that for at least 60 minutes after the first request. * * For example, consider a situation where you make an initial request and t * he request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. * * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @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 * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/i_d_s.delete_endpoint.js * region_tag:ids_v1_generated_IDS_DeleteEndpoint_async */ deleteEndpoint(request?: protos.google.cloud.ids.v1.IDeleteEndpointRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteEndpoint(request: protos.google.cloud.ids.v1.IDeleteEndpointRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteEndpoint(request: protos.google.cloud.ids.v1.IDeleteEndpointRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteEndpoint()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/i_d_s.delete_endpoint.js * region_tag:ids_v1_generated_IDS_DeleteEndpoint_async */ checkDeleteEndpointProgress(name: string): Promise>; /** * Lists Endpoints in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent, which owns this collection of endpoints. * @param {number} [request.pageSize] * Optional. The maximum number of endpoints to return. The service may return fewer * than this value. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListEndpoints` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListEndpoints` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. The filter expression, following the syntax outlined in * https://google.aip.dev/160. * @param {string} [request.orderBy] * Optional. One or more fields to compare and use to sort the output. * See https://google.aip.dev/132#ordering. * @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.ids.v1.Endpoint|Endpoint}. * 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 `listEndpointsAsync()` * 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. */ listEndpoints(request?: protos.google.cloud.ids.v1.IListEndpointsRequest, options?: CallOptions): Promise<[ protos.google.cloud.ids.v1.IEndpoint[], protos.google.cloud.ids.v1.IListEndpointsRequest | null, protos.google.cloud.ids.v1.IListEndpointsResponse ]>; listEndpoints(request: protos.google.cloud.ids.v1.IListEndpointsRequest, options: CallOptions, callback: PaginationCallback): void; listEndpoints(request: protos.google.cloud.ids.v1.IListEndpointsRequest, callback: PaginationCallback): void; /** * Equivalent to `listEndpoints`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent, which owns this collection of endpoints. * @param {number} [request.pageSize] * Optional. The maximum number of endpoints to return. The service may return fewer * than this value. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListEndpoints` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListEndpoints` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. The filter expression, following the syntax outlined in * https://google.aip.dev/160. * @param {string} [request.orderBy] * Optional. One or more fields to compare and use to sort the output. * See https://google.aip.dev/132#ordering. * @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.ids.v1.Endpoint|Endpoint} 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 `listEndpointsAsync()` * 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. */ listEndpointsStream(request?: protos.google.cloud.ids.v1.IListEndpointsRequest, options?: CallOptions): Transform; /** * Equivalent to `listEndpoints`, 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. The parent, which owns this collection of endpoints. * @param {number} [request.pageSize] * Optional. The maximum number of endpoints to return. The service may return fewer * than this value. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListEndpoints` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListEndpoints` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. The filter expression, following the syntax outlined in * https://google.aip.dev/160. * @param {string} [request.orderBy] * Optional. One or more fields to compare and use to sort the output. * See https://google.aip.dev/132#ordering. * @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.ids.v1.Endpoint|Endpoint}. 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/v1/i_d_s.list_endpoints.js * region_tag:ids_v1_generated_IDS_ListEndpoints_async */ listEndpointsAsync(request?: protos.google.cloud.ids.v1.IListEndpointsRequest, options?: CallOptions): AsyncIterable; /** * Return a fully-qualified endpoint resource name string. * * @param {string} project * @param {string} location * @param {string} endpoint * @returns {string} Resource name string. */ endpointPath(project: string, location: string, endpoint: string): string; /** * Parse the project from Endpoint resource. * * @param {string} endpointName * A fully-qualified path representing Endpoint resource. * @returns {string} A string representing the project. */ matchProjectFromEndpointName(endpointName: string): string | number; /** * Parse the location from Endpoint resource. * * @param {string} endpointName * A fully-qualified path representing Endpoint resource. * @returns {string} A string representing the location. */ matchLocationFromEndpointName(endpointName: string): string | number; /** * Parse the endpoint from Endpoint resource. * * @param {string} endpointName * A fully-qualified path representing Endpoint resource. * @returns {string} A string representing the endpoint. */ matchEndpointFromEndpointName(endpointName: string): string | number; /** * Return a fully-qualified location resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ locationPath(project: string, location: string): string; /** * Parse the project from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the project. */ matchProjectFromLocationName(locationName: string): string | number; /** * Parse the location from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the location. */ matchLocationFromLocationName(locationName: string): string | number; /** * 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; /** * 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; }