Class v1.ApplicationsClient (1.0.6)

Manages App Engine applications. v1

Package

@google-cloud/appengine-admin!

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.

Property Value
Type Description
string

applicationsStub

applicationsStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(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.

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.

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.

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
    ]>;
Parameters
Name Description
request protos.google.appengine.v1.ICreateApplicationRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.appengine.v1.IGetApplicationRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IGetApplicationRequest | undefined, {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.appengine.v1.IRepairApplicationRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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
    ]>;
Parameters
Name Description
request protos.google.appengine.v1.IUpdateApplicationRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.appengine.v1.IApplication, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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