Class v1.DepServiceClient (0.12.0)

Service describing handlers for resources. v1

Package

@google-cloud/networkservices

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of DepServiceClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof 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 DepServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

depServiceStub

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

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.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

authzExtensionPath(project, location, authzExtension)

authzExtensionPath(project: string, location: string, authzExtension: string): string;

Return a fully-qualified authzExtension resource name string.

Parameters
Name Description
project string
location string
authzExtension string
Returns
Type Description
string

{string} Resource name string.

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | 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
Name Description
request CancelOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
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
Type Description
Promise<protos.google.protobuf.Empty>
Example

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

checkCreateAuthzExtensionProgress(name)

checkCreateAuthzExtensionProgress(name: string): Promise<LROperation<protos.google.cloud.networkservices.v1.AuthzExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networkservices.v1.AuthzExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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 parent resource of the `AuthzExtension` resource. Must
   *  be in the format `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. User-provided ID of the `AuthzExtension` resource to be
   *  created.
   */
  // const authzExtensionId = 'abc123'
  /**
   *  Required. `AuthzExtension` resource to be created.
   */
  // const authzExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callCreateAuthzExtension() {
    // Construct request
    const request = {
      parent,
      authzExtensionId,
      authzExtension,
    };

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

  callCreateAuthzExtension();

checkCreateLbEdgeExtensionProgress(name)

checkCreateLbEdgeExtensionProgress(name: string): Promise<LROperation<protos.google.cloud.networkservices.v1.LbEdgeExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networkservices.v1.LbEdgeExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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 parent resource of the `LbEdgeExtension` resource. Must be in
   *  the format `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. User-provided ID of the `LbEdgeExtension` resource to be created.
   */
  // const lbEdgeExtensionId = 'abc123'
  /**
   *  Required. `LbEdgeExtension` resource to be created.
   */
  // const lbEdgeExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callCreateLbEdgeExtension() {
    // Construct request
    const request = {
      parent,
      lbEdgeExtensionId,
      lbEdgeExtension,
    };

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

  callCreateLbEdgeExtension();

checkCreateLbRouteExtensionProgress(name)

checkCreateLbRouteExtensionProgress(name: string): Promise<LROperation<protos.google.cloud.networkservices.v1.LbRouteExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networkservices.v1.LbRouteExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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 parent resource of the `LbRouteExtension` resource. Must be
   *  in the format `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. User-provided ID of the `LbRouteExtension` resource to be
   *  created.
   */
  // const lbRouteExtensionId = 'abc123'
  /**
   *  Required. `LbRouteExtension` resource to be created.
   */
  // const lbRouteExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callCreateLbRouteExtension() {
    // Construct request
    const request = {
      parent,
      lbRouteExtensionId,
      lbRouteExtension,
    };

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

  callCreateLbRouteExtension();

checkCreateLbTrafficExtensionProgress(name)

checkCreateLbTrafficExtensionProgress(name: string): Promise<LROperation<protos.google.cloud.networkservices.v1.LbTrafficExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networkservices.v1.LbTrafficExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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 parent resource of the `LbTrafficExtension` resource. Must be
   *  in the format `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. User-provided ID of the `LbTrafficExtension` resource to be
   *  created.
   */
  // const lbTrafficExtensionId = 'abc123'
  /**
   *  Required. `LbTrafficExtension` resource to be created.
   */
  // const lbTrafficExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callCreateLbTrafficExtension() {
    // Construct request
    const request = {
      parent,
      lbTrafficExtensionId,
      lbTrafficExtension,
    };

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

  callCreateLbTrafficExtension();

checkDeleteAuthzExtensionProgress(name)

checkDeleteAuthzExtensionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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 name of the `AuthzExtension` resource to delete. Must
   *  be in the format
   *  `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`.
   */
  // 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 can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callDeleteAuthzExtension();

checkDeleteLbEdgeExtensionProgress(name)

checkDeleteLbEdgeExtensionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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 name of the `LbEdgeExtension` resource to delete. Must be in
   *  the format
   *  `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.
   */
  // 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 can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callDeleteLbEdgeExtension();

checkDeleteLbRouteExtensionProgress(name)

checkDeleteLbRouteExtensionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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 name of the `LbRouteExtension` resource to delete. Must be in
   *  the format
   *  `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.
   */
  // 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 can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callDeleteLbRouteExtension();

checkDeleteLbTrafficExtensionProgress(name)

checkDeleteLbTrafficExtensionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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 name of the `LbTrafficExtension` resource to delete. Must be
   *  in the format
   *  `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
   */
  // 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 can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callDeleteLbTrafficExtension();

checkUpdateAuthzExtensionProgress(name)

checkUpdateAuthzExtensionProgress(name: string): Promise<LROperation<protos.google.cloud.networkservices.v1.AuthzExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networkservices.v1.AuthzExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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. Used to specify the fields to be overwritten in the
   *  `AuthzExtension` resource by the update.
   *  The fields specified in the `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If the
   *  user does not specify a mask, then all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. `AuthzExtension` resource being updated.
   */
  // const authzExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callUpdateAuthzExtension() {
    // Construct request
    const request = {
      updateMask,
      authzExtension,
    };

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

  callUpdateAuthzExtension();

checkUpdateLbEdgeExtensionProgress(name)

checkUpdateLbEdgeExtensionProgress(name: string): Promise<LROperation<protos.google.cloud.networkservices.v1.LbEdgeExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networkservices.v1.LbEdgeExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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.
   */
  /**
   *  Optional. Used to specify the fields to be overwritten in the
   *  `LbEdgeExtension` resource by the update.
   *  The fields specified in the `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If the
   *  user does not specify a mask, then all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. `LbEdgeExtension` resource being updated.
   */
  // const lbEdgeExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callUpdateLbEdgeExtension() {
    // Construct request
    const request = {
      lbEdgeExtension,
    };

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

  callUpdateLbEdgeExtension();

checkUpdateLbRouteExtensionProgress(name)

checkUpdateLbRouteExtensionProgress(name: string): Promise<LROperation<protos.google.cloud.networkservices.v1.LbRouteExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networkservices.v1.LbRouteExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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.
   */
  /**
   *  Optional. Used to specify the fields to be overwritten in the
   *  `LbRouteExtension` resource by the update.
   *  The fields specified in the `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If the
   *  user does not specify a mask, then all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. `LbRouteExtension` resource being updated.
   */
  // const lbRouteExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callUpdateLbRouteExtension() {
    // Construct request
    const request = {
      lbRouteExtension,
    };

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

  callUpdateLbRouteExtension();

checkUpdateLbTrafficExtensionProgress(name)

checkUpdateLbTrafficExtensionProgress(name: string): Promise<LROperation<protos.google.cloud.networkservices.v1.LbTrafficExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networkservices.v1.LbTrafficExtension, protos.google.cloud.networkservices.v1.OperationMetadata>>

