@google-cloud/appengine-admin

import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation } from 'google-gax'; import * as protos from '../../protos/protos'; /** * Manages App Engine applications. * @class * @memberof v1 */ export declare class ApplicationsClient { 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; applicationsStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ApplicationsClient. * * @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 ApplicationsClient({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<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; /** * Gets information about an application. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Name of the Application resource to get. Example: `apps/myapp`. * @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.Application|Application}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/applications.get_application.js</caption> * region_tag:appengine_v1_generated_Applications_GetApplication_async */ getApplication(request?: protos.google.appengine.v1.IGetApplicationRequest, options?: CallOptions): Promise<[ protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IGetApplicationRequest | undefined, {} | undefined ]>; getApplication(request: protos.google.appengine.v1.IGetApplicationRequest, options: CallOptions, callback: Callback<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IGetApplicationRequest | null | undefined, {} | null | undefined>): void; getApplication(request: protos.google.appengine.v1.IGetApplicationRequest, callback: Callback<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IGetApplicationRequest | null | undefined, {} | null | undefined>): void; /** * Creates an App Engine application for a Google Cloud Platform project. * Required fields: * * * `id` - The ID of the target Cloud Platform project. * * *location* - The [region](https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located. * * For more information about App Engine applications, see [Managing Projects, Applications, and Billing](https://cloud.google.com/appengine/docs/standard/python/console/). * * @param {Object} request * The request object that will be sent. * @param {google.appengine.v1.Application} request.application * Application configuration. * @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 <caption>include:samples/generated/v1/applications.create_application.js</caption> * region_tag:appengine_v1_generated_Applications_CreateApplication_async */ createApplication(request?: protos.google.appengine.v1.ICreateApplicationRequest, options?: CallOptions): Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createApplication(request: protos.google.appengine.v1.ICreateApplicationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createApplication(request: protos.google.appengine.v1.ICreateApplicationRequest, callback: Callback<LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createApplication()`. * @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 <caption>include:samples/generated/v1/applications.create_application.js</caption> * region_tag:appengine_v1_generated_Applications_CreateApplication_async */ checkCreateApplicationProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>; /** * Updates the specified Application resource. * You can update the following fields: * * * `auth_domain` - Google authentication domain for controlling user access to the application. * * `default_cookie_expiration` - Cookie expiration policy for the application. * * `iap` - Identity-Aware Proxy properties for the application. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Name of the Application resource to update. Example: `apps/myapp`. * @param {google.appengine.v1.Application} request.application * An Application containing the updated resource. * @param {google.protobuf.FieldMask} request.updateMask * Required. Standard field mask for the set of fields to be updated. * @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 <caption>include:samples/generated/v1/applications.update_application.js</caption> * region_tag:appengine_v1_generated_Applications_UpdateApplication_async */ updateApplication(request?: protos.google.appengine.v1.IUpdateApplicationRequest, options?: CallOptions): Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateApplication(request: protos.google.appengine.v1.IUpdateApplicationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateApplication(request: protos.google.appengine.v1.IUpdateApplicationRequest, callback: Callback<LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateApplication()`. * @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 <caption>include:samples/generated/v1/applications.update_application.js</caption> * region_tag:appengine_v1_generated_Applications_UpdateApplication_async */ checkUpdateApplicationProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>; /** * Recreates the required App Engine features for the specified App Engine * application, for example a Cloud Storage bucket or App Engine service * account. * Use this method if you receive an error message about a missing feature, * for example, *Error retrieving the App Engine service account*. * If you have deleted your App Engine service account, this will * not be able to recreate it. Instead, you should attempt to use the * IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . * If the deletion was recent, the numeric ID can be found in the Cloud * Console Activity Log. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Name of the application to repair. Example: `apps/myapp` * @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 <caption>include:samples/generated/v1/applications.repair_application.js</caption> * region_tag:appengine_v1_generated_Applications_RepairApplication_async */ repairApplication(request?: protos.google.appengine.v1.IRepairApplicationRequest, options?: CallOptions): Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; repairApplication(request: protos.google.appengine.v1.IRepairApplicationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; repairApplication(request: protos.google.appengine.v1.IRepairApplicationRequest, callback: Callback<LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `repairApplication()`. * @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 <caption>include:samples/generated/v1/applications.repair_application.js</caption> * region_tag:appengine_v1_generated_Applications_RepairApplication_async */ checkRepairApplicationProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>; /** * 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<void>; }