Class v1.ApplicationsClient (1.2.0)

Manages App Engine applications. v1

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ApplicationsClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

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

applicationsStub

applicationsStub?: Promise<{
        [name: string]: Function;
    }>;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

checkCreateApplicationProgress(name)

checkCreateApplicationProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>;

Check the status of the long running operation returned by createApplication().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Application configuration.
   */
  // const application = {}

  // Imports the Appengine library
  const {ApplicationsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new ApplicationsClient();

  async function callCreateApplication() {
    // Construct request
    const request = {
    };

    // Run request
    const [operation] = await appengineClient.createApplication(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateApplication();

checkRepairApplicationProgress(name)

checkRepairApplicationProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>;

Check the status of the long running operation returned by repairApplication().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the application to repair. Example: `apps/myapp`
   */
  // const name = 'abc123'

  // Imports the Appengine library
  const {ApplicationsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new ApplicationsClient();

  async function callRepairApplication() {
    // Construct request
    const request = {
    };

    // Run request
    const [operation] = await appengineClient.repairApplication(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRepairApplication();

checkUpdateApplicationProgress(name)

checkUpdateApplicationProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>;

Check the status of the long running operation returned by updateApplication().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.appengine.v1.Application, protos.google.appengine.v1.OperationMetadataV1>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the Application resource to update. Example: `apps/myapp`.
   */
  // const name = 'abc123'
  /**
   *  An Application containing the updated resource.
   */
  // const application = {}
  /**
   *  Standard field mask for the set of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Appengine library
  const {ApplicationsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new ApplicationsClient();

  async function callUpdateApplication() {
    // Construct request
    const request = {
    };

    // Run request
    const [operation] = await appengineClient.updateApplication(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateApplication();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createApplication(request, options)

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
    ]>;

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/).

Parameters

Name	Description
request	`protos.google.appengine.v1.ICreateApplicationRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Application configuration.
   */
  // const application = {}

  // Imports the Appengine library
  const {ApplicationsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new ApplicationsClient();

  async function callCreateApplication() {
    // Construct request
    const request = {
    };

    // Run request
    const [operation] = await appengineClient.createApplication(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateApplication();

createApplication(request, options, callback)

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;

Parameters

Name	Description
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>`

Returns

Type	Description
void

createApplication(request, callback)

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;

Parameters

Name	Description
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>`

Returns

Type	Description
void

getApplication(request, options)

getApplication(request?: protos.google.appengine.v1.IGetApplicationRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IApplication,
        protos.google.appengine.v1.IGetApplicationRequest | undefined,
        {} | undefined
    ]>;

Gets information about an application.

Parameters

Name	Description
request	`protos.google.appengine.v1.IGetApplicationRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IGetApplicationRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Application]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the Application resource to get. Example: `apps/myapp`.
   */
  // const name = 'abc123'

  // Imports the Appengine library
  const {ApplicationsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new ApplicationsClient();

  async function callGetApplication() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await appengineClient.getApplication(request);
    console.log(response);
  }

  callGetApplication();

getApplication(request, options, callback)

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;

Parameters

Name	Description
request	`protos.google.appengine.v1.IGetApplicationRequest`
options	`CallOptions`
callback	`Callback<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IGetApplicationRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getApplication(request, callback)

getApplication(request: protos.google.appengine.v1.IGetApplicationRequest, callback: Callback<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IGetApplicationRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IGetApplicationRequest`
callback	`Callback<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IGetApplicationRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

instancePath(app, service, version, instance)

instancePath(app: string, service: string, version: string, instance: string): string;

Return a fully-qualified instance resource name string.

Parameters

Name	Description
app	`string`
service	`string`
version	`string`
instance	`string`

Returns

Type	Description
string	{string} Resource name string.

matchAppFromInstanceName(instanceName)

matchAppFromInstanceName(instanceName: string): string | number;

Parse the app from Instance resource.

Parameter

Name	Description
instanceName	`string` A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the app.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter

Name	Description
instanceName	`string` A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the instance.

matchServiceFromInstanceName(instanceName)

matchServiceFromInstanceName(instanceName: string): string | number;

Parse the service from Instance resource.

Parameter

Name	Description
instanceName	`string` A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the service.

matchVersionFromInstanceName(instanceName)

matchVersionFromInstanceName(instanceName: string): string | number;

Parse the version from Instance resource.

Parameter

Name	Description
instanceName	`string` A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the version.

repairApplication(request, options)

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
    ]>;

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.

Parameters

Name	Description
request	`protos.google.appengine.v1.IRepairApplicationRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the application to repair. Example: `apps/myapp`
   */
  // const name = 'abc123'

  // Imports the Appengine library
  const {ApplicationsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new ApplicationsClient();

  async function callRepairApplication() {
    // Construct request
    const request = {
    };

    // Run request
    const [operation] = await appengineClient.repairApplication(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRepairApplication();

repairApplication(request, options, callback)

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;

Parameters

Name	Description
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>`

Returns

Type	Description
void

repairApplication(request, callback)

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;

Parameters

Name	Description
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>`

Returns

Type	Description
void

updateApplication(request, options)

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
    ]>;

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.

Parameters

Name	Description
request	`protos.google.appengine.v1.IUpdateApplicationRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the Application resource to update. Example: `apps/myapp`.
   */
  // const name = 'abc123'
  /**
   *  An Application containing the updated resource.
   */
  // const application = {}
  /**
   *  Standard field mask for the set of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Appengine library
  const {ApplicationsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new ApplicationsClient();

  async function callUpdateApplication() {
    // Construct request
    const request = {
    };

    // Run request
    const [operation] = await appengineClient.updateApplication(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateApplication();

updateApplication(request, options, callback)

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;

Parameters

Name	Description
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>`

Returns

Type	Description
void

updateApplication(request, callback)

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;

Parameters

Name	Description
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>`

Returns

Type	Description
void