Class v1.AppGatewaysServiceClient (0.2.3)

Stay organized with collections Save and categorize content based on your preferences.

## API Overview

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

## Data Model

The AppGatewaysService exposes the following resources:

* AppGateways, named as follows: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}.

The AppGatewaysService service provides methods to manage (create/read/update/delete) BeyondCorp AppGateways. v1

Package

@google-cloud/appgateways

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of AppGatewaysServiceClient.

Parameters
NameDescription
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 AppGatewaysServiceClient({fallback: 'rest'}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

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

appGatewaysServiceStub

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

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

appGatewayPath(project, location, appGateway)

appGatewayPath(project: string, location: string, appGateway: string): string;

Return a fully-qualified appGateway resource name string.

Parameters
NameDescription
project string
location string
appGateway string
Returns
TypeDescription
string

{string} Resource name string.

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
NameDescription
request protos.google.longrunning.CancelOperationRequest

The request object that will be sent.

options gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details.

callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateAppGatewayProgress(name)

checkCreateAppGatewayProgress(name: string): Promise<LROperation<protos.google.cloud.beyondcorp.appgateways.v1.AppGateway, protos.google.cloud.beyondcorp.appgateways.v1.AppGatewayOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.beyondcorp.appgateways.v1.AppGateway, protos.google.cloud.beyondcorp.appgateways.v1.AppGatewayOperationMetadata>>

{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.
   */
  /**
   *  Required. The resource project name of the AppGateway location using the
   *  form: `projects/{project_id}/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. User-settable AppGateway resource ID.
   *   * Must start with a letter.
   *   * Must contain between 4-63 characters from `/[a-z][0-9]-/`.
   *   * Must end with a number or a letter.
   */
  // const appGatewayId = 'abc123'
  /**
   *  Required. A BeyondCorp AppGateway resource.
   */
  // const appGateway = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and t
   *  he request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set, validates request by executing a dry-run which would not
   *  alter the resource in any way.
   */
  // const validateOnly = true

  // Imports the Appgateways library
  const {AppGatewaysServiceClient} = require('@google-cloud/appgateways').v1;

  // Instantiates a client
  const appgatewaysClient = new AppGatewaysServiceClient();

  async function callCreateAppGateway() {
    // Construct request
    const request = {
      parent,
      appGateway,
    };

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

  callCreateAppGateway();

checkDeleteAppGatewayProgress(name)

checkDeleteAppGatewayProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.beyondcorp.appgateways.v1.AppGatewayOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.beyondcorp.appgateways.v1.AppGatewayOperationMetadata>>

{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.
   */
  /**
   *  Required. BeyondCorp AppGateway name using the form:
   *  `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and t
   *  he request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set, validates request by executing a dry-run which would not
   *  alter the resource in any way.
   */
  // const validateOnly = true

  // Imports the Appgateways library
  const {AppGatewaysServiceClient} = require('@google-cloud/appgateways').v1;

  // Instantiates a client
  const appgatewaysClient = new AppGatewaysServiceClient();

  async function callDeleteAppGateway() {
    // Construct request
    const request = {
      name,
    };

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

  callDeleteAppGateway();

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createAppGateway(request, options)

createAppGateway(request?: protos.google.cloud.beyondcorp.appgateways.v1.ICreateAppGatewayRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new AppGateway in a given project and location.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.ICreateAppGatewayRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, 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.
   */
  /**
   *  Required. The resource project name of the AppGateway location using the
   *  form: `projects/{project_id}/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. User-settable AppGateway resource ID.
   *   * Must start with a letter.
   *   * Must contain between 4-63 characters from `/[a-z][0-9]-/`.
   *   * Must end with a number or a letter.
   */
  // const appGatewayId = 'abc123'
  /**
   *  Required. A BeyondCorp AppGateway resource.
   */
  // const appGateway = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and t
   *  he request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set, validates request by executing a dry-run which would not
   *  alter the resource in any way.
   */
  // const validateOnly = true

  // Imports the Appgateways library
  const {AppGatewaysServiceClient} = require('@google-cloud/appgateways').v1;

  // Instantiates a client
  const appgatewaysClient = new AppGatewaysServiceClient();

  async function callCreateAppGateway() {
    // Construct request
    const request = {
      parent,
      appGateway,
    };

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

  callCreateAppGateway();

createAppGateway(request, options, callback)

createAppGateway(request: protos.google.cloud.beyondcorp.appgateways.v1.ICreateAppGatewayRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.ICreateAppGatewayRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createAppGateway(request, callback)

createAppGateway(request: protos.google.cloud.beyondcorp.appgateways.v1.ICreateAppGatewayRequest, callback: Callback<LROperation<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.ICreateAppGatewayRequest
callback Callback<LROperation<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteAppGateway(request, options)

deleteAppGateway(request?: protos.google.cloud.beyondcorp.appgateways.v1.IDeleteAppGatewayRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single AppGateway.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IDeleteAppGatewayRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, 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.
   */
  /**
   *  Required. BeyondCorp AppGateway name using the form:
   *  `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and t
   *  he request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  Optional. If set, validates request by executing a dry-run which would not
   *  alter the resource in any way.
   */
  // const validateOnly = true

  // Imports the Appgateways library
  const {AppGatewaysServiceClient} = require('@google-cloud/appgateways').v1;

  // Instantiates a client
  const appgatewaysClient = new AppGatewaysServiceClient();

  async function callDeleteAppGateway() {
    // Construct request
    const request = {
      name,
    };

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

  callDeleteAppGateway();

deleteAppGateway(request, options, callback)

deleteAppGateway(request: protos.google.cloud.beyondcorp.appgateways.v1.IDeleteAppGatewayRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IDeleteAppGatewayRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteAppGateway(request, callback)

deleteAppGateway(request: protos.google.cloud.beyondcorp.appgateways.v1.IDeleteAppGatewayRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IDeleteAppGatewayRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appgateways.v1.IAppGatewayOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
NameDescription
request protos.google.longrunning.DeleteOperationRequest

The request object that will be sent.

options gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details.

callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

getAppGateway(request, options)

getAppGateway(request?: protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest, options?: CallOptions): Promise<[
        protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway,
        (protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single AppGateway.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, (protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AppGateway]. 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.
   */
  /**
   *  Required. BeyondCorp AppGateway name using the form:
   *  `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
   */
  // const name = 'abc123'

  // Imports the Appgateways library
  const {AppGatewaysServiceClient} = require('@google-cloud/appgateways').v1;

  // Instantiates a client
  const appgatewaysClient = new AppGatewaysServiceClient();

  async function callGetAppGateway() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await appgatewaysClient.getAppGateway(request);
    console.log(response);
  }

  callGetAppGateway();

getAppGateway(request, options, callback)

getAppGateway(request: protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest, options: CallOptions, callback: Callback<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest
options CallOptions
callback Callback<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAppGateway(request, callback)

getAppGateway(request: protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest, callback: Callback<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest
callback Callback<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway, protos.google.cloud.beyondcorp.appgateways.v1.IGetAppGatewayRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.Policy>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
NameDescription
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.

callback Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing [Policy].

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.Policy>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<LocationProtos.google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Location]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

const [response] = await client.getLocation(request);

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
NameDescription
request protos.google.longrunning.GetOperationRequest

The request object that will be sent.

options gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details.

callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing [google.longrunning.Operation]. {Promise} - The promise which resolves to an array. The first element of the array is an object representing [google.longrunning.Operation]. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listAppGateways(request, options)

listAppGateways(request?: protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, options?: CallOptions): Promise<[
        protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway[],
        protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest | null,
        protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysResponse
    ]>;

Lists AppGateways in a given project and location.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway[], protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest | null, protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysResponse ]>

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

listAppGateways(request, options, callback)

listAppGateways(request: protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysResponse | null | undefined, protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysResponse | null | undefined, protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway>
Returns
TypeDescription
void

listAppGateways(request, callback)

listAppGateways(request: protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, callback: PaginationCallback<protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysResponse | null | undefined, protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest
callback PaginationCallback<protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysResponse | null | undefined, protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway>
Returns
TypeDescription
void

listAppGatewaysAsync(request, options)

listAppGatewaysAsync(request?: protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway>;

Equivalent to listAppGateways, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.beyondcorp.appgateways.v1.IAppGateway>

{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 [AppGateway]. 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.
   */
  /**
   *  Required. The resource name of the AppGateway location using the form:
   *  `projects/{project_id}/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of items to return.
   *  If not specified, a default value of 50 will be used by the service.
   *  Regardless of the page_size value, the response may include a partial list
   *  and a caller should only rely on response's
   *  next_page_token BeyondCorp.ListAppGatewaysResponse.next_page_token  to
   *  determine if there are more instances left to be queried.
   */
  // const pageSize = 1234
  /**
   *  Optional. The next_page_token value returned from a previous
   *  ListAppGatewaysRequest, if any.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter specifying constraints of a list operation.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Specifies the ordering of results. See
   *  Sorting
   *  order (https://cloud.google.com/apis/design/design_patterns#sorting_order)
   *  for more information.
   */
  // const orderBy = 'abc123'

  // Imports the Appgateways library
  const {AppGatewaysServiceClient} = require('@google-cloud/appgateways').v1;

  // Instantiates a client
  const appgatewaysClient = new AppGatewaysServiceClient();

  async function callListAppGateways() {
    // Construct request
    const request = {
      parent,
    };

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

  callListAppGateways();

listAppGatewaysStream(request, options)

listAppGatewaysStream(request?: protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appgateways.v1.IListAppGatewaysRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [AppGateway] 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 listAppGatewaysAsync() 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.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<LocationProtos.google.cloud.location.ILocation>

{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 [Location]. 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

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
NameDescription
request protos.google.longrunning.ListOperationsRequest

The request object that will be sent.

options gax.CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details.

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchAppGatewayFromAppGatewayName(appGatewayName)

matchAppGatewayFromAppGatewayName(appGatewayName: string): string | number;

Parse the app_gateway from AppGateway resource.

Parameter
NameDescription
appGatewayName string

A fully-qualified path representing AppGateway resource.

Returns
TypeDescription
string | number

{string} A string representing the app_gateway.

matchLocationFromAppGatewayName(appGatewayName)

matchLocationFromAppGatewayName(appGatewayName: string): string | number;

Parse the location from AppGateway resource.

Parameter
NameDescription
appGatewayName string

A fully-qualified path representing AppGateway resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromAppGatewayName(appGatewayName)

matchProjectFromAppGatewayName(appGatewayName: string): string | number;

Parse the project from AppGateway resource.

Parameter
NameDescription
appGatewayName string

A fully-qualified path representing AppGateway resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.Policy>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
NameDescription
request IamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.

callback Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing [TestIamPermissionsResponse].

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.Policy>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<IamProtos.google.iam.v1.TestIamPermissionsResponse>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
NameDescription
request IamProtos.google.iam.v1.TestIamPermissionsRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.

callback Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing [TestIamPermissionsResponse].

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.TestIamPermissionsResponse>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. The promise has a method named "cancel" which cancels the ongoing API call.