Class v1.AppConnectionsServiceClient (0.3.1)

API Overview:

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

Data Model:

The AppConnectionsService exposes the following resources:

* AppConnections, named as follows: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}.

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

Package

@google-cloud/appconnections

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of AppConnectionsServiceClient.

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

Properties

apiEndpoint

static get apiEndpoint(): string;

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

appConnectionsServiceStub

appConnectionsServiceStub?: 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

appConnectionPath(project, location, appConnection)

appConnectionPath(project: string, location: string, appConnection: string): string;

Return a fully-qualified appConnection resource name string.

Parameters
NameDescription
project string
location string
appConnection string
Returns
TypeDescription
string

{string} Resource name string.

appConnectorPath(project, location, appConnector)

appConnectorPath(project: string, location: string, appConnector: string): string;

Return a fully-qualified appConnector resource name string.

Parameters
NameDescription
project string
location string
appConnector 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 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: ''});

checkCreateAppConnectionProgress(name)

checkCreateAppConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.AppConnection, protos.google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.AppConnection, protos.google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata>>

{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 AppConnection location using the
   *  form: `projects/{project_id}/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. User-settable AppConnection 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 appConnectionId = 'abc123'
  /**
   *  Required. A BeyondCorp AppConnection resource.
   */
  // const appConnection = {}
  /**
   *  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 Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

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

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

  callCreateAppConnection();

checkDeleteAppConnectionProgress(name)

checkDeleteAppConnectionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata>>

{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 Connector name using the form:
   *  `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_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 Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

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

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

  callDeleteAppConnection();

checkUpdateAppConnectionProgress(name)

checkUpdateAppConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.AppConnection, protos.google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.AppConnection, protos.google.cloud.beyondcorp.appconnections.v1.AppConnectionOperationMetadata>>

{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. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field may only include these
   *  fields from BeyondCorp.AppConnection:
   *  * `labels`
   *  * `display_name`
   *  * `application_endpoint`
   *  * `connectors`
   */
  // const updateMask = {}
  /**
   *  Required. AppConnection message with updated fields. Only supported fields
   *  specified in update_mask are updated.
   */
  // const appConnection = {}
  /**
   *  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
  /**
   *  Optional. If set as true, will create the resource if it is not found.
   */
  // const allowMissing = true

  // Imports the Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

  async function callUpdateAppConnection() {
    // Construct request
    const request = {
      updateMask,
      appConnection,
    };

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

  callUpdateAppConnection();

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.

createAppConnection(request, options)

createAppConnection(request?: protos.google.cloud.beyondcorp.appconnections.v1.ICreateAppConnectionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new AppConnection in a given project and location.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.ICreateAppConnectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, 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 AppConnection location using the
   *  form: `projects/{project_id}/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. User-settable AppConnection 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 appConnectionId = 'abc123'
  /**
   *  Required. A BeyondCorp AppConnection resource.
   */
  // const appConnection = {}
  /**
   *  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 Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

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

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

  callCreateAppConnection();

createAppConnection(request, options, callback)

createAppConnection(request: protos.google.cloud.beyondcorp.appconnections.v1.ICreateAppConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.ICreateAppConnectionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createAppConnection(request, callback)

createAppConnection(request: protos.google.cloud.beyondcorp.appconnections.v1.ICreateAppConnectionRequest, callback: Callback<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.ICreateAppConnectionRequest
callback Callback<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteAppConnection(request, options)

deleteAppConnection(request?: protos.google.cloud.beyondcorp.appconnections.v1.IDeleteAppConnectionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single AppConnection.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IDeleteAppConnectionRequest

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.appconnections.v1.IAppConnectionOperationMetadata>, 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 Connector name using the form:
   *  `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_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 Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

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

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

  callDeleteAppConnection();

deleteAppConnection(request, options, callback)

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

deleteAppConnection(request, callback)

deleteAppConnection(request: protos.google.cloud.beyondcorp.appconnections.v1.IDeleteAppConnectionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IDeleteAppConnectionRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, 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 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: ''});

getAppConnection(request, options)

getAppConnection(request?: protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection,
        (protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single AppConnection.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, (protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest | 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.
   */
  /**
   *  Required. BeyondCorp AppConnection name using the form:
   *  `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
   */
  // const name = 'abc123'

  // Imports the Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

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

    // Run request
    const response = await appconnectionsClient.getAppConnection(request);
    console.log(response);
  }

  callGetAppConnection();

getAppConnection(request, options, callback)

getAppConnection(request: protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest
options CallOptions
callback Callback<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAppConnection(request, callback)

getAppConnection(request: protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest, callback: Callback<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest
callback Callback<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IGetAppConnectionRequest | 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 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 .

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 . 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 . 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 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 . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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.

listAppConnections(request, options)

listAppConnections(request?: protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection[],
        protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest | null,
        protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsResponse
    ]>;

Lists AppConnections in a given project and location.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection[], protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest | null, protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsResponse ]>

{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 listAppConnectionsAsync() 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.

listAppConnections(request, options, callback)

listAppConnections(request: protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsResponse | null | undefined, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsResponse | null | undefined, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection>
Returns
TypeDescription
void

listAppConnections(request, callback)

listAppConnections(request: protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, callback: PaginationCallback<protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsResponse | null | undefined, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest
callback PaginationCallback<protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsResponse | null | undefined, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection>
Returns
TypeDescription
void

listAppConnectionsAsync(request, options)

listAppConnectionsAsync(request?: protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection>;

Equivalent to listAppConnections, 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.appconnections.v1.IListAppConnectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection>

{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.
   */
  /**
   *  Required. The resource name of the AppConnection 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.ListAppConnectionsResponse.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
   *  ListAppConnectionsRequest, 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 Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

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

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

  callListAppConnections();

listAppConnectionsStream(request, options)

listAppConnectionsStream(request?: protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IListAppConnectionsRequest

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 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 listAppConnectionsAsync() 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 . 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 for the details.

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

{Object} An iterable Object that conforms to 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.

matchAppConnectionFromAppConnectionName(appConnectionName)

matchAppConnectionFromAppConnectionName(appConnectionName: string): string | number;

Parse the app_connection from AppConnection resource.

Parameter
NameDescription
appConnectionName string

A fully-qualified path representing AppConnection resource.

Returns
TypeDescription
string | number

{string} A string representing the app_connection.

matchAppConnectorFromAppConnectorName(appConnectorName)

matchAppConnectorFromAppConnectorName(appConnectorName: string): string | number;

Parse the app_connector from AppConnector resource.

Parameter
NameDescription
appConnectorName string

A fully-qualified path representing AppConnector resource.

Returns
TypeDescription
string | number

{string} A string representing the app_connector.

matchLocationFromAppConnectionName(appConnectionName)

matchLocationFromAppConnectionName(appConnectionName: string): string | number;

Parse the location from AppConnection resource.

Parameter
NameDescription
appConnectionName string

A fully-qualified path representing AppConnection resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromAppConnectorName(appConnectorName)

matchLocationFromAppConnectorName(appConnectorName: string): string | number;

Parse the location from AppConnector resource.

Parameter
NameDescription
appConnectorName string

A fully-qualified path representing AppConnector 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.

matchProjectFromAppConnectionName(appConnectionName)

matchProjectFromAppConnectionName(appConnectionName: string): string | number;

Parse the project from AppConnection resource.

Parameter
NameDescription
appConnectionName string

A fully-qualified path representing AppConnection resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromAppConnectorName(appConnectorName)

matchProjectFromAppConnectorName(appConnectorName: string): string | number;

Parse the project from AppConnector resource.

Parameter
NameDescription
appConnectorName string

A fully-qualified path representing AppConnector 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.

resolveAppConnections(request, options)

resolveAppConnections(request?: protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.IAppConnectionDetails[],
        protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest | null,
        protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsResponse
    ]>;

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.IAppConnectionDetails[], protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest | null, protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsResponse ]>

{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 resolveAppConnectionsAsync() 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.

resolveAppConnections(request, options, callback)

resolveAppConnections(request: protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsResponse | null | undefined, protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.IAppConnectionDetails>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsResponse | null | undefined, protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.IAppConnectionDetails>
Returns
TypeDescription
void

resolveAppConnections(request, callback)

resolveAppConnections(request: protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, callback: PaginationCallback<protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsResponse | null | undefined, protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.IAppConnectionDetails>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest
callback PaginationCallback<protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsResponse | null | undefined, protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.IAppConnectionDetails>
Returns
TypeDescription
void

resolveAppConnectionsAsync(request, options)

resolveAppConnectionsAsync(request?: protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.IAppConnectionDetails>;

Equivalent to resolveAppConnections, 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.appconnections.v1.IResolveAppConnectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.beyondcorp.appconnections.v1.ResolveAppConnectionsResponse.IAppConnectionDetails>

{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.
   */
  /**
   *  Required. The resource name of the AppConnection location using the form:
   *  `projects/{project_id}/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. BeyondCorp Connector name of the connector associated with those
   *  AppConnections using the form:
   *  `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
   */
  // const appConnectorId = '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.ResolveAppConnectionsResponse.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
   *  ResolveAppConnectionsResponse, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

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

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

  callResolveAppConnections();

resolveAppConnectionsStream(request, options)

resolveAppConnectionsStream(request?: protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IResolveAppConnectionsRequest

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 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 resolveAppConnectionsAsync() 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.

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

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

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 . The promise has a method named "cancel" which cancels the ongoing API call.

updateAppConnection(request, options)

updateAppConnection(request?: protos.google.cloud.beyondcorp.appconnections.v1.IUpdateAppConnectionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single AppConnection.

Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IUpdateAppConnectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, 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. Mask of fields to update. At least one path must be supplied in
   *  this field. The elements of the repeated paths field may only include these
   *  fields from BeyondCorp.AppConnection:
   *  * `labels`
   *  * `display_name`
   *  * `application_endpoint`
   *  * `connectors`
   */
  // const updateMask = {}
  /**
   *  Required. AppConnection message with updated fields. Only supported fields
   *  specified in update_mask are updated.
   */
  // const appConnection = {}
  /**
   *  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
  /**
   *  Optional. If set as true, will create the resource if it is not found.
   */
  // const allowMissing = true

  // Imports the Appconnections library
  const {AppConnectionsServiceClient} = require('@google-cloud/appconnections').v1;

  // Instantiates a client
  const appconnectionsClient = new AppConnectionsServiceClient();

  async function callUpdateAppConnection() {
    // Construct request
    const request = {
      updateMask,
      appConnection,
    };

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

  callUpdateAppConnection();

updateAppConnection(request, options, callback)

updateAppConnection(request: protos.google.cloud.beyondcorp.appconnections.v1.IUpdateAppConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IUpdateAppConnectionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateAppConnection(request, callback)

updateAppConnection(request: protos.google.cloud.beyondcorp.appconnections.v1.IUpdateAppConnectionRequest, callback: Callback<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.beyondcorp.appconnections.v1.IUpdateAppConnectionRequest
callback Callback<LROperation<protos.google.cloud.beyondcorp.appconnections.v1.IAppConnection, protos.google.cloud.beyondcorp.appconnections.v1.IAppConnectionOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void