Class v1.AuthorizedDomainsClient (2.1.2)

Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via [Webmaster Central](https://www.google.com/webmasters/verification/home). v1

Package

@google-cloud/appengine-admin

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of AuthorizedDomainsClient.

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 AuthorizedDomainsClient({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;

authorizedDomainsStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

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

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.

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.

listAuthorizedDomains(request, options)

listAuthorizedDomains(request?: protos.google.appengine.v1.IListAuthorizedDomainsRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IAuthorizedDomain[],
        protos.google.appengine.v1.IListAuthorizedDomainsRequest | null,
        protos.google.appengine.v1.IListAuthorizedDomainsResponse
    ]>;

Lists all domains the user is authorized to administer.

Parameters

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

Returns

Type Description

Promise<[ protos.google.appengine.v1.IAuthorizedDomain[], protos.google.appengine.v1.IListAuthorizedDomainsRequest | null, protos.google.appengine.v1.IListAuthorizedDomainsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [AuthorizedDomain]. 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 listAuthorizedDomainsAsync() 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.

listAuthorizedDomains(request, options, callback)

listAuthorizedDomains(request: protos.google.appengine.v1.IListAuthorizedDomainsRequest, options: CallOptions, callback: PaginationCallback<protos.google.appengine.v1.IListAuthorizedDomainsRequest, protos.google.appengine.v1.IListAuthorizedDomainsResponse | null | undefined, protos.google.appengine.v1.IAuthorizedDomain>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IListAuthorizedDomainsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.appengine.v1.IListAuthorizedDomainsRequest, protos.google.appengine.v1.IListAuthorizedDomainsResponse \| null \| undefined, protos.google.appengine.v1.IAuthorizedDomain>`

Returns

Type	Description
void

listAuthorizedDomains(request, callback)

listAuthorizedDomains(request: protos.google.appengine.v1.IListAuthorizedDomainsRequest, callback: PaginationCallback<protos.google.appengine.v1.IListAuthorizedDomainsRequest, protos.google.appengine.v1.IListAuthorizedDomainsResponse | null | undefined, protos.google.appengine.v1.IAuthorizedDomain>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IListAuthorizedDomainsRequest`
callback	`PaginationCallback<protos.google.appengine.v1.IListAuthorizedDomainsRequest, protos.google.appengine.v1.IListAuthorizedDomainsResponse \| null \| undefined, protos.google.appengine.v1.IAuthorizedDomain>`

Returns

Type	Description
void

listAuthorizedDomainsAsync(request, options)

listAuthorizedDomainsAsync(request?: protos.google.appengine.v1.IListAuthorizedDomainsRequest, options?: CallOptions): AsyncIterable<protos.google.appengine.v1.IAuthorizedDomain>;

Equivalent to listAuthorizedDomains, 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.IListAuthorizedDomainsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

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

{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 [AuthorizedDomain]. 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 {AuthorizedDomainsClient} = require('@google-cloud/appengine-admin').v1;

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

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

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

  callListAuthorizedDomains();

listAuthorizedDomainsStream(request, options)

listAuthorizedDomainsStream(request?: protos.google.appengine.v1.IListAuthorizedDomainsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.appengine.v1.IListAuthorizedDomainsRequest` 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 [AuthorizedDomain] 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 listAuthorizedDomainsAsync() 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.