Class v1.DomainMappingsClient (2.2.2)

Manages domains serving an application. v1

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of DomainMappingsClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof gax.fallback` : 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 DomainMappingsClient({fallback: 'rest'}, gax); ```

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;

domainMappingsStub

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

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

checkCreateDomainMappingProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.appengine.v1.DomainMapping, 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


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the parent Application resource. Example: `apps/myapp`.
   */
  // const parent = 'abc123'
  /**
   *  Domain mapping configuration.
   */
  // const domainMapping = {}
  /**
   *  Whether the domain creation should override any existing mappings for this
   *  domain. By default, overrides are rejected.
   */
  // const overrideStrategy = {}

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

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

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

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

  callCreateDomainMapping();

checkDeleteDomainMappingProgress(name)

checkDeleteDomainMappingProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.appengine.v1.OperationMetadataV1>>;

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

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

Returns
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.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource to delete. Example:
   *  `apps/myapp/domainMappings/example.com`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteDomainMapping();

checkUpdateDomainMappingProgress(name)

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

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.appengine.v1.DomainMapping, 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


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource to update. Example:
   *  `apps/myapp/domainMappings/example.com`.
   */
  // const name = 'abc123'
  /**
   *  A domain mapping containing the updated resource. Only fields set
   *  in the field mask will be updated.
   */
  // const domainMapping = {}
  /**
   *  Required. Standard field mask for the set of fields to be updated.
   */
  // const updateMask = {}

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

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

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

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

  callUpdateDomainMapping();

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.

createDomainMapping(request, options)

createDomainMapping(request?: protos.google.appengine.v1.ICreateDomainMappingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see [AuthorizedDomains.ListAuthorizedDomains]().

Parameters
Name	Description
`request`	`protos.google.appengine.v1.ICreateDomainMappingRequest` 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.IDomainMapping, 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


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the parent Application resource. Example: `apps/myapp`.
   */
  // const parent = 'abc123'
  /**
   *  Domain mapping configuration.
   */
  // const domainMapping = {}
  /**
   *  Whether the domain creation should override any existing mappings for this
   *  domain. By default, overrides are rejected.
   */
  // const overrideStrategy = {}

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

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

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

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

  callCreateDomainMapping();

createDomainMapping(request, options, callback)

createDomainMapping(request: protos.google.appengine.v1.ICreateDomainMappingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.ICreateDomainMappingRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createDomainMapping(request, callback)

createDomainMapping(request: protos.google.appengine.v1.ICreateDomainMappingRequest, callback: Callback<LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.ICreateDomainMappingRequest`
`callback`	`Callback<LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteDomainMapping(request, options)

deleteDomainMapping(request?: protos.google.appengine.v1.IDeleteDomainMappingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

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

Returns
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 `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


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource to delete. Example:
   *  `apps/myapp/domainMappings/example.com`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteDomainMapping();

deleteDomainMapping(request, options, callback)

deleteDomainMapping(request: protos.google.appengine.v1.IDeleteDomainMappingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.IDeleteDomainMappingRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteDomainMapping(request, callback)

deleteDomainMapping(request: protos.google.appengine.v1.IDeleteDomainMappingRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.IDeleteDomainMappingRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getDomainMapping(request, options)

getDomainMapping(request?: protos.google.appengine.v1.IGetDomainMappingRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IDomainMapping,
        protos.google.appengine.v1.IGetDomainMappingRequest | undefined,
        {} | undefined
    ]>;

Gets the specified domain mapping.

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource requested. Example:
   *  `apps/myapp/domainMappings/example.com`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetDomainMapping();

getDomainMapping(request, options, callback)

getDomainMapping(request: protos.google.appengine.v1.IGetDomainMappingRequest, options: CallOptions, callback: Callback<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IGetDomainMappingRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

getDomainMapping(request, callback)

getDomainMapping(request: protos.google.appengine.v1.IGetDomainMappingRequest, callback: Callback<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IGetDomainMappingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.IGetDomainMappingRequest`
`callback`	`Callback<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IGetDomainMappingRequest \| 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.

listDomainMappings(request, options)

listDomainMappings(request?: protos.google.appengine.v1.IListDomainMappingsRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IDomainMapping[],
        protos.google.appengine.v1.IListDomainMappingsRequest | null,
        protos.google.appengine.v1.IListDomainMappingsResponse
    ]>;

Lists the domain mappings on an application.

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

Returns

Type Description

Promise<[
        protos.google.appengine.v1.IDomainMapping[],
        protos.google.appengine.v1.IListDomainMappingsRequest | null,
        protos.google.appengine.v1.IListDomainMappingsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listDomainMappingsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDomainMappings(request, options, callback)

listDomainMappings(request: protos.google.appengine.v1.IListDomainMappingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.appengine.v1.IListDomainMappingsRequest, protos.google.appengine.v1.IListDomainMappingsResponse | null | undefined, protos.google.appengine.v1.IDomainMapping>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.IListDomainMappingsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.appengine.v1.IListDomainMappingsRequest, protos.google.appengine.v1.IListDomainMappingsResponse \| null \| undefined, protos.google.appengine.v1.IDomainMapping>`

Returns
Type	Description
`void`

listDomainMappings(request, callback)

listDomainMappings(request: protos.google.appengine.v1.IListDomainMappingsRequest, callback: PaginationCallback<protos.google.appengine.v1.IListDomainMappingsRequest, protos.google.appengine.v1.IListDomainMappingsResponse | null | undefined, protos.google.appengine.v1.IDomainMapping>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.IListDomainMappingsRequest`
`callback`	`PaginationCallback<protos.google.appengine.v1.IListDomainMappingsRequest, protos.google.appengine.v1.IListDomainMappingsResponse \| null \| undefined, protos.google.appengine.v1.IDomainMapping>`

Returns
Type	Description
`void`

listDomainMappingsAsync(request, options)

listDomainMappingsAsync(request?: protos.google.appengine.v1.IListDomainMappingsRequest, options?: CallOptions): AsyncIterable<protos.google.appengine.v1.IDomainMapping>;

Equivalent to listDomainMappings, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

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

Returns

Type Description

AsyncIterable<protos.google.appengine.v1.IDomainMapping>

{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 . 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.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * 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 {DomainMappingsClient} = require('@google-cloud/appengine-admin').v1;

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

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

    // Run request
    const iterable = await appengineClient.listDomainMappingsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDomainMappings();

listDomainMappingsStream(request, options)

listDomainMappingsStream(request?: protos.google.appengine.v1.IListDomainMappingsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

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

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing 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 listDomainMappingsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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.

updateDomainMapping(request, options)

updateDomainMapping(request?: protos.google.appengine.v1.IUpdateDomainMappingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

Parameters
Name	Description
`request`	`protos.google.appengine.v1.IUpdateDomainMappingRequest` 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.IDomainMapping, 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


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource to update. Example:
   *  `apps/myapp/domainMappings/example.com`.
   */
  // const name = 'abc123'
  /**
   *  A domain mapping containing the updated resource. Only fields set
   *  in the field mask will be updated.
   */
  // const domainMapping = {}
  /**
   *  Required. Standard field mask for the set of fields to be updated.
   */
  // const updateMask = {}

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

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

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

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

  callUpdateDomainMapping();

updateDomainMapping(request, options, callback)

updateDomainMapping(request: protos.google.appengine.v1.IUpdateDomainMappingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.IUpdateDomainMappingRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateDomainMapping(request, callback)

updateDomainMapping(request: protos.google.appengine.v1.IUpdateDomainMappingRequest, callback: Callback<LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.appengine.v1.IUpdateDomainMappingRequest`
`callback`	`Callback<LROperation<protos.google.appengine.v1.IDomainMapping, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`