{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 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.
   */
  /**
   *  Optional. Used to specify the fields to be overwritten in the
   *  `LbTrafficExtension` resource by the update.
   *  The fields specified in the `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If the
   *  user does not specify a mask, then all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. `LbTrafficExtension` resource being updated.
   */
  // const lbTrafficExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callUpdateLbTrafficExtension() {
    // Construct request
    const request = {
      lbTrafficExtension,
    };

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

  callUpdateLbTrafficExtension();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

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

createAuthzExtension(request, options)

createAuthzExtension(request?: protos.google.cloud.networkservices.v1.ICreateAuthzExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new AuthzExtension resource in a given project and location.

Parameters
Name Description
request ICreateAuthzExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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 parent resource of the `AuthzExtension` resource. Must
   *  be in the format `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. User-provided ID of the `AuthzExtension` resource to be
   *  created.
   */
  // const authzExtensionId = 'abc123'
  /**
   *  Required. `AuthzExtension` resource to be created.
   */
  // const authzExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callCreateAuthzExtension() {
    // Construct request
    const request = {
      parent,
      authzExtensionId,
      authzExtension,
    };

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

  callCreateAuthzExtension();

createAuthzExtension(request, options, callback)

createAuthzExtension(request: protos.google.cloud.networkservices.v1.ICreateAuthzExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateAuthzExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createAuthzExtension(request, callback)

createAuthzExtension(request: protos.google.cloud.networkservices.v1.ICreateAuthzExtensionRequest, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateAuthzExtensionRequest
callback Callback<LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createLbEdgeExtension(request, options)

createLbEdgeExtension(request?: protos.google.cloud.networkservices.v1.ICreateLbEdgeExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new LbEdgeExtension resource in a given project and location.

Parameters
Name Description
request ICreateLbEdgeExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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 parent resource of the `LbEdgeExtension` resource. Must be in
   *  the format `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. User-provided ID of the `LbEdgeExtension` resource to be created.
   */
  // const lbEdgeExtensionId = 'abc123'
  /**
   *  Required. `LbEdgeExtension` resource to be created.
   */
  // const lbEdgeExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callCreateLbEdgeExtension() {
    // Construct request
    const request = {
      parent,
      lbEdgeExtensionId,
      lbEdgeExtension,
    };

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

  callCreateLbEdgeExtension();

createLbEdgeExtension(request, options, callback)

createLbEdgeExtension(request: protos.google.cloud.networkservices.v1.ICreateLbEdgeExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateLbEdgeExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createLbEdgeExtension(request, callback)

createLbEdgeExtension(request: protos.google.cloud.networkservices.v1.ICreateLbEdgeExtensionRequest, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateLbEdgeExtensionRequest
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createLbRouteExtension(request, options)

createLbRouteExtension(request?: protos.google.cloud.networkservices.v1.ICreateLbRouteExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new LbRouteExtension resource in a given project and location.

Parameters
Name Description
request ICreateLbRouteExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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 parent resource of the `LbRouteExtension` resource. Must be
   *  in the format `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. User-provided ID of the `LbRouteExtension` resource to be
   *  created.
   */
  // const lbRouteExtensionId = 'abc123'
  /**
   *  Required. `LbRouteExtension` resource to be created.
   */
  // const lbRouteExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callCreateLbRouteExtension() {
    // Construct request
    const request = {
      parent,
      lbRouteExtensionId,
      lbRouteExtension,
    };

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

  callCreateLbRouteExtension();

createLbRouteExtension(request, options, callback)

createLbRouteExtension(request: protos.google.cloud.networkservices.v1.ICreateLbRouteExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateLbRouteExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createLbRouteExtension(request, callback)

createLbRouteExtension(request: protos.google.cloud.networkservices.v1.ICreateLbRouteExtensionRequest, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateLbRouteExtensionRequest
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createLbTrafficExtension(request, options)

createLbTrafficExtension(request?: protos.google.cloud.networkservices.v1.ICreateLbTrafficExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new LbTrafficExtension resource in a given project and location.

Parameters
Name Description
request ICreateLbTrafficExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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 parent resource of the `LbTrafficExtension` resource. Must be
   *  in the format `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. User-provided ID of the `LbTrafficExtension` resource to be
   *  created.
   */
  // const lbTrafficExtensionId = 'abc123'
  /**
   *  Required. `LbTrafficExtension` resource to be created.
   */
  // const lbTrafficExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callCreateLbTrafficExtension() {
    // Construct request
    const request = {
      parent,
      lbTrafficExtensionId,
      lbTrafficExtension,
    };

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

  callCreateLbTrafficExtension();

createLbTrafficExtension(request, options, callback)

createLbTrafficExtension(request: protos.google.cloud.networkservices.v1.ICreateLbTrafficExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateLbTrafficExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createLbTrafficExtension(request, callback)

createLbTrafficExtension(request: protos.google.cloud.networkservices.v1.ICreateLbTrafficExtensionRequest, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateLbTrafficExtensionRequest
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAuthzExtension(request, options)

deleteAuthzExtension(request?: protos.google.cloud.networkservices.v1.IDeleteAuthzExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes the specified AuthzExtension resource.

Parameters
Name Description
request IDeleteAuthzExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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 name of the `AuthzExtension` resource to delete. Must
   *  be in the format
   *  `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`.
   */
  // 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 can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callDeleteAuthzExtension();

deleteAuthzExtension(request, options, callback)

deleteAuthzExtension(request: protos.google.cloud.networkservices.v1.IDeleteAuthzExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteAuthzExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAuthzExtension(request, callback)

deleteAuthzExtension(request: protos.google.cloud.networkservices.v1.IDeleteAuthzExtensionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteAuthzExtensionRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteLbEdgeExtension(request, options)

deleteLbEdgeExtension(request?: protos.google.cloud.networkservices.v1.IDeleteLbEdgeExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes the specified LbEdgeExtension resource.

Parameters
Name Description
request IDeleteLbEdgeExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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 name of the `LbEdgeExtension` resource to delete. Must be in
   *  the format
   *  `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.
   */
  // 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 can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callDeleteLbEdgeExtension();

deleteLbEdgeExtension(request, options, callback)

deleteLbEdgeExtension(request: protos.google.cloud.networkservices.v1.IDeleteLbEdgeExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteLbEdgeExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteLbEdgeExtension(request, callback)

deleteLbEdgeExtension(request: protos.google.cloud.networkservices.v1.IDeleteLbEdgeExtensionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteLbEdgeExtensionRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteLbRouteExtension(request, options)

deleteLbRouteExtension(request?: protos.google.cloud.networkservices.v1.IDeleteLbRouteExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes the specified LbRouteExtension resource.

Parameters
Name Description
request IDeleteLbRouteExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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 name of the `LbRouteExtension` resource to delete. Must be in
   *  the format
   *  `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.
   */
  // 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 can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callDeleteLbRouteExtension();

deleteLbRouteExtension(request, options, callback)

deleteLbRouteExtension(request: protos.google.cloud.networkservices.v1.IDeleteLbRouteExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteLbRouteExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteLbRouteExtension(request, callback)

deleteLbRouteExtension(request: protos.google.cloud.networkservices.v1.IDeleteLbRouteExtensionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteLbRouteExtensionRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteLbTrafficExtension(request, options)

deleteLbTrafficExtension(request?: protos.google.cloud.networkservices.v1.IDeleteLbTrafficExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes the specified LbTrafficExtension resource.

Parameters
Name Description
request IDeleteLbTrafficExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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 name of the `LbTrafficExtension` resource to delete. Must be
   *  in the format
   *  `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
   */
  // 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 can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callDeleteLbTrafficExtension();

deleteLbTrafficExtension(request, options, callback)

deleteLbTrafficExtension(request: protos.google.cloud.networkservices.v1.IDeleteLbTrafficExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteLbTrafficExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteLbTrafficExtension(request, callback)

deleteLbTrafficExtension(request: protos.google.cloud.networkservices.v1.IDeleteLbTrafficExtensionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteLbTrafficExtensionRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: 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
Name Description
request DeleteOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
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
Type Description
Promise<protos.google.protobuf.Empty>
Example

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

endpointPolicyPath(project, location, endpointPolicy)

endpointPolicyPath(project: string, location: string, endpointPolicy: string): string;

Return a fully-qualified endpointPolicy resource name string.

Parameters
Name Description
project string
location string
endpointPolicy string
Returns
Type Description
string

{string} Resource name string.

gatewayPath(project, location, gateway)

gatewayPath(project: string, location: string, gateway: string): string;

Return a fully-qualified gateway resource name string.

Parameters
Name Description
project string
location string
gateway string
Returns
Type Description
string

{string} Resource name string.

gatewayRouteViewPath(project, location, gateway, routeView)

gatewayRouteViewPath(project: string, location: string, gateway: string, routeView: string): string;

Return a fully-qualified gatewayRouteView resource name string.

Parameters
Name Description
project string
location string
gateway string
routeView string
Returns
Type Description
string

{string} Resource name string.

getAuthzExtension(request, options)

getAuthzExtension(request?: protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkservices.v1.IAuthzExtension,
        protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest | undefined,
        {} | undefined
    ]>;

Gets details of the specified AuthzExtension resource.

Parameters
Name Description
request IGetAuthzExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing AuthzExtension. Please see the documentation 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. A name of the `AuthzExtension` resource to get. Must be in
   *  the format
   *  `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`.
   */
  // const name = 'abc123'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

    // Run request
    const response = await networkservicesClient.getAuthzExtension(request);
    console.log(response);
  }

  callGetAuthzExtension();

getAuthzExtension(request, options, callback)

getAuthzExtension(request: protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAuthzExtensionRequest
options CallOptions
callback Callback<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAuthzExtension(request, callback)

getAuthzExtension(request: protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest, callback: Callback<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAuthzExtensionRequest
callback Callback<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IGetAuthzExtensionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
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
Name Description
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.Policy, 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<google.iam.v1.Policy, 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
Type Description
Promise<[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.

getLbEdgeExtension(request, options)

getLbEdgeExtension(request?: protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkservices.v1.ILbEdgeExtension,
        protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest | undefined,
        {} | undefined
    ]>;

Gets details of the specified LbEdgeExtension resource.

Parameters
Name Description
request IGetLbEdgeExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing LbEdgeExtension. Please see the documentation 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. A name of the `LbEdgeExtension` resource to get. Must be in the
   *  format
   *  `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.
   */
  // const name = 'abc123'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

    // Run request
    const response = await networkservicesClient.getLbEdgeExtension(request);
    console.log(response);
  }

  callGetLbEdgeExtension();

getLbEdgeExtension(request, options, callback)

getLbEdgeExtension(request: protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLbEdgeExtensionRequest
options CallOptions
callback Callback<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLbEdgeExtension(request, callback)

getLbEdgeExtension(request: protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest, callback: Callback<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLbEdgeExtensionRequest
callback Callback<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IGetLbEdgeExtensionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLbRouteExtension(request, options)

getLbRouteExtension(request?: protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkservices.v1.ILbRouteExtension,
        protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest | undefined,
        {} | undefined
    ]>;

Gets details of the specified LbRouteExtension resource.

Parameters
Name Description
request IGetLbRouteExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing LbRouteExtension. Please see the documentation 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. A name of the `LbRouteExtension` resource to get. Must be in the
   *  format
   *  `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.
   */
  // const name = 'abc123'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

    // Run request
    const response = await networkservicesClient.getLbRouteExtension(request);
    console.log(response);
  }

  callGetLbRouteExtension();

getLbRouteExtension(request, options, callback)

getLbRouteExtension(request: protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLbRouteExtensionRequest
options CallOptions
callback Callback<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLbRouteExtension(request, callback)

getLbRouteExtension(request: protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest, callback: Callback<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLbRouteExtensionRequest
callback Callback<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IGetLbRouteExtensionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLbTrafficExtension(request, options)

getLbTrafficExtension(request?: protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkservices.v1.ILbTrafficExtension,
        protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest | undefined,
        {} | undefined
    ]>;

Gets details of the specified LbTrafficExtension resource.

Parameters
Name Description
request IGetLbTrafficExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing LbTrafficExtension. Please see the documentation 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. A name of the `LbTrafficExtension` resource to get. Must be in
   *  the format
   *  `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
   */
  // const name = 'abc123'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

    // Run request
    const response = await networkservicesClient.getLbTrafficExtension(request);
    console.log(response);
  }

  callGetLbTrafficExtension();

getLbTrafficExtension(request, options, callback)

getLbTrafficExtension(request: protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLbTrafficExtensionRequest
options CallOptions
callback Callback<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLbTrafficExtension(request, callback)

getLbTrafficExtension(request: protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest, callback: Callback<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLbTrafficExtensionRequest
callback Callback<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IGetLbTrafficExtensionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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
Name Description
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

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

Call options. See CallOptions for more details.

callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<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 for more details and examples.

Example

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

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: 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
Name Description
request GetOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
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
Type Description
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
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

grpcRoutePath(project, location, grpcRoute)

grpcRoutePath(project: string, location: string, grpcRoute: string): string;

Return a fully-qualified grpcRoute resource name string.

Parameters
Name Description
project string
location string
grpcRoute string
Returns
Type Description
string

{string} Resource name string.

httpRoutePath(project, location, httpRoute)

httpRoutePath(project: string, location: string, httpRoute: string): string;

Return a fully-qualified httpRoute resource name string.

Parameters
Name Description
project string
location string
httpRoute string
Returns
Type Description
string

{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

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

lbEdgeExtensionPath(project, location, lbEdgeExtension)

lbEdgeExtensionPath(project: string, location: string, lbEdgeExtension: string): string;

Return a fully-qualified lbEdgeExtension resource name string.

Parameters
Name Description
project string
location string
lbEdgeExtension string
Returns
Type Description
string

{string} Resource name string.

lbRouteExtensionPath(project, location, lbRouteExtension)

lbRouteExtensionPath(project: string, location: string, lbRouteExtension: string): string;

Return a fully-qualified lbRouteExtension resource name string.

Parameters
Name Description
project string
location string
lbRouteExtension string
Returns
Type Description
string

{string} Resource name string.

lbTrafficExtensionPath(project, location, lbTrafficExtension)

lbTrafficExtensionPath(project: string, location: string, lbTrafficExtension: string): string;

Return a fully-qualified lbTrafficExtension resource name string.

Parameters
Name Description
project string
location string
lbTrafficExtension string
Returns
Type Description
string

{string} Resource name string.

listAuthzExtensions(request, options)

listAuthzExtensions(request?: protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkservices.v1.IAuthzExtension[],
        protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest | null,
        protos.google.cloud.networkservices.v1.IListAuthzExtensionsResponse
    ]>;

Lists AuthzExtension resources in a given project and location.

Parameters
Name Description
request IListAuthzExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networkservices.v1.IAuthzExtension[], protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest | null, protos.google.cloud.networkservices.v1.IListAuthzExtensionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of AuthzExtension. 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 listAuthzExtensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAuthzExtensions(request, options, callback)

listAuthzExtensions(request: protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, protos.google.cloud.networkservices.v1.IListAuthzExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.IAuthzExtension>): void;
Parameters
Name Description
request IListAuthzExtensionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, protos.google.cloud.networkservices.v1.IListAuthzExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.IAuthzExtension>
Returns
Type Description
void

listAuthzExtensions(request, callback)

listAuthzExtensions(request: protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, callback: PaginationCallback<protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, protos.google.cloud.networkservices.v1.IListAuthzExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.IAuthzExtension>): void;
Parameters
Name Description
request IListAuthzExtensionsRequest
callback PaginationCallback<protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, protos.google.cloud.networkservices.v1.IListAuthzExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.IAuthzExtension>
Returns
Type Description
void

listAuthzExtensionsAsync(request, options)

listAuthzExtensionsAsync(request?: protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkservices.v1.IAuthzExtension>;

Equivalent to listAuthzExtensions, but returns an iterable object.

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

Parameters
Name Description
request IListAuthzExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.networkservices.v1.IAuthzExtension>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AuthzExtension. 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 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 project and location from which the `AuthzExtension`
   *  resources are listed. These values are specified in the following format:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. The server might return fewer items than
   *  requested. If unspecified, the server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results that the server returns.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Hint about how to order the results.
   */
  // const orderBy = 'abc123'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callListAuthzExtensions();

listAuthzExtensionsStream(request, options)

listAuthzExtensionsStream(request?: protos.google.cloud.networkservices.v1.IListAuthzExtensionsRequest, options?: CallOptions): Transform;

Equivalent to listAuthzExtensions, but returns a NodeJS Stream object.

Parameters
Name Description
request IListAuthzExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing AuthzExtension 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 listAuthzExtensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLbEdgeExtensions(request, options)

listLbEdgeExtensions(request?: protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkservices.v1.ILbEdgeExtension[],
        protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest | null,
        protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsResponse
    ]>;

Lists LbEdgeExtension resources in a given project and location.

Parameters
Name Description
request IListLbEdgeExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networkservices.v1.ILbEdgeExtension[], protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest | null, protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of LbEdgeExtension. 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 listLbEdgeExtensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLbEdgeExtensions(request, options, callback)

listLbEdgeExtensions(request: protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbEdgeExtension>): void;
Parameters
Name Description
request IListLbEdgeExtensionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbEdgeExtension>
Returns
Type Description
void

listLbEdgeExtensions(request, callback)

listLbEdgeExtensions(request: protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, callback: PaginationCallback<protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbEdgeExtension>): void;
Parameters
Name Description
request IListLbEdgeExtensionsRequest
callback PaginationCallback<protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbEdgeExtension>
Returns
Type Description
void

listLbEdgeExtensionsAsync(request, options)

listLbEdgeExtensionsAsync(request?: protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkservices.v1.ILbEdgeExtension>;

Equivalent to listLbEdgeExtensions, but returns an iterable object.

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

Parameters
Name Description
request IListLbEdgeExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.networkservices.v1.ILbEdgeExtension>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing LbEdgeExtension. 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 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 project and location from which the `LbEdgeExtension`
   *  resources are listed. These values are specified in the following format:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. The server might return fewer items than
   *  requested. If unspecified, the server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results that the server returns.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Hint about how to order the results.
   */
  // const orderBy = 'abc123'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callListLbEdgeExtensions();

listLbEdgeExtensionsStream(request, options)

listLbEdgeExtensionsStream(request?: protos.google.cloud.networkservices.v1.IListLbEdgeExtensionsRequest, options?: CallOptions): Transform;

Equivalent to listLbEdgeExtensions, but returns a NodeJS Stream object.

Parameters
Name Description
request IListLbEdgeExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing LbEdgeExtension 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 listLbEdgeExtensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLbRouteExtensions(request, options)

listLbRouteExtensions(request?: protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkservices.v1.ILbRouteExtension[],
        protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest | null,
        protos.google.cloud.networkservices.v1.IListLbRouteExtensionsResponse
    ]>;

Lists LbRouteExtension resources in a given project and location.

Parameters
Name Description
request IListLbRouteExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networkservices.v1.ILbRouteExtension[], protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest | null, protos.google.cloud.networkservices.v1.IListLbRouteExtensionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of LbRouteExtension. 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 listLbRouteExtensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLbRouteExtensions(request, options, callback)

listLbRouteExtensions(request: protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbRouteExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbRouteExtension>): void;
Parameters
Name Description
request IListLbRouteExtensionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbRouteExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbRouteExtension>
Returns
Type Description
void

listLbRouteExtensions(request, callback)

listLbRouteExtensions(request: protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, callback: PaginationCallback<protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbRouteExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbRouteExtension>): void;
Parameters
Name Description
request IListLbRouteExtensionsRequest
callback PaginationCallback<protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbRouteExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbRouteExtension>
Returns
Type Description
void

listLbRouteExtensionsAsync(request, options)

listLbRouteExtensionsAsync(request?: protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkservices.v1.ILbRouteExtension>;

Equivalent to listLbRouteExtensions, but returns an iterable object.

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

Parameters
Name Description
request IListLbRouteExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.networkservices.v1.ILbRouteExtension>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing LbRouteExtension. 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 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 project and location from which the `LbRouteExtension`
   *  resources are listed. These values are specified in the following format:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. The server might return fewer items than
   *  requested. If unspecified, the server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results that the server returns.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Hint about how to order the results.
   */
  // const orderBy = 'abc123'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callListLbRouteExtensions();

listLbRouteExtensionsStream(request, options)

listLbRouteExtensionsStream(request?: protos.google.cloud.networkservices.v1.IListLbRouteExtensionsRequest, options?: CallOptions): Transform;

Equivalent to listLbRouteExtensions, but returns a NodeJS Stream object.

Parameters
Name Description
request IListLbRouteExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing LbRouteExtension 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 listLbRouteExtensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLbTrafficExtensions(request, options)

listLbTrafficExtensions(request?: protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkservices.v1.ILbTrafficExtension[],
        protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest | null,
        protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsResponse
    ]>;

Lists LbTrafficExtension resources in a given project and location.

Parameters
Name Description
request IListLbTrafficExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networkservices.v1.ILbTrafficExtension[], protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest | null, protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of LbTrafficExtension. 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 listLbTrafficExtensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLbTrafficExtensions(request, options, callback)

listLbTrafficExtensions(request: protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbTrafficExtension>): void;
Parameters
Name Description
request IListLbTrafficExtensionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbTrafficExtension>
Returns
Type Description
void

listLbTrafficExtensions(request, callback)

listLbTrafficExtensions(request: protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, callback: PaginationCallback<protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbTrafficExtension>): void;
Parameters
Name Description
request IListLbTrafficExtensionsRequest
callback PaginationCallback<protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsResponse | null | undefined, protos.google.cloud.networkservices.v1.ILbTrafficExtension>
Returns
Type Description
void

listLbTrafficExtensionsAsync(request, options)

listLbTrafficExtensionsAsync(request?: protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkservices.v1.ILbTrafficExtension>;

Equivalent to listLbTrafficExtensions, but returns an iterable object.

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

Parameters
Name Description
request IListLbTrafficExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.networkservices.v1.ILbTrafficExtension>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing LbTrafficExtension. 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 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 project and location from which the `LbTrafficExtension`
   *  resources are listed. These values are specified in the following format:
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. The server might return fewer items than
   *  requested. If unspecified, the server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results that the server returns.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filtering results.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Hint about how to order the results.
   */
  // const orderBy = 'abc123'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

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

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

  callListLbTrafficExtensions();

listLbTrafficExtensionsStream(request, options)

listLbTrafficExtensionsStream(request?: protos.google.cloud.networkservices.v1.IListLbTrafficExtensionsRequest, options?: CallOptions): Transform;

Equivalent to listLbTrafficExtensions, but returns a NodeJS Stream object.

Parameters
Name Description
request IListLbTrafficExtensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing LbTrafficExtension 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 listLbTrafficExtensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation 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
Name Description
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allows async iteration. 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 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.IOperation>;

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
Name Description
request ListOperationsRequest

The request object that will be sent.

options 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
Type Description
AsyncIterable<protos.google.longrunning.IOperation>

{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
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchAuthzExtensionFromAuthzExtensionName(authzExtensionName)

matchAuthzExtensionFromAuthzExtensionName(authzExtensionName: string): string | number;

Parse the authz_extension from AuthzExtension resource.

Parameter
Name Description
authzExtensionName string

A fully-qualified path representing AuthzExtension resource.

Returns
Type Description
string | number

{string} A string representing the authz_extension.

matchEndpointPolicyFromEndpointPolicyName(endpointPolicyName)

matchEndpointPolicyFromEndpointPolicyName(endpointPolicyName: string): string | number;

Parse the endpoint_policy from EndpointPolicy resource.

Parameter
Name Description
endpointPolicyName string

A fully-qualified path representing EndpointPolicy resource.

Returns
Type Description
string | number

{string} A string representing the endpoint_policy.

matchGatewayFromGatewayName(gatewayName)

matchGatewayFromGatewayName(gatewayName: string): string | number;

Parse the gateway from Gateway resource.

Parameter
Name Description
gatewayName string

A fully-qualified path representing Gateway resource.

Returns
Type Description
string | number

{string} A string representing the gateway.

matchGatewayFromGatewayRouteViewName(gatewayRouteViewName)

matchGatewayFromGatewayRouteViewName(gatewayRouteViewName: string): string | number;

Parse the gateway from GatewayRouteView resource.

Parameter
Name Description
gatewayRouteViewName string

A fully-qualified path representing GatewayRouteView resource.

Returns
Type Description
string | number

{string} A string representing the gateway.

matchGrpcRouteFromGrpcRouteName(grpcRouteName)

matchGrpcRouteFromGrpcRouteName(grpcRouteName: string): string | number;

Parse the grpc_route from GrpcRoute resource.

Parameter
Name Description
grpcRouteName string

A fully-qualified path representing GrpcRoute resource.

Returns
Type Description
string | number

{string} A string representing the grpc_route.

matchHttpRouteFromHttpRouteName(httpRouteName)

matchHttpRouteFromHttpRouteName(httpRouteName: string): string | number;

Parse the http_route from HttpRoute resource.

Parameter
Name Description
httpRouteName string

A fully-qualified path representing HttpRoute resource.

Returns
Type Description
string | number

{string} A string representing the http_route.

matchLbEdgeExtensionFromLbEdgeExtensionName(lbEdgeExtensionName)

matchLbEdgeExtensionFromLbEdgeExtensionName(lbEdgeExtensionName: string): string | number;

Parse the lb_edge_extension from LbEdgeExtension resource.

Parameter
Name Description
lbEdgeExtensionName string

A fully-qualified path representing LbEdgeExtension resource.

Returns
Type Description
string | number

{string} A string representing the lb_edge_extension.

matchLbRouteExtensionFromLbRouteExtensionName(lbRouteExtensionName)

matchLbRouteExtensionFromLbRouteExtensionName(lbRouteExtensionName: string): string | number;

Parse the lb_route_extension from LbRouteExtension resource.

Parameter
Name Description
lbRouteExtensionName string

A fully-qualified path representing LbRouteExtension resource.

Returns
Type Description
string | number

{string} A string representing the lb_route_extension.

matchLbTrafficExtensionFromLbTrafficExtensionName(lbTrafficExtensionName)

matchLbTrafficExtensionFromLbTrafficExtensionName(lbTrafficExtensionName: string): string | number;

Parse the lb_traffic_extension from LbTrafficExtension resource.

Parameter
Name Description
lbTrafficExtensionName string

A fully-qualified path representing LbTrafficExtension resource.

Returns
Type Description
string | number

{string} A string representing the lb_traffic_extension.

matchLocationFromAuthzExtensionName(authzExtensionName)

matchLocationFromAuthzExtensionName(authzExtensionName: string): string | number;

Parse the location from AuthzExtension resource.

Parameter
Name Description
authzExtensionName string

A fully-qualified path representing AuthzExtension resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEndpointPolicyName(endpointPolicyName)

matchLocationFromEndpointPolicyName(endpointPolicyName: string): string | number;

Parse the location from EndpointPolicy resource.

Parameter
Name Description
endpointPolicyName string

A fully-qualified path representing EndpointPolicy resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromGatewayName(gatewayName)

matchLocationFromGatewayName(gatewayName: string): string | number;

Parse the location from Gateway resource.

Parameter
Name Description
gatewayName string

A fully-qualified path representing Gateway resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromGatewayRouteViewName(gatewayRouteViewName)

matchLocationFromGatewayRouteViewName(gatewayRouteViewName: string): string | number;

Parse the location from GatewayRouteView resource.

Parameter
Name Description
gatewayRouteViewName string

A fully-qualified path representing GatewayRouteView resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromGrpcRouteName(grpcRouteName)

matchLocationFromGrpcRouteName(grpcRouteName: string): string | number;

Parse the location from GrpcRoute resource.

Parameter
Name Description
grpcRouteName string

A fully-qualified path representing GrpcRoute resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromHttpRouteName(httpRouteName)

matchLocationFromHttpRouteName(httpRouteName: string): string | number;

Parse the location from HttpRoute resource.

Parameter
Name Description
httpRouteName string

A fully-qualified path representing HttpRoute resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLbEdgeExtensionName(lbEdgeExtensionName)

matchLocationFromLbEdgeExtensionName(lbEdgeExtensionName: string): string | number;

Parse the location from LbEdgeExtension resource.

Parameter
Name Description
lbEdgeExtensionName string

A fully-qualified path representing LbEdgeExtension resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLbRouteExtensionName(lbRouteExtensionName)

matchLocationFromLbRouteExtensionName(lbRouteExtensionName: string): string | number;

Parse the location from LbRouteExtension resource.

Parameter
Name Description
lbRouteExtensionName string

A fully-qualified path representing LbRouteExtension resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLbTrafficExtensionName(lbTrafficExtensionName)

matchLocationFromLbTrafficExtensionName(lbTrafficExtensionName: string): string | number;

Parse the location from LbTrafficExtension resource.

Parameter
Name Description
lbTrafficExtensionName string

A fully-qualified path representing LbTrafficExtension resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromMeshName(meshName)

matchLocationFromMeshName(meshName: string): string | number;

Parse the location from Mesh resource.

Parameter
Name Description
meshName string

A fully-qualified path representing Mesh resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromMeshRouteViewName(meshRouteViewName)

matchLocationFromMeshRouteViewName(meshRouteViewName: string): string | number;

Parse the location from MeshRouteView resource.

Parameter
Name Description
meshRouteViewName string

A fully-qualified path representing MeshRouteView resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromServiceBindingName(serviceBindingName)

matchLocationFromServiceBindingName(serviceBindingName: string): string | number;

Parse the location from ServiceBinding resource.

Parameter
Name Description
serviceBindingName string

A fully-qualified path representing ServiceBinding resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromServiceLbPolicyName(serviceLbPolicyName)

matchLocationFromServiceLbPolicyName(serviceLbPolicyName: string): string | number;

Parse the location from ServiceLbPolicy resource.

Parameter
Name Description
serviceLbPolicyName string

A fully-qualified path representing ServiceLbPolicy resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromTcpRouteName(tcpRouteName)

matchLocationFromTcpRouteName(tcpRouteName: string): string | number;

Parse the location from TcpRoute resource.

Parameter
Name Description
tcpRouteName string

A fully-qualified path representing TcpRoute resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromTlsRouteName(tlsRouteName)

matchLocationFromTlsRouteName(tlsRouteName: string): string | number;

Parse the location from TlsRoute resource.

Parameter
Name Description
tlsRouteName string

A fully-qualified path representing TlsRoute resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromWasmPluginName(wasmPluginName)

matchLocationFromWasmPluginName(wasmPluginName: string): string | number;

Parse the location from WasmPlugin resource.

Parameter
Name Description
wasmPluginName string

A fully-qualified path representing WasmPlugin resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromWasmPluginVersionName(wasmPluginVersionName)

matchLocationFromWasmPluginVersionName(wasmPluginVersionName: string): string | number;

Parse the location from WasmPluginVersion resource.

Parameter
Name Description
wasmPluginVersionName string

A fully-qualified path representing WasmPluginVersion resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchMeshFromMeshName(meshName)

matchMeshFromMeshName(meshName: string): string | number;

Parse the mesh from Mesh resource.

Parameter
Name Description
meshName string

A fully-qualified path representing Mesh resource.

Returns
Type Description
string | number

{string} A string representing the mesh.

matchMeshFromMeshRouteViewName(meshRouteViewName)

matchMeshFromMeshRouteViewName(meshRouteViewName: string): string | number;

Parse the mesh from MeshRouteView resource.

Parameter
Name Description
meshRouteViewName string

A fully-qualified path representing MeshRouteView resource.

Returns
Type Description
string | number

{string} A string representing the mesh.

matchProjectFromAuthzExtensionName(authzExtensionName)

matchProjectFromAuthzExtensionName(authzExtensionName: string): string | number;

Parse the project from AuthzExtension resource.

Parameter
Name Description
authzExtensionName string

A fully-qualified path representing AuthzExtension resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEndpointPolicyName(endpointPolicyName)

matchProjectFromEndpointPolicyName(endpointPolicyName: string): string | number;

Parse the project from EndpointPolicy resource.

Parameter
Name Description
endpointPolicyName string

A fully-qualified path representing EndpointPolicy resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromGatewayName(gatewayName)

matchProjectFromGatewayName(gatewayName: string): string | number;

Parse the project from Gateway resource.

Parameter
Name Description
gatewayName string

A fully-qualified path representing Gateway resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromGatewayRouteViewName(gatewayRouteViewName)

matchProjectFromGatewayRouteViewName(gatewayRouteViewName: string): string | number;

Parse the project from GatewayRouteView resource.

Parameter
Name Description
gatewayRouteViewName string

A fully-qualified path representing GatewayRouteView resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromGrpcRouteName(grpcRouteName)

matchProjectFromGrpcRouteName(grpcRouteName: string): string | number;

Parse the project from GrpcRoute resource.

Parameter
Name Description
grpcRouteName string

A fully-qualified path representing GrpcRoute resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromHttpRouteName(httpRouteName)

matchProjectFromHttpRouteName(httpRouteName: string): string | number;

Parse the project from HttpRoute resource.

Parameter
Name Description
httpRouteName string

A fully-qualified path representing HttpRoute resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLbEdgeExtensionName(lbEdgeExtensionName)

matchProjectFromLbEdgeExtensionName(lbEdgeExtensionName: string): string | number;

Parse the project from LbEdgeExtension resource.

Parameter
Name Description
lbEdgeExtensionName string

A fully-qualified path representing LbEdgeExtension resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLbRouteExtensionName(lbRouteExtensionName)

matchProjectFromLbRouteExtensionName(lbRouteExtensionName: string): string | number;

Parse the project from LbRouteExtension resource.

Parameter
Name Description
lbRouteExtensionName string

A fully-qualified path representing LbRouteExtension resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLbTrafficExtensionName(lbTrafficExtensionName)

matchProjectFromLbTrafficExtensionName(lbTrafficExtensionName: string): string | number;

Parse the project from LbTrafficExtension resource.

Parameter
Name Description
lbTrafficExtensionName string

A fully-qualified path representing LbTrafficExtension resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromMeshName(meshName)

matchProjectFromMeshName(meshName: string): string | number;

Parse the project from Mesh resource.

Parameter
Name Description
meshName string

A fully-qualified path representing Mesh resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromMeshRouteViewName(meshRouteViewName)

matchProjectFromMeshRouteViewName(meshRouteViewName: string): string | number;

Parse the project from MeshRouteView resource.

Parameter
Name Description
meshRouteViewName string

A fully-qualified path representing MeshRouteView resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromServiceBindingName(serviceBindingName)

matchProjectFromServiceBindingName(serviceBindingName: string): string | number;

Parse the project from ServiceBinding resource.

Parameter
Name Description
serviceBindingName string

A fully-qualified path representing ServiceBinding resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromServiceLbPolicyName(serviceLbPolicyName)

matchProjectFromServiceLbPolicyName(serviceLbPolicyName: string): string | number;

Parse the project from ServiceLbPolicy resource.

Parameter
Name Description
serviceLbPolicyName string

A fully-qualified path representing ServiceLbPolicy resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromTcpRouteName(tcpRouteName)

matchProjectFromTcpRouteName(tcpRouteName: string): string | number;

Parse the project from TcpRoute resource.

Parameter
Name Description
tcpRouteName string

A fully-qualified path representing TcpRoute resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromTlsRouteName(tlsRouteName)

matchProjectFromTlsRouteName(tlsRouteName: string): string | number;

Parse the project from TlsRoute resource.

Parameter
Name Description
tlsRouteName string

A fully-qualified path representing TlsRoute resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromWasmPluginName(wasmPluginName)

matchProjectFromWasmPluginName(wasmPluginName: string): string | number;

Parse the project from WasmPlugin resource.

Parameter
Name Description
wasmPluginName string

A fully-qualified path representing WasmPlugin resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromWasmPluginVersionName(wasmPluginVersionName)

matchProjectFromWasmPluginVersionName(wasmPluginVersionName: string): string | number;

Parse the project from WasmPluginVersion resource.

Parameter
Name Description
wasmPluginVersionName string

A fully-qualified path representing WasmPluginVersion resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchRouteViewFromGatewayRouteViewName(gatewayRouteViewName)

matchRouteViewFromGatewayRouteViewName(gatewayRouteViewName: string): string | number;

Parse the route_view from GatewayRouteView resource.

Parameter
Name Description
gatewayRouteViewName string

A fully-qualified path representing GatewayRouteView resource.

Returns
Type Description
string | number

{string} A string representing the route_view.

matchRouteViewFromMeshRouteViewName(meshRouteViewName)

matchRouteViewFromMeshRouteViewName(meshRouteViewName: string): string | number;

Parse the route_view from MeshRouteView resource.

Parameter
Name Description
meshRouteViewName string

A fully-qualified path representing MeshRouteView resource.

Returns
Type Description
string | number

{string} A string representing the route_view.

matchServiceBindingFromServiceBindingName(serviceBindingName)

matchServiceBindingFromServiceBindingName(serviceBindingName: string): string | number;

Parse the service_binding from ServiceBinding resource.

Parameter
Name Description
serviceBindingName string

A fully-qualified path representing ServiceBinding resource.

Returns
Type Description
string | number

{string} A string representing the service_binding.

matchServiceLbPolicyFromServiceLbPolicyName(serviceLbPolicyName)

matchServiceLbPolicyFromServiceLbPolicyName(serviceLbPolicyName: string): string | number;

Parse the service_lb_policy from ServiceLbPolicy resource.

Parameter
Name Description
serviceLbPolicyName string

A fully-qualified path representing ServiceLbPolicy resource.

Returns
Type Description
string | number

{string} A string representing the service_lb_policy.

matchTcpRouteFromTcpRouteName(tcpRouteName)

matchTcpRouteFromTcpRouteName(tcpRouteName: string): string | number;

Parse the tcp_route from TcpRoute resource.

Parameter
Name Description
tcpRouteName string

A fully-qualified path representing TcpRoute resource.

Returns
Type Description
string | number

{string} A string representing the tcp_route.

matchTlsRouteFromTlsRouteName(tlsRouteName)

matchTlsRouteFromTlsRouteName(tlsRouteName: string): string | number;

Parse the tls_route from TlsRoute resource.

Parameter
Name Description
tlsRouteName string

A fully-qualified path representing TlsRoute resource.

Returns
Type Description
string | number

{string} A string representing the tls_route.

matchWasmPluginFromWasmPluginName(wasmPluginName)

matchWasmPluginFromWasmPluginName(wasmPluginName: string): string | number;

Parse the wasm_plugin from WasmPlugin resource.

Parameter
Name Description
wasmPluginName string

A fully-qualified path representing WasmPlugin resource.

Returns
Type Description
string | number

{string} A string representing the wasm_plugin.

matchWasmPluginFromWasmPluginVersionName(wasmPluginVersionName)

matchWasmPluginFromWasmPluginVersionName(wasmPluginVersionName: string): string | number;

Parse the wasm_plugin from WasmPluginVersion resource.

Parameter
Name Description
wasmPluginVersionName string

A fully-qualified path representing WasmPluginVersion resource.

Returns
Type Description
string | number

{string} A string representing the wasm_plugin.

matchWasmPluginVersionFromWasmPluginVersionName(wasmPluginVersionName)

matchWasmPluginVersionFromWasmPluginVersionName(wasmPluginVersionName: string): string | number;

Parse the wasm_plugin_version from WasmPluginVersion resource.

Parameter
Name Description
wasmPluginVersionName string

A fully-qualified path representing WasmPluginVersion resource.

Returns
Type Description
string | number

{string} A string representing the wasm_plugin_version.

meshPath(project, location, mesh)

meshPath(project: string, location: string, mesh: string): string;

Return a fully-qualified mesh resource name string.

Parameters
Name Description
project string
location string
mesh string
Returns
Type Description
string

{string} Resource name string.

meshRouteViewPath(project, location, mesh, routeView)

meshRouteViewPath(project: string, location: string, mesh: string, routeView: string): string;

Return a fully-qualified meshRouteView resource name string.

Parameters
Name Description
project string
location string
mesh string
routeView string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

serviceBindingPath(project, location, serviceBinding)

serviceBindingPath(project: string, location: string, serviceBinding: string): string;

Return a fully-qualified serviceBinding resource name string.

Parameters
Name Description
project string
location string
serviceBinding string
Returns
Type Description
string

{string} Resource name string.

serviceLbPolicyPath(project, location, serviceLbPolicy)

serviceLbPolicyPath(project: string, location: string, serviceLbPolicy: string): string;

Return a fully-qualified serviceLbPolicy resource name string.

Parameters
Name Description
project string
location string
serviceLbPolicy string
Returns
Type Description
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
Name Description
request IamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.Policy, 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<google.iam.v1.Policy, 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
Type Description
Promise<[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.

tcpRoutePath(project, location, tcpRoute)

tcpRoutePath(project: string, location: string, tcpRoute: string): string;

Return a fully-qualified tcpRoute resource name string.

Parameters
Name Description
project string
location string
tcpRoute string
Returns
Type Description
string

{string} Resource name string.

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
Name Description
request IamProtos.google.iam.v1.TestIamPermissionsRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, 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<google.iam.v1.TestIamPermissionsResponse, 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
Type Description
Promise<[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.

tlsRoutePath(project, location, tlsRoute)

tlsRoutePath(project: string, location: string, tlsRoute: string): string;

Return a fully-qualified tlsRoute resource name string.

Parameters
Name Description
project string
location string
tlsRoute string
Returns
Type Description
string

{string} Resource name string.

updateAuthzExtension(request, options)

updateAuthzExtension(request?: protos.google.cloud.networkservices.v1.IUpdateAuthzExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of the specified AuthzExtension resource.

Parameters
Name Description
request IUpdateAuthzExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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. Used to specify the fields to be overwritten in the
   *  `AuthzExtension` resource by the update.
   *  The fields specified in the `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If the
   *  user does not specify a mask, then all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. `AuthzExtension` resource being updated.
   */
  // const authzExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callUpdateAuthzExtension() {
    // Construct request
    const request = {
      updateMask,
      authzExtension,
    };

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

  callUpdateAuthzExtension();

updateAuthzExtension(request, options, callback)

updateAuthzExtension(request: protos.google.cloud.networkservices.v1.IUpdateAuthzExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateAuthzExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateAuthzExtension(request, callback)

updateAuthzExtension(request: protos.google.cloud.networkservices.v1.IUpdateAuthzExtensionRequest, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateAuthzExtensionRequest
callback Callback<LROperation<protos.google.cloud.networkservices.v1.IAuthzExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLbEdgeExtension(request, options)

updateLbEdgeExtension(request?: protos.google.cloud.networkservices.v1.IUpdateLbEdgeExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of the specified LbEdgeExtension resource.

Parameters
Name Description
request IUpdateLbEdgeExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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.
   */
  /**
   *  Optional. Used to specify the fields to be overwritten in the
   *  `LbEdgeExtension` resource by the update.
   *  The fields specified in the `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If the
   *  user does not specify a mask, then all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. `LbEdgeExtension` resource being updated.
   */
  // const lbEdgeExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callUpdateLbEdgeExtension() {
    // Construct request
    const request = {
      lbEdgeExtension,
    };

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

  callUpdateLbEdgeExtension();

updateLbEdgeExtension(request, options, callback)

updateLbEdgeExtension(request: protos.google.cloud.networkservices.v1.IUpdateLbEdgeExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLbEdgeExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLbEdgeExtension(request, callback)

updateLbEdgeExtension(request: protos.google.cloud.networkservices.v1.IUpdateLbEdgeExtensionRequest, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLbEdgeExtensionRequest
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbEdgeExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLbRouteExtension(request, options)

updateLbRouteExtension(request?: protos.google.cloud.networkservices.v1.IUpdateLbRouteExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of the specified LbRouteExtension resource.

Parameters
Name Description
request IUpdateLbRouteExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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.
   */
  /**
   *  Optional. Used to specify the fields to be overwritten in the
   *  `LbRouteExtension` resource by the update.
   *  The fields specified in the `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If the
   *  user does not specify a mask, then all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. `LbRouteExtension` resource being updated.
   */
  // const lbRouteExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callUpdateLbRouteExtension() {
    // Construct request
    const request = {
      lbRouteExtension,
    };

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

  callUpdateLbRouteExtension();

updateLbRouteExtension(request, options, callback)

updateLbRouteExtension(request: protos.google.cloud.networkservices.v1.IUpdateLbRouteExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLbRouteExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLbRouteExtension(request, callback)

updateLbRouteExtension(request: protos.google.cloud.networkservices.v1.IUpdateLbRouteExtensionRequest, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLbRouteExtensionRequest
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbRouteExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLbTrafficExtension(request, options)

updateLbTrafficExtension(request?: protos.google.cloud.networkservices.v1.IUpdateLbTrafficExtensionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of the specified LbTrafficExtension resource.

Parameters
Name Description
request IUpdateLbTrafficExtensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, 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 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.
   */
  /**
   *  Optional. Used to specify the fields to be overwritten in the
   *  `LbTrafficExtension` resource by the update.
   *  The fields specified in the `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If the
   *  user does not specify a mask, then all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. `LbTrafficExtension` resource being updated.
   */
  // const lbTrafficExtension = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server guarantees
   *  that for 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server ignores 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'

  // Imports the Networkservices library
  const {DepServiceClient} = require('@google-cloud/networkservices').v1;

  // Instantiates a client
  const networkservicesClient = new DepServiceClient();

  async function callUpdateLbTrafficExtension() {
    // Construct request
    const request = {
      lbTrafficExtension,
    };

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

  callUpdateLbTrafficExtension();

updateLbTrafficExtension(request, options, callback)

updateLbTrafficExtension(request: protos.google.cloud.networkservices.v1.IUpdateLbTrafficExtensionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLbTrafficExtensionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLbTrafficExtension(request, callback)

updateLbTrafficExtension(request: protos.google.cloud.networkservices.v1.IUpdateLbTrafficExtensionRequest, callback: Callback<LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLbTrafficExtensionRequest
callback Callback<LROperation<protos.google.cloud.networkservices.v1.ILbTrafficExtension, protos.google.cloud.networkservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

wasmPluginPath(project, location, wasmPlugin)

wasmPluginPath(project: string, location: string, wasmPlugin: string): string;

Return a fully-qualified wasmPlugin resource name string.

Parameters
Name Description
project string
location string
wasmPlugin string
Returns
Type Description
string

{string} Resource name string.

wasmPluginVersionPath(project, location, wasmPlugin, wasmPluginVersion)

wasmPluginVersionPath(project: string, location: string, wasmPlugin: string, wasmPluginVersion: string): string;

Return a fully-qualified wasmPluginVersion resource name string.

Parameters
Name Description
project string
location string
wasmPlugin string
wasmPluginVersion string
Returns
Type Description
string

{string} Resource name string.