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'; /** * Manages instances of a version. * @class * @memberof v1 */ export declare class InstancesClient { 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; instancesStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of InstancesClient. * * @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 InstancesClient({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 instance information. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Name of the resource requested. Example: * `apps/myapp/services/default/versions/v1/instances/instance-1`. * @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.appengine.v1.Instance|Instance}. * 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/instances.get_instance.js * region_tag:appengine_v1_generated_Instances_GetInstance_async */ getInstance(request?: protos.google.appengine.v1.IGetInstanceRequest, options?: CallOptions): Promise<[ protos.google.appengine.v1.IInstance, protos.google.appengine.v1.IGetInstanceRequest | undefined, {} | undefined ]>; getInstance(request: protos.google.appengine.v1.IGetInstanceRequest, options: CallOptions, callback: Callback): void; getInstance(request: protos.google.appengine.v1.IGetInstanceRequest, callback: Callback): void; /** * Stops a running instance. * * The instance might be automatically recreated based on the scaling settings * of the version. For more information, see "How Instances are Managed" * ([standard environment](https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | * [flexible environment](https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)). * * To ensure that instances are not re-created and avoid getting billed, you * can stop all instances within the target version by changing the serving * status of the version to `STOPPED` with the * [`apps.services.versions.patch`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) * method. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Name of the resource requested. Example: * `apps/myapp/services/default/versions/v1/instances/instance-1`. * @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/instances.delete_instance.js * region_tag:appengine_v1_generated_Instances_DeleteInstance_async */ deleteInstance(request?: protos.google.appengine.v1.IDeleteInstanceRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteInstance(request: protos.google.appengine.v1.IDeleteInstanceRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteInstance(request: protos.google.appengine.v1.IDeleteInstanceRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteInstance()`. * @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/instances.delete_instance.js * region_tag:appengine_v1_generated_Instances_DeleteInstance_async */ checkDeleteInstanceProgress(name: string): Promise>; /** * Enables debugging on a VM instance. This allows you to use the SSH * command to connect to the virtual machine where the instance lives. * While in "debug mode", the instance continues to serve live traffic. * You should delete the instance when you are done debugging and then * allow the system to take over and determine if another instance * should be started. * * Only applicable for instances in App Engine flexible environment. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Name of the resource requested. Example: * `apps/myapp/services/default/versions/v1/instances/instance-1`. * @param {string} request.sshKey * Public SSH key to add to the instance. Examples: * * * `[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]` * * `[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}` * * For more information, see * [Adding and Removing SSH Keys](https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). * @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/instances.debug_instance.js * region_tag:appengine_v1_generated_Instances_DebugInstance_async */ debugInstance(request?: protos.google.appengine.v1.IDebugInstanceRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; debugInstance(request: protos.google.appengine.v1.IDebugInstanceRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; debugInstance(request: protos.google.appengine.v1.IDebugInstanceRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `debugInstance()`. * @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/instances.debug_instance.js * region_tag:appengine_v1_generated_Instances_DebugInstance_async */ checkDebugInstanceProgress(name: string): Promise>; /** * Lists the instances of a version. * * Tip: To aggregate details about instances over time, see the * [Stackdriver Monitoring API](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Name of the parent Version resource. Example: * `apps/myapp/services/default/versions/v1`. * @param {number} request.pageSize * Maximum results to return per page. * @param {string} request.pageToken * Continuation token for fetching the next page of results. * @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.appengine.v1.Instance|Instance}. * 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 `listInstancesAsync()` * 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. */ listInstances(request?: protos.google.appengine.v1.IListInstancesRequest, options?: CallOptions): Promise<[ protos.google.appengine.v1.IInstance[], protos.google.appengine.v1.IListInstancesRequest | null, protos.google.appengine.v1.IListInstancesResponse ]>; listInstances(request: protos.google.appengine.v1.IListInstancesRequest, options: CallOptions, callback: PaginationCallback): void; listInstances(request: protos.google.appengine.v1.IListInstancesRequest, callback: PaginationCallback): void; /** * Equivalent to `listInstances`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Name of the parent Version resource. Example: * `apps/myapp/services/default/versions/v1`. * @param {number} request.pageSize * Maximum results to return per page. * @param {string} request.pageToken * Continuation token for fetching the next page of results. * @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.appengine.v1.Instance|Instance} 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 `listInstancesAsync()` * 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. */ listInstancesStream(request?: protos.google.appengine.v1.IListInstancesRequest, options?: CallOptions): Transform; /** * Equivalent to `listInstances`, 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 * Name of the parent Version resource. Example: * `apps/myapp/services/default/versions/v1`. * @param {number} request.pageSize * Maximum results to return per page. * @param {string} request.pageToken * Continuation token for fetching the next page of results. * @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.appengine.v1.Instance|Instance}. 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/instances.list_instances.js * region_tag:appengine_v1_generated_Instances_ListInstances_async */ listInstancesAsync(request?: protos.google.appengine.v1.IListInstancesRequest, options?: CallOptions): AsyncIterable; /** * Return a fully-qualified instance resource name string. * * @param {string} app * @param {string} service * @param {string} version * @param {string} instance * @returns {string} Resource name string. */ instancePath(app: string, service: string, version: string, instance: string): string; /** * Parse the app from Instance resource. * * @param {string} instanceName * A fully-qualified path representing Instance resource. * @returns {string} A string representing the app. */ matchAppFromInstanceName(instanceName: string): string | number; /** * Parse the service from Instance resource. * * @param {string} instanceName * A fully-qualified path representing Instance resource. * @returns {string} A string representing the service. */ matchServiceFromInstanceName(instanceName: string): string | number; /** * Parse the version from Instance resource. * * @param {string} instanceName * A fully-qualified path representing Instance resource. * @returns {string} A string representing the version. */ matchVersionFromInstanceName(instanceName: string): string | number; /** * Parse the instance from Instance resource. * * @param {string} instanceName * A fully-qualified path representing Instance resource. * @returns {string} A string representing the instance. */ matchInstanceFromInstanceName(instanceName: 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; }