Manages services of an application. v1
Package
@google-cloud/appengine-adminConstructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of ServicesClient.
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
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.
servicesStub
servicesStub?: Promise<{
[name: string]: Function;
}>;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
checkDeleteServiceProgress(name)
checkDeleteServiceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.appengine.v1.OperationMetadataV1>>;
Check the status of the long running operation returned by deleteService()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, 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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the resource requested. Example: `apps/myapp/services/default`.
*/
// const name = 'abc123'
// Imports the Appengine library
const {ServicesClient} = require('@google-cloud/appengine-admin').v1;
// Instantiates a client
const appengineClient = new ServicesClient();
async function callDeleteService() {
// Construct request
const request = {};
// Run request
const [operation] = await appengineClient.deleteService(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteService();
checkUpdateServiceProgress(name)
checkUpdateServiceProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Service, protos.google.appengine.v1.OperationMetadataV1>>;
Check the status of the long running operation returned by updateService()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.appengine.v1.Service, 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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the resource to update. Example: `apps/myapp/services/default`.
*/
// const name = 'abc123'
/**
* A Service resource containing the updated service. Only fields set in the
* field mask will be updated.
*/
// const service = {}
/**
* Standard field mask for the set of fields to be updated.
*/
// const updateMask = {}
/**
* Set to `true` to gradually shift traffic to one or more versions that you
* specify. By default, traffic is shifted immediately.
* For gradual traffic migration, the target versions
* must be located within instances that are configured for both
* warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType)
* and
* automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling).
* You must specify the
* `shardBy` (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy)
* field in the Service resource. Gradual traffic migration is not
* supported in the App Engine flexible environment. For examples, see
* Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
*/
// const migrateTraffic = true
// Imports the Appengine library
const {ServicesClient} = require('@google-cloud/appengine-admin').v1;
// Instantiates a client
const appengineClient = new ServicesClient();
async function callUpdateService() {
// Construct request
const request = {};
// Run request
const [operation] = await appengineClient.updateService(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateService();
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.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
deleteService(request, options)
deleteService(request?: protos.google.appengine.v1.IDeleteServiceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes the specified service and all enclosed versions.
Name | Description |
request |
protos.google.appengine.v1.IDeleteServiceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.protobuf.IEmpty, 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 |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the resource requested. Example: `apps/myapp/services/default`.
*/
// const name = 'abc123'
// Imports the Appengine library
const {ServicesClient} = require('@google-cloud/appengine-admin').v1;
// Instantiates a client
const appengineClient = new ServicesClient();
async function callDeleteService() {
// Construct request
const request = {};
// Run request
const [operation] = await appengineClient.deleteService(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteService();
deleteService(request, options, callback)
deleteService(request: protos.google.appengine.v1.IDeleteServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.appengine.v1.IDeleteServiceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteService(request, callback)
deleteService(request: protos.google.appengine.v1.IDeleteServiceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.appengine.v1.IDeleteServiceRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Type | Description |
void |
getService(request, options)
getService(request?: protos.google.appengine.v1.IGetServiceRequest, options?: CallOptions): Promise<[
protos.google.appengine.v1.IService,
protos.google.appengine.v1.IGetServiceRequest | undefined,
{} | undefined
]>;
Gets the current configuration of the specified service.
Name | Description |
request |
protos.google.appengine.v1.IGetServiceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.appengine.v1.IService, protos.google.appengine.v1.IGetServiceRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Service]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the resource requested. Example: `apps/myapp/services/default`.
*/
// const name = 'abc123'
// Imports the Appengine library
const {ServicesClient} = require('@google-cloud/appengine-admin').v1;
// Instantiates a client
const appengineClient = new ServicesClient();
async function callGetService() {
// Construct request
const request = {};
// Run request
const response = await appengineClient.getService(request);
console.log(response);
}
callGetService();
getService(request, options, callback)
getService(request: protos.google.appengine.v1.IGetServiceRequest, options: CallOptions, callback: Callback<protos.google.appengine.v1.IService, protos.google.appengine.v1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.appengine.v1.IGetServiceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.appengine.v1.IService, protos.google.appengine.v1.IGetServiceRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getService(request, callback)
getService(request: protos.google.appengine.v1.IGetServiceRequest, callback: Callback<protos.google.appengine.v1.IService, protos.google.appengine.v1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.appengine.v1.IGetServiceRequest
|
callback |
Callback<protos.google.appengine.v1.IService, protos.google.appengine.v1.IGetServiceRequest | null | undefined, {} | null | undefined>
|
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.
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.
Name | Description |
app |
string
|
service |
string
|
version |
string
|
instance |
string
|
Type | Description |
string | {string} Resource name string. |
listServices(request, options)
listServices(request?: protos.google.appengine.v1.IListServicesRequest, options?: CallOptions): Promise<[
protos.google.appengine.v1.IService[],
protos.google.appengine.v1.IListServicesRequest | null,
protos.google.appengine.v1.IListServicesResponse
]>;
Lists all the services in the application.
Name | Description |
request |
protos.google.appengine.v1.IListServicesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.appengine.v1.IService[], protos.google.appengine.v1.IListServicesRequest | null, protos.google.appengine.v1.IListServicesResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Service]. 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 |
listServices(request, options, callback)
listServices(request: protos.google.appengine.v1.IListServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.appengine.v1.IListServicesRequest, protos.google.appengine.v1.IListServicesResponse | null | undefined, protos.google.appengine.v1.IService>): void;
Name | Description |
request |
protos.google.appengine.v1.IListServicesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.appengine.v1.IListServicesRequest, protos.google.appengine.v1.IListServicesResponse | null | undefined, protos.google.appengine.v1.IService>
|
Type | Description |
void |
listServices(request, callback)
listServices(request: protos.google.appengine.v1.IListServicesRequest, callback: PaginationCallback<protos.google.appengine.v1.IListServicesRequest, protos.google.appengine.v1.IListServicesResponse | null | undefined, protos.google.appengine.v1.IService>): void;
Name | Description |
request |
protos.google.appengine.v1.IListServicesRequest
|
callback |
PaginationCallback<protos.google.appengine.v1.IListServicesRequest, protos.google.appengine.v1.IListServicesResponse | null | undefined, protos.google.appengine.v1.IService>
|
Type | Description |
void |
listServicesAsync(request, options)
listServicesAsync(request?: protos.google.appengine.v1.IListServicesRequest, options?: CallOptions): AsyncIterable<protos.google.appengine.v1.IService>;
Equivalent to listServices
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.appengine.v1.IListServicesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.appengine.v1.IService> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Service]. 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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the parent Application resource. Example: `apps/myapp`.
*/
// const parent = 'abc123'
/**
* Maximum results to return per page.
*/
// const pageSize = 1234
/**
* Continuation token for fetching the next page of results.
*/
// const pageToken = 'abc123'
// Imports the Appengine library
const {ServicesClient} = require('@google-cloud/appengine-admin').v1;
// Instantiates a client
const appengineClient = new ServicesClient();
async function callListServices() {
// Construct request
const request = {};
// Run request
const iterable = await appengineClient.listServicesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListServices();
listServicesStream(request, options)
listServicesStream(request?: protos.google.appengine.v1.IListServicesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.appengine.v1.IListServicesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Service] 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 |
matchAppFromInstanceName(instanceName)
matchAppFromInstanceName(instanceName: string): string | number;
Parse the app from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the app. |
matchInstanceFromInstanceName(instanceName)
matchInstanceFromInstanceName(instanceName: string): string | number;
Parse the instance from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the instance. |
matchServiceFromInstanceName(instanceName)
matchServiceFromInstanceName(instanceName: string): string | number;
Parse the service from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the service. |
matchVersionFromInstanceName(instanceName)
matchVersionFromInstanceName(instanceName: string): string | number;
Parse the version from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the version. |
updateService(request, options)
updateService(request?: protos.google.appengine.v1.IUpdateServiceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.appengine.v1.IService, protos.google.appengine.v1.IOperationMetadataV1>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates the configuration of the specified service.
Name | Description |
request |
protos.google.appengine.v1.IUpdateServiceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.appengine.v1.IService, 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 |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the resource to update. Example: `apps/myapp/services/default`.
*/
// const name = 'abc123'
/**
* A Service resource containing the updated service. Only fields set in the
* field mask will be updated.
*/
// const service = {}
/**
* Standard field mask for the set of fields to be updated.
*/
// const updateMask = {}
/**
* Set to `true` to gradually shift traffic to one or more versions that you
* specify. By default, traffic is shifted immediately.
* For gradual traffic migration, the target versions
* must be located within instances that are configured for both
* warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType)
* and
* automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling).
* You must specify the
* `shardBy` (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy)
* field in the Service resource. Gradual traffic migration is not
* supported in the App Engine flexible environment. For examples, see
* Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
*/
// const migrateTraffic = true
// Imports the Appengine library
const {ServicesClient} = require('@google-cloud/appengine-admin').v1;
// Instantiates a client
const appengineClient = new ServicesClient();
async function callUpdateService() {
// Construct request
const request = {};
// Run request
const [operation] = await appengineClient.updateService(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateService();
updateService(request, options, callback)
updateService(request: protos.google.appengine.v1.IUpdateServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.appengine.v1.IService, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.appengine.v1.IUpdateServiceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.appengine.v1.IService, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
updateService(request, callback)
updateService(request: protos.google.appengine.v1.IUpdateServiceRequest, callback: Callback<LROperation<protos.google.appengine.v1.IService, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.appengine.v1.IUpdateServiceRequest
|
callback |
Callback<LROperation<protos.google.appengine.v1.IService, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |