Class v1alpha1.InterceptClient (4.1.1)

Service for Third-Party Packet Intercept (TPPI). TPPI is the "in-band" flavor of the Network Security Integrations product. v1alpha1

Package

@google-cloud/network-security

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of InterceptClient.

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

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

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

interceptStub

interceptStub?: Promise<{
        [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

authorizationPolicyPath(project, location, authorizationPolicy)

authorizationPolicyPath(project: string, location: string, authorizationPolicy: string): string;

Return a fully-qualified authorizationPolicy resource name string.

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

{string} Resource name string.

authzPolicyPath(project, location, authzPolicy)

authzPolicyPath(project: string, location: string, authzPolicy: string): string;

Return a fully-qualified authzPolicy resource name string.

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

{string} Resource name string.

backendAuthenticationConfigPath(project, location, backendAuthenticationConfig)

backendAuthenticationConfigPath(project: string, location: string, backendAuthenticationConfig: string): string;

Return a fully-qualified backendAuthenticationConfig resource name string.

Parameters
Name Description
project string
location string
backendAuthenticationConfig 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: ''});

checkCreateInterceptDeploymentGroupProgress(name)

checkCreateInterceptDeploymentGroupProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.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 where this deployment group will be created.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the new deployment group, which will become the
   *  final component of the deployment group's resource name.
   */
  // const interceptDeploymentGroupId = 'abc123'
  /**
   *  Required. The deployment group to create.
   */
  // const interceptDeploymentGroup = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callCreateInterceptDeploymentGroup() {
    // Construct request
    const request = {
      parent,
      interceptDeploymentGroupId,
      interceptDeploymentGroup,
    };

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

  callCreateInterceptDeploymentGroup();

checkCreateInterceptDeploymentProgress(name)

checkCreateInterceptDeploymentProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.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 where this deployment will be created.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the new deployment, which will become the final
   *  component of the deployment's resource name.
   */
  // const interceptDeploymentId = 'abc123'
  /**
   *  Required. The deployment to create.
   */
  // const interceptDeployment = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callCreateInterceptDeployment() {
    // Construct request
    const request = {
      parent,
      interceptDeploymentId,
      interceptDeployment,
    };

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

  callCreateInterceptDeployment();

checkCreateInterceptEndpointGroupAssociationProgress(name)

checkCreateInterceptEndpointGroupAssociationProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.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 where this association will be created.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The ID to use for the new association, which will become the
   *  final component of the endpoint group's resource name. If not provided, the
   *  server will generate a unique ID.
   */
  // const interceptEndpointGroupAssociationId = 'abc123'
  /**
   *  Required. The association to create.
   */
  // const interceptEndpointGroupAssociation = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callCreateInterceptEndpointGroupAssociation();

checkCreateInterceptEndpointGroupProgress(name)

checkCreateInterceptEndpointGroupProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.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 where this endpoint group will be created.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the endpoint group, which will become the final
   *  component of the endpoint group's resource name.
   */
  // const interceptEndpointGroupId = 'abc123'
  /**
   *  Required. The endpoint group to create.
   */
  // const interceptEndpointGroup = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callCreateInterceptEndpointGroup() {
    // Construct request
    const request = {
      parent,
      interceptEndpointGroupId,
      interceptEndpointGroup,
    };

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

  callCreateInterceptEndpointGroup();

checkDeleteInterceptDeploymentGroupProgress(name)

checkDeleteInterceptDeploymentGroupProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1alpha1.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 deployment group to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callDeleteInterceptDeploymentGroup();

checkDeleteInterceptDeploymentProgress(name)

checkDeleteInterceptDeploymentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1alpha1.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. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callDeleteInterceptDeployment();

checkDeleteInterceptEndpointGroupAssociationProgress(name)

checkDeleteInterceptEndpointGroupAssociationProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1alpha1.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 association to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callDeleteInterceptEndpointGroupAssociation();

checkDeleteInterceptEndpointGroupProgress(name)

checkDeleteInterceptEndpointGroupProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1alpha1.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 endpoint group to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callDeleteInterceptEndpointGroup();

checkUpdateInterceptDeploymentGroupProgress(name)

checkUpdateInterceptDeploymentGroupProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.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. The list of fields to update.
   *  Fields are specified relative to the deployment group
   *  (e.g. `description`; *not*
   *  `intercept_deployment_group.description`). See
   *  https://google.aip.dev/161 for more details.
   */
  // const updateMask = {}
  /**
   *  Required. The deployment group to update.
   */
  // const interceptDeploymentGroup = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callUpdateInterceptDeploymentGroup() {
    // Construct request
    const request = {
      interceptDeploymentGroup,
    };

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

  callUpdateInterceptDeploymentGroup();

checkUpdateInterceptDeploymentProgress(name)

checkUpdateInterceptDeploymentProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.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. The list of fields to update.
   *  Fields are specified relative to the deployment
   *  (e.g. `description`; *not* `intercept_deployment.description`).
   *  See https://google.aip.dev/161 for more details.
   */
  // const updateMask = {}
  /**
   *  Required. The deployment to update.
   */
  // const interceptDeployment = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callUpdateInterceptDeployment() {
    // Construct request
    const request = {
      interceptDeployment,
    };

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

  callUpdateInterceptDeployment();

checkUpdateInterceptEndpointGroupAssociationProgress(name)

checkUpdateInterceptEndpointGroupAssociationProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.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. The list of fields to update.
   *  Fields are specified relative to the association
   *  (e.g. `description`; *not*
   *  `intercept_endpoint_group_association.description`). See
   *  https://google.aip.dev/161 for more details.
   */
  // const updateMask = {}
  /**
   *  Required. The association to update.
   */
  // const interceptEndpointGroupAssociation = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callUpdateInterceptEndpointGroupAssociation() {
    // Construct request
    const request = {
      interceptEndpointGroupAssociation,
    };

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

  callUpdateInterceptEndpointGroupAssociation();

checkUpdateInterceptEndpointGroupProgress(name)

checkUpdateInterceptEndpointGroupProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.networksecurity.v1alpha1.InterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.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. The list of fields to update.
   *  Fields are specified relative to the endpoint group
   *  (e.g. `description`; *not* `intercept_endpoint_group.description`).
   *  See https://google.aip.dev/161 for more details.
   */
  // const updateMask = {}
  /**
   *  Required. The endpoint group to update.
   */
  // const interceptEndpointGroup = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callUpdateInterceptEndpointGroup() {
    // Construct request
    const request = {
      interceptEndpointGroup,
    };

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

  callUpdateInterceptEndpointGroup();

clientTlsPolicyPath(project, location, clientTlsPolicy)

clientTlsPolicyPath(project: string, location: string, clientTlsPolicy: string): string;

Return a fully-qualified clientTlsPolicy resource name string.

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

{string} Resource name string.

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.

createInterceptDeployment(request, options)

createInterceptDeployment(request?: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a deployment in a given project and location. See https://google.aip.dev/133.

Parameters
Name Description
request ICreateInterceptDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.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 where this deployment will be created.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the new deployment, which will become the final
   *  component of the deployment's resource name.
   */
  // const interceptDeploymentId = 'abc123'
  /**
   *  Required. The deployment to create.
   */
  // const interceptDeployment = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callCreateInterceptDeployment() {
    // Construct request
    const request = {
      parent,
      interceptDeploymentId,
      interceptDeployment,
    };

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

  callCreateInterceptDeployment();

createInterceptDeployment(request, options, callback)

createInterceptDeployment(request: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInterceptDeploymentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInterceptDeployment(request, callback)

createInterceptDeployment(request: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptDeploymentRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInterceptDeploymentRequest
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInterceptDeploymentGroup(request, options)

createInterceptDeploymentGroup(request?: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptDeploymentGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a deployment group in a given project and location. See https://google.aip.dev/133.

Parameters
Name Description
request ICreateInterceptDeploymentGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.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 where this deployment group will be created.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the new deployment group, which will become the
   *  final component of the deployment group's resource name.
   */
  // const interceptDeploymentGroupId = 'abc123'
  /**
   *  Required. The deployment group to create.
   */
  // const interceptDeploymentGroup = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callCreateInterceptDeploymentGroup() {
    // Construct request
    const request = {
      parent,
      interceptDeploymentGroupId,
      interceptDeploymentGroup,
    };

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

  callCreateInterceptDeploymentGroup();

createInterceptDeploymentGroup(request, options, callback)

createInterceptDeploymentGroup(request: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptDeploymentGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInterceptDeploymentGroupRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInterceptDeploymentGroup(request, callback)

createInterceptDeploymentGroup(request: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptDeploymentGroupRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInterceptDeploymentGroupRequest
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInterceptEndpointGroup(request, options)

createInterceptEndpointGroup(request?: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptEndpointGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an endpoint group in a given project and location. See https://google.aip.dev/133.

Parameters
Name Description
request ICreateInterceptEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.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 where this endpoint group will be created.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the endpoint group, which will become the final
   *  component of the endpoint group's resource name.
   */
  // const interceptEndpointGroupId = 'abc123'
  /**
   *  Required. The endpoint group to create.
   */
  // const interceptEndpointGroup = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callCreateInterceptEndpointGroup() {
    // Construct request
    const request = {
      parent,
      interceptEndpointGroupId,
      interceptEndpointGroup,
    };

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

  callCreateInterceptEndpointGroup();

createInterceptEndpointGroup(request, options, callback)

createInterceptEndpointGroup(request: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptEndpointGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInterceptEndpointGroupRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInterceptEndpointGroup(request, callback)

createInterceptEndpointGroup(request: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptEndpointGroupRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInterceptEndpointGroupRequest
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInterceptEndpointGroupAssociation(request, options)

createInterceptEndpointGroupAssociation(request?: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptEndpointGroupAssociationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an association in a given project and location. See https://google.aip.dev/133.

Parameters
Name Description
request ICreateInterceptEndpointGroupAssociationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.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 where this association will be created.
   *  Format: projects/{project}/locations/{location}
   */
  // const parent = 'abc123'
  /**
   *  Optional. The ID to use for the new association, which will become the
   *  final component of the endpoint group's resource name. If not provided, the
   *  server will generate a unique ID.
   */
  // const interceptEndpointGroupAssociationId = 'abc123'
  /**
   *  Required. The association to create.
   */
  // const interceptEndpointGroupAssociation = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callCreateInterceptEndpointGroupAssociation();

createInterceptEndpointGroupAssociation(request, options, callback)

createInterceptEndpointGroupAssociation(request: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptEndpointGroupAssociationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInterceptEndpointGroupAssociationRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInterceptEndpointGroupAssociation(request, callback)

createInterceptEndpointGroupAssociation(request: protos.google.cloud.networksecurity.v1alpha1.ICreateInterceptEndpointGroupAssociationRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInterceptEndpointGroupAssociationRequest
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInterceptDeployment(request, options)

deleteInterceptDeployment(request?: protos.google.cloud.networksecurity.v1alpha1.IDeleteInterceptDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a deployment. See https://google.aip.dev/135.

Parameters
Name Description
request IDeleteInterceptDeploymentRequest

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.networksecurity.v1alpha1.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. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callDeleteInterceptDeployment();

deleteInterceptDeployment(request, options, callback)

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

deleteInterceptDeployment(request, callback)

deleteInterceptDeployment(request: protos.google.cloud.networksecurity.v1alpha1.IDeleteInterceptDeploymentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteInterceptDeploymentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInterceptDeploymentGroup(request, options)

deleteInterceptDeploymentGroup(request?: protos.google.cloud.networksecurity.v1alpha1.IDeleteInterceptDeploymentGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a deployment group. See https://google.aip.dev/135.

Parameters
Name Description
request IDeleteInterceptDeploymentGroupRequest

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.networksecurity.v1alpha1.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 deployment group to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callDeleteInterceptDeploymentGroup();

deleteInterceptDeploymentGroup(request, options, callback)

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

deleteInterceptDeploymentGroup(request, callback)

deleteInterceptDeploymentGroup(request: protos.google.cloud.networksecurity.v1alpha1.IDeleteInterceptDeploymentGroupRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteInterceptDeploymentGroupRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInterceptEndpointGroup(request, options)

deleteInterceptEndpointGroup(request?: protos.google.cloud.networksecurity.v1alpha1.IDeleteInterceptEndpointGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes an endpoint group. See https://google.aip.dev/135.

Parameters
Name Description
request IDeleteInterceptEndpointGroupRequest

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.networksecurity.v1alpha1.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 endpoint group to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callDeleteInterceptEndpointGroup();

deleteInterceptEndpointGroup(request, options, callback)

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

deleteInterceptEndpointGroup(request, callback)

deleteInterceptEndpointGroup(request: protos.google.cloud.networksecurity.v1alpha1.IDeleteInterceptEndpointGroupRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteInterceptEndpointGroupRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInterceptEndpointGroupAssociation(request, options)

deleteInterceptEndpointGroupAssociation(request?: protos.google.cloud.networksecurity.v1alpha1.IDeleteInterceptEndpointGroupAssociationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes an association. See https://google.aip.dev/135.

Parameters
Name Description
request IDeleteInterceptEndpointGroupAssociationRequest

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.networksecurity.v1alpha1.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 association to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callDeleteInterceptEndpointGroupAssociation();

deleteInterceptEndpointGroupAssociation(request, options, callback)

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

deleteInterceptEndpointGroupAssociation(request, callback)

deleteInterceptEndpointGroupAssociation(request: protos.google.cloud.networksecurity.v1alpha1.IDeleteInterceptEndpointGroupAssociationRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteInterceptEndpointGroupAssociationRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.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: ''});

dnsThreatDetectorPath(project, location, dnsThreatDetector)

dnsThreatDetectorPath(project: string, location: string, dnsThreatDetector: string): string;

Return a fully-qualified dnsThreatDetector resource name string.

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

{string} Resource name string.

firewallEndpointAssociationPath(project, location, firewallEndpointAssociation)

firewallEndpointAssociationPath(project: string, location: string, firewallEndpointAssociation: string): string;

Return a fully-qualified firewallEndpointAssociation resource name string.

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

{string} Resource name string.

forwardingRulePath(project, forwardingRule)

forwardingRulePath(project: string, forwardingRule: string): string;

Return a fully-qualified forwardingRule resource name string.

Parameters
Name Description
project string
forwardingRule string
Returns
Type Description
string

{string} Resource name string.

gatewaySecurityPolicyPath(project, location, gatewaySecurityPolicy)

gatewaySecurityPolicyPath(project: string, location: string, gatewaySecurityPolicy: string): string;

Return a fully-qualified gatewaySecurityPolicy resource name string.

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

{string} Resource name string.

gatewaySecurityPolicyRulePath(project, location, gatewaySecurityPolicy, rule)

gatewaySecurityPolicyRulePath(project: string, location: string, gatewaySecurityPolicy: string, rule: string): string;

Return a fully-qualified gatewaySecurityPolicyRule resource name string.

Parameters
Name Description
project string
location string
gatewaySecurityPolicy string
rule string
Returns
Type Description
string

{string} Resource name string.

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.

getInterceptDeployment(request, options)

getInterceptDeployment(request?: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment,
        (protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest | undefined),
        {} | undefined
    ]>;

Gets a specific deployment. See https://google.aip.dev/131.

Parameters
Name Description
request IGetInterceptDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, (protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest | undefined), {} | undefined ]>

{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

  /**
   * 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 deployment to retrieve.
   *  Format:
   *  projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}
   */
  // const name = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

    // Run request
    const response = await networksecurityClient.getInterceptDeployment(request);
    console.log(response);
  }

  callGetInterceptDeployment();

getInterceptDeployment(request, options, callback)

getInterceptDeployment(request: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInterceptDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInterceptDeployment(request, callback)

getInterceptDeployment(request: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest, callback: Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInterceptDeploymentRequest
callback Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInterceptDeploymentGroup(request, options)

getInterceptDeploymentGroup(request?: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup,
        (protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest | undefined),
        {} | undefined
    ]>;

Gets a specific deployment group. See https://google.aip.dev/131.

Parameters
Name Description
request IGetInterceptDeploymentGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, (protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest | undefined), {} | undefined ]>

{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

  /**
   * 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 deployment group to retrieve.
   *  Format:
   *  projects/{project}/locations/{location}/interceptDeploymentGroups/{intercept_deployment_group}
   */
  // const name = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

    // Run request
    const response = await networksecurityClient.getInterceptDeploymentGroup(request);
    console.log(response);
  }

  callGetInterceptDeploymentGroup();

getInterceptDeploymentGroup(request, options, callback)

getInterceptDeploymentGroup(request: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInterceptDeploymentGroupRequest
options CallOptions
callback Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInterceptDeploymentGroup(request, callback)

getInterceptDeploymentGroup(request: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest, callback: Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInterceptDeploymentGroupRequest
callback Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptDeploymentGroupRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInterceptEndpointGroup(request, options)

getInterceptEndpointGroup(request?: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup,
        (protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest | undefined),
        {} | undefined
    ]>;

Gets a specific endpoint group. See https://google.aip.dev/131.

Parameters
Name Description
request IGetInterceptEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, (protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest | undefined), {} | undefined ]>

{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

  /**
   * 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 endpoint group to retrieve.
   *  Format:
   *  projects/{project}/locations/{location}/interceptEndpointGroups/{intercept_endpoint_group}
   */
  // const name = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

    // Run request
    const response = await networksecurityClient.getInterceptEndpointGroup(request);
    console.log(response);
  }

  callGetInterceptEndpointGroup();

getInterceptEndpointGroup(request, options, callback)

getInterceptEndpointGroup(request: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInterceptEndpointGroupRequest
options CallOptions
callback Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInterceptEndpointGroup(request, callback)

getInterceptEndpointGroup(request: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest, callback: Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInterceptEndpointGroupRequest
callback Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInterceptEndpointGroupAssociation(request, options)

getInterceptEndpointGroupAssociation(request?: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation,
        (protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest | undefined),
        {} | undefined
    ]>;

Gets a specific association. See https://google.aip.dev/131.

Parameters
Name Description
request IGetInterceptEndpointGroupAssociationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, (protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest | undefined), {} | undefined ]>

{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

  /**
   * 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 association to retrieve.
   *  Format:
   *  projects/{project}/locations/{location}/interceptEndpointGroupAssociations/{intercept_endpoint_group_association}
   */
  // const name = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

    // Run request
    const response = await networksecurityClient.getInterceptEndpointGroupAssociation(request);
    console.log(response);
  }

  callGetInterceptEndpointGroupAssociation();

getInterceptEndpointGroupAssociation(request, options, callback)

getInterceptEndpointGroupAssociation(request: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest, options: CallOptions, callback: Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInterceptEndpointGroupAssociationRequest
options CallOptions
callback Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInterceptEndpointGroupAssociation(request, callback)

getInterceptEndpointGroupAssociation(request: protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest, callback: Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInterceptEndpointGroupAssociationRequest
callback Callback<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IGetInterceptEndpointGroupAssociationRequest | 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

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.

interceptDeploymentGroupPath(project, location, interceptDeploymentGroup)

interceptDeploymentGroupPath(project: string, location: string, interceptDeploymentGroup: string): string;

Return a fully-qualified interceptDeploymentGroup resource name string.

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

{string} Resource name string.

interceptDeploymentPath(project, location, interceptDeployment)

interceptDeploymentPath(project: string, location: string, interceptDeployment: string): string;

Return a fully-qualified interceptDeployment resource name string.

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

{string} Resource name string.

interceptEndpointGroupAssociationPath(project, location, interceptEndpointGroupAssociation)

interceptEndpointGroupAssociationPath(project: string, location: string, interceptEndpointGroupAssociation: string): string;

Return a fully-qualified interceptEndpointGroupAssociation resource name string.

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

{string} Resource name string.

interceptEndpointGroupPath(project, location, interceptEndpointGroup)

interceptEndpointGroupPath(project: string, location: string, interceptEndpointGroup: string): string;

Return a fully-qualified interceptEndpointGroup resource name string.

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

{string} Resource name string.

listInterceptDeploymentGroups(request, options)

listInterceptDeploymentGroups(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup[],
        protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest | null,
        protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsResponse
    ]>;

Lists deployment groups in a given project and location. See https://google.aip.dev/132.

Parameters
Name Description
request IListInterceptDeploymentGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup[], protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest | null, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInterceptDeploymentGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterceptDeploymentGroups(request, options, callback)

listInterceptDeploymentGroups(request: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup>): void;
Parameters
Name Description
request IListInterceptDeploymentGroupsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup>
Returns
Type Description
void

listInterceptDeploymentGroups(request, callback)

listInterceptDeploymentGroups(request: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup>): void;
Parameters
Name Description
request IListInterceptDeploymentGroupsRequest
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup>
Returns
Type Description
void

listInterceptDeploymentGroupsAsync(request, options)

listInterceptDeploymentGroupsAsync(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup>;

Equivalent to listInterceptDeploymentGroups, but returns an iterable object.

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

Parameters
Name Description
request IListInterceptDeploymentGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup>

{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

  /**
   * 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, which owns this collection of deployment groups.
   *  Example: `projects/123456789/locations/global`.
   *  See https://google.aip.dev/132 for more details.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. Server may return fewer items than
   *  requested. If unspecified, server will pick an appropriate default. See
   *  https://google.aip.dev/158 for more details.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `ListInterceptDeploymentGroups` call. Provide this to retrieve the
   *  subsequent page. When paginating, all other parameters provided to
   *  `ListInterceptDeploymentGroups` must match the call that provided the page
   *  token. See https://google.aip.dev/158 for more details.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter expression.
   *  See https://google.aip.dev/160#filtering for more details.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Sort expression.
   *  See https://google.aip.dev/132#ordering for more details.
   */
  // const orderBy = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callListInterceptDeploymentGroups();

listInterceptDeploymentGroupsStream(request, options)

listInterceptDeploymentGroupsStream(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentGroupsRequest, options?: CallOptions): Transform;

Equivalent to listInterceptDeploymentGroups, but returns a NodeJS Stream object.

Parameters
Name Description
request IListInterceptDeploymentGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInterceptDeploymentGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterceptDeployments(request, options)

listInterceptDeployments(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment[],
        protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest | null,
        protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsResponse
    ]>;

Lists deployments in a given project and location. See https://google.aip.dev/132.

Parameters
Name Description
request IListInterceptDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment[], protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest | null, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInterceptDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterceptDeployments(request, options, callback)

listInterceptDeployments(request: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment>): void;
Parameters
Name Description
request IListInterceptDeploymentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment>
Returns
Type Description
void

listInterceptDeployments(request, callback)

listInterceptDeployments(request: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment>): void;
Parameters
Name Description
request IListInterceptDeploymentsRequest
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment>
Returns
Type Description
void

listInterceptDeploymentsAsync(request, options)

listInterceptDeploymentsAsync(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment>;

Equivalent to listInterceptDeployments, but returns an iterable object.

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

Parameters
Name Description
request IListInterceptDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment>

{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

  /**
   * 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, which owns this collection of deployments.
   *  Example: `projects/123456789/locations/us-central1-a`.
   *  See https://google.aip.dev/132 for more details.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. Server may return fewer items than
   *  requested. If unspecified, server will pick an appropriate default. See
   *  https://google.aip.dev/158 for more details.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListInterceptDeployments`
   *  call. Provide this to retrieve the subsequent page. When paginating, all
   *  other parameters provided to `ListInterceptDeployments` must match the call
   *  that provided the page token. See https://google.aip.dev/158 for more
   *  details.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter expression.
   *  See https://google.aip.dev/160#filtering for more details.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Sort expression.
   *  See https://google.aip.dev/132#ordering for more details.
   */
  // const orderBy = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callListInterceptDeployments();

listInterceptDeploymentsStream(request, options)

listInterceptDeploymentsStream(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptDeploymentsRequest, options?: CallOptions): Transform;

Equivalent to listInterceptDeployments, but returns a NodeJS Stream object.

Parameters
Name Description
request IListInterceptDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInterceptDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterceptEndpointGroupAssociations(request, options)

listInterceptEndpointGroupAssociations(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation[],
        protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest | null,
        protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsResponse
    ]>;

Lists associations in a given project and location. See https://google.aip.dev/132.

Parameters
Name Description
request IListInterceptEndpointGroupAssociationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation[], protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest | null, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInterceptEndpointGroupAssociationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterceptEndpointGroupAssociations(request, options, callback)

listInterceptEndpointGroupAssociations(request: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation>): void;
Parameters
Name Description
request IListInterceptEndpointGroupAssociationsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation>
Returns
Type Description
void

listInterceptEndpointGroupAssociations(request, callback)

listInterceptEndpointGroupAssociations(request: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation>): void;
Parameters
Name Description
request IListInterceptEndpointGroupAssociationsRequest
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation>
Returns
Type Description
void

listInterceptEndpointGroupAssociationsAsync(request, options)

listInterceptEndpointGroupAssociationsAsync(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation>;

Equivalent to listInterceptEndpointGroupAssociations, but returns an iterable object.

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

Parameters
Name Description
request IListInterceptEndpointGroupAssociationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation>

{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

  /**
   * 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, which owns this collection of associations.
   *  Example: `projects/123456789/locations/global`.
   *  See https://google.aip.dev/132 for more details.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. Server may return fewer items than
   *  requested. If unspecified, server will pick an appropriate default. See
   *  https://google.aip.dev/158 for more details.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `ListInterceptEndpointGroups` call. Provide this to retrieve the subsequent
   *  page. When paginating, all other parameters provided to
   *  `ListInterceptEndpointGroups` must match the call that provided the page
   *  token. See https://google.aip.dev/158 for more details.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter expression.
   *  See https://google.aip.dev/160#filtering for more details.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Sort expression.
   *  See https://google.aip.dev/132#ordering for more details.
   */
  // const orderBy = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callListInterceptEndpointGroupAssociations();

listInterceptEndpointGroupAssociationsStream(request, options)

listInterceptEndpointGroupAssociationsStream(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupAssociationsRequest, options?: CallOptions): Transform;

Equivalent to listInterceptEndpointGroupAssociations, but returns a NodeJS Stream object.

Parameters
Name Description
request IListInterceptEndpointGroupAssociationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInterceptEndpointGroupAssociationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterceptEndpointGroups(request, options)

listInterceptEndpointGroups(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup[],
        protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest | null,
        protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsResponse
    ]>;

Lists endpoint groups in a given project and location. See https://google.aip.dev/132.

Parameters
Name Description
request IListInterceptEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup[], protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest | null, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInterceptEndpointGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterceptEndpointGroups(request, options, callback)

listInterceptEndpointGroups(request: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup>): void;
Parameters
Name Description
request IListInterceptEndpointGroupsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup>
Returns
Type Description
void

listInterceptEndpointGroups(request, callback)

listInterceptEndpointGroups(request: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup>): void;
Parameters
Name Description
request IListInterceptEndpointGroupsRequest
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup>
Returns
Type Description
void

listInterceptEndpointGroupsAsync(request, options)

listInterceptEndpointGroupsAsync(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup>;

Equivalent to listInterceptEndpointGroups, but returns an iterable object.

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

Parameters
Name Description
request IListInterceptEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup>

{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

  /**
   * 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, which owns this collection of endpoint groups.
   *  Example: `projects/123456789/locations/global`.
   *  See https://google.aip.dev/132 for more details.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size. Server may return fewer items than
   *  requested. If unspecified, server will pick an appropriate default. See
   *  https://google.aip.dev/158 for more details.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `ListInterceptEndpointGroups` call. Provide this to retrieve the subsequent
   *  page. When paginating, all other parameters provided to
   *  `ListInterceptEndpointGroups` must match the call that provided the page
   *  token.
   *  See https://google.aip.dev/158 for more details.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter expression.
   *  See https://google.aip.dev/160#filtering for more details.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Sort expression.
   *  See https://google.aip.dev/132#ordering for more details.
   */
  // const orderBy = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

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

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

  callListInterceptEndpointGroups();

listInterceptEndpointGroupsStream(request, options)

listInterceptEndpointGroupsStream(request?: protos.google.cloud.networksecurity.v1alpha1.IListInterceptEndpointGroupsRequest, options?: CallOptions): Transform;

Equivalent to listInterceptEndpointGroups, but returns a NodeJS Stream object.

Parameters
Name Description
request IListInterceptEndpointGroupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInterceptEndpointGroupsAsync() 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.

matchAuthorizationPolicyFromAuthorizationPolicyName(authorizationPolicyName)

matchAuthorizationPolicyFromAuthorizationPolicyName(authorizationPolicyName: string): string | number;

Parse the authorization_policy from AuthorizationPolicy resource.

Parameter
Name Description
authorizationPolicyName string

A fully-qualified path representing AuthorizationPolicy resource.

Returns
Type Description
string | number

{string} A string representing the authorization_policy.

matchAuthzPolicyFromAuthzPolicyName(authzPolicyName)

matchAuthzPolicyFromAuthzPolicyName(authzPolicyName: string): string | number;

Parse the authz_policy from AuthzPolicy resource.

Parameter
Name Description
authzPolicyName string

A fully-qualified path representing AuthzPolicy resource.

Returns
Type Description
string | number

{string} A string representing the authz_policy.

matchBackendAuthenticationConfigFromBackendAuthenticationConfigName(backendAuthenticationConfigName)

matchBackendAuthenticationConfigFromBackendAuthenticationConfigName(backendAuthenticationConfigName: string): string | number;

Parse the backend_authentication_config from BackendAuthenticationConfig resource.

Parameter
Name Description
backendAuthenticationConfigName string

A fully-qualified path representing BackendAuthenticationConfig resource.

Returns
Type Description
string | number

{string} A string representing the backend_authentication_config.

matchClientTlsPolicyFromClientTlsPolicyName(clientTlsPolicyName)

matchClientTlsPolicyFromClientTlsPolicyName(clientTlsPolicyName: string): string | number;

Parse the client_tls_policy from ClientTlsPolicy resource.

Parameter
Name Description
clientTlsPolicyName string

A fully-qualified path representing ClientTlsPolicy resource.

Returns
Type Description
string | number

{string} A string representing the client_tls_policy.

matchDnsThreatDetectorFromDnsThreatDetectorName(dnsThreatDetectorName)

matchDnsThreatDetectorFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number;

Parse the dns_threat_detector from DnsThreatDetector resource.

Parameter
Name Description
dnsThreatDetectorName string

A fully-qualified path representing DnsThreatDetector resource.

Returns
Type Description
string | number

{string} A string representing the dns_threat_detector.

matchFirewallEndpointAssociationFromFirewallEndpointAssociationName(firewallEndpointAssociationName)

matchFirewallEndpointAssociationFromFirewallEndpointAssociationName(firewallEndpointAssociationName: string): string | number;

Parse the firewall_endpoint_association from FirewallEndpointAssociation resource.

Parameter
Name Description
firewallEndpointAssociationName string

A fully-qualified path representing FirewallEndpointAssociation resource.

Returns
Type Description
string | number

{string} A string representing the firewall_endpoint_association.

matchFirewallEndpointFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName)

matchFirewallEndpointFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName: string): string | number;

Parse the firewall_endpoint from OrganizationLocationFirewallEndpoints resource.

Parameter
Name Description
organizationLocationFirewallEndpointsName string

A fully-qualified path representing organization_location_firewallEndpoints resource.

Returns
Type Description
string | number

{string} A string representing the firewall_endpoint.

matchFirewallEndpointFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName)

matchFirewallEndpointFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName: string): string | number;

Parse the firewall_endpoint from ProjectLocationFirewallEndpoints resource.

Parameter
Name Description
projectLocationFirewallEndpointsName string

A fully-qualified path representing project_location_firewallEndpoints resource.

Returns
Type Description
string | number

{string} A string representing the firewall_endpoint.

matchForwardingRuleFromForwardingRuleName(forwardingRuleName)

matchForwardingRuleFromForwardingRuleName(forwardingRuleName: string): string | number;

Parse the forwarding_rule from ForwardingRule resource.

Parameter
Name Description
forwardingRuleName string

A fully-qualified path representing ForwardingRule resource.

Returns
Type Description
string | number

{string} A string representing the forwarding_rule.

matchGatewaySecurityPolicyFromGatewaySecurityPolicyName(gatewaySecurityPolicyName)

matchGatewaySecurityPolicyFromGatewaySecurityPolicyName(gatewaySecurityPolicyName: string): string | number;

Parse the gateway_security_policy from GatewaySecurityPolicy resource.

Parameter
Name Description
gatewaySecurityPolicyName string

A fully-qualified path representing GatewaySecurityPolicy resource.

Returns
Type Description
string | number

{string} A string representing the gateway_security_policy.

matchGatewaySecurityPolicyFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName)

matchGatewaySecurityPolicyFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName: string): string | number;

Parse the gateway_security_policy from GatewaySecurityPolicyRule resource.

Parameter
Name Description
gatewaySecurityPolicyRuleName string

A fully-qualified path representing GatewaySecurityPolicyRule resource.

Returns
Type Description
string | number

{string} A string representing the gateway_security_policy.

matchInterceptDeploymentFromInterceptDeploymentName(interceptDeploymentName)

matchInterceptDeploymentFromInterceptDeploymentName(interceptDeploymentName: string): string | number;

Parse the intercept_deployment from InterceptDeployment resource.

Parameter
Name Description
interceptDeploymentName string

A fully-qualified path representing InterceptDeployment resource.

Returns
Type Description
string | number

{string} A string representing the intercept_deployment.

matchInterceptDeploymentGroupFromInterceptDeploymentGroupName(interceptDeploymentGroupName)

matchInterceptDeploymentGroupFromInterceptDeploymentGroupName(interceptDeploymentGroupName: string): string | number;

Parse the intercept_deployment_group from InterceptDeploymentGroup resource.

Parameter
Name Description
interceptDeploymentGroupName string

A fully-qualified path representing InterceptDeploymentGroup resource.

Returns
Type Description
string | number

{string} A string representing the intercept_deployment_group.

matchInterceptEndpointGroupAssociationFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName)

matchInterceptEndpointGroupAssociationFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName: string): string | number;

Parse the intercept_endpoint_group_association from InterceptEndpointGroupAssociation resource.

Parameter
Name Description
interceptEndpointGroupAssociationName string

A fully-qualified path representing InterceptEndpointGroupAssociation resource.

Returns
Type Description
string | number

{string} A string representing the intercept_endpoint_group_association.

matchInterceptEndpointGroupFromInterceptEndpointGroupName(interceptEndpointGroupName)

matchInterceptEndpointGroupFromInterceptEndpointGroupName(interceptEndpointGroupName: string): string | number;

Parse the intercept_endpoint_group from InterceptEndpointGroup resource.

Parameter
Name Description
interceptEndpointGroupName string

A fully-qualified path representing InterceptEndpointGroup resource.

Returns
Type Description
string | number

{string} A string representing the intercept_endpoint_group.

matchLocationFromAuthorizationPolicyName(authorizationPolicyName)

matchLocationFromAuthorizationPolicyName(authorizationPolicyName: string): string | number;

Parse the location from AuthorizationPolicy resource.

Parameter
Name Description
authorizationPolicyName string

A fully-qualified path representing AuthorizationPolicy resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromAuthzPolicyName(authzPolicyName)

matchLocationFromAuthzPolicyName(authzPolicyName: string): string | number;

Parse the location from AuthzPolicy resource.

Parameter
Name Description
authzPolicyName string

A fully-qualified path representing AuthzPolicy resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromBackendAuthenticationConfigName(backendAuthenticationConfigName)

matchLocationFromBackendAuthenticationConfigName(backendAuthenticationConfigName: string): string | number;

Parse the location from BackendAuthenticationConfig resource.

Parameter
Name Description
backendAuthenticationConfigName string

A fully-qualified path representing BackendAuthenticationConfig resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromClientTlsPolicyName(clientTlsPolicyName)

matchLocationFromClientTlsPolicyName(clientTlsPolicyName: string): string | number;

Parse the location from ClientTlsPolicy resource.

Parameter
Name Description
clientTlsPolicyName string

A fully-qualified path representing ClientTlsPolicy resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDnsThreatDetectorName(dnsThreatDetectorName)

matchLocationFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number;

Parse the location from DnsThreatDetector resource.

Parameter
Name Description
dnsThreatDetectorName string

A fully-qualified path representing DnsThreatDetector resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromFirewallEndpointAssociationName(firewallEndpointAssociationName)

matchLocationFromFirewallEndpointAssociationName(firewallEndpointAssociationName: string): string | number;

Parse the location from FirewallEndpointAssociation resource.

Parameter
Name Description
firewallEndpointAssociationName string

A fully-qualified path representing FirewallEndpointAssociation resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromGatewaySecurityPolicyName(gatewaySecurityPolicyName)

matchLocationFromGatewaySecurityPolicyName(gatewaySecurityPolicyName: string): string | number;

Parse the location from GatewaySecurityPolicy resource.

Parameter
Name Description
gatewaySecurityPolicyName string

A fully-qualified path representing GatewaySecurityPolicy resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName)

matchLocationFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName: string): string | number;

Parse the location from GatewaySecurityPolicyRule resource.

Parameter
Name Description
gatewaySecurityPolicyRuleName string

A fully-qualified path representing GatewaySecurityPolicyRule resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromInterceptDeploymentGroupName(interceptDeploymentGroupName)

matchLocationFromInterceptDeploymentGroupName(interceptDeploymentGroupName: string): string | number;

Parse the location from InterceptDeploymentGroup resource.

Parameter
Name Description
interceptDeploymentGroupName string

A fully-qualified path representing InterceptDeploymentGroup resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromInterceptDeploymentName(interceptDeploymentName)

matchLocationFromInterceptDeploymentName(interceptDeploymentName: string): string | number;

Parse the location from InterceptDeployment resource.

Parameter
Name Description
interceptDeploymentName string

A fully-qualified path representing InterceptDeployment resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName)

matchLocationFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName: string): string | number;

Parse the location from InterceptEndpointGroupAssociation resource.

Parameter
Name Description
interceptEndpointGroupAssociationName string

A fully-qualified path representing InterceptEndpointGroupAssociation resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromInterceptEndpointGroupName(interceptEndpointGroupName)

matchLocationFromInterceptEndpointGroupName(interceptEndpointGroupName: string): string | number;

Parse the location from InterceptEndpointGroup resource.

Parameter
Name Description
interceptEndpointGroupName string

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

matchLocationFromMirroringDeploymentGroupName(mirroringDeploymentGroupName)

matchLocationFromMirroringDeploymentGroupName(mirroringDeploymentGroupName: string): string | number;

Parse the location from MirroringDeploymentGroup resource.

Parameter
Name Description
mirroringDeploymentGroupName string

A fully-qualified path representing MirroringDeploymentGroup resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromMirroringDeploymentName(mirroringDeploymentName)

matchLocationFromMirroringDeploymentName(mirroringDeploymentName: string): string | number;

Parse the location from MirroringDeployment resource.

Parameter
Name Description
mirroringDeploymentName string

A fully-qualified path representing MirroringDeployment resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName)

matchLocationFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName: string): string | number;

Parse the location from MirroringEndpointGroupAssociation resource.

Parameter
Name Description
mirroringEndpointGroupAssociationName string

A fully-qualified path representing MirroringEndpointGroupAssociation resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromMirroringEndpointGroupName(mirroringEndpointGroupName)

matchLocationFromMirroringEndpointGroupName(mirroringEndpointGroupName: string): string | number;

Parse the location from MirroringEndpointGroup resource.

Parameter
Name Description
mirroringEndpointGroupName string

A fully-qualified path representing MirroringEndpointGroup resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName)

matchLocationFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName: string): string | number;

Parse the location from OrganizationLocationFirewallEndpoints resource.

Parameter
Name Description
organizationLocationFirewallEndpointsName string

A fully-qualified path representing organization_location_firewallEndpoints resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName)

matchLocationFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName: string): string | number;

Parse the location from OrganizationLocationSecurityProfileGroup resource.

Parameter
Name Description
organizationLocationSecurityProfileGroupName string

A fully-qualified path representing organization_location_security_profile_group resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName)

matchLocationFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName: string): string | number;

Parse the location from OrganizationLocationSecurityProfile resource.

Parameter
Name Description
organizationLocationSecurityProfileName string

A fully-qualified path representing organization_location_security_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromPartnerSSEGatewayName(partnerSSEGatewayName)

matchLocationFromPartnerSSEGatewayName(partnerSSEGatewayName: string): string | number;

Parse the location from PartnerSSEGateway resource.

Parameter
Name Description
partnerSSEGatewayName string

A fully-qualified path representing PartnerSSEGateway resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromPartnerSSERealmName(partnerSSERealmName)

matchLocationFromPartnerSSERealmName(partnerSSERealmName: string): string | number;

Parse the location from PartnerSSERealm resource.

Parameter
Name Description
partnerSSERealmName string

A fully-qualified path representing PartnerSSERealm resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName)

matchLocationFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName: string): string | number;

Parse the location from ProjectLocationFirewallEndpoints resource.

Parameter
Name Description
projectLocationFirewallEndpointsName string

A fully-qualified path representing project_location_firewallEndpoints resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName)

matchLocationFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName: string): string | number;

Parse the location from ProjectLocationSecurityProfileGroup resource.

Parameter
Name Description
projectLocationSecurityProfileGroupName string

A fully-qualified path representing project_location_security_profile_group resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName)

matchLocationFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName: string): string | number;

Parse the location from ProjectLocationSecurityProfile resource.

Parameter
Name Description
projectLocationSecurityProfileName string

A fully-qualified path representing project_location_security_profile resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromSACAttachmentName(sACAttachmentName)

matchLocationFromSACAttachmentName(sACAttachmentName: string): string | number;

Parse the location from SACAttachment resource.

Parameter
Name Description
sACAttachmentName string

A fully-qualified path representing SACAttachment resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromSACRealmName(sACRealmName)

matchLocationFromSACRealmName(sACRealmName: string): string | number;

Parse the location from SACRealm resource.

Parameter
Name Description
sACRealmName string

A fully-qualified path representing SACRealm resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromServerTlsPolicyName(serverTlsPolicyName)

matchLocationFromServerTlsPolicyName(serverTlsPolicyName: string): string | number;

Parse the location from ServerTlsPolicy resource.

Parameter
Name Description
serverTlsPolicyName string

A fully-qualified path representing ServerTlsPolicy resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromSSEGatewayReferenceName(sSEGatewayReferenceName)

matchLocationFromSSEGatewayReferenceName(sSEGatewayReferenceName: string): string | number;

Parse the location from SSEGatewayReference resource.

Parameter
Name Description
sSEGatewayReferenceName string

A fully-qualified path representing SSEGatewayReference resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromTlsInspectionPolicyName(tlsInspectionPolicyName)

matchLocationFromTlsInspectionPolicyName(tlsInspectionPolicyName: string): string | number;

Parse the location from TlsInspectionPolicy resource.

Parameter
Name Description
tlsInspectionPolicyName string

A fully-qualified path representing TlsInspectionPolicy resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromUrlListName(urlListName)

matchLocationFromUrlListName(urlListName: string): string | number;

Parse the location from UrlList resource.

Parameter
Name Description
urlListName string

A fully-qualified path representing UrlList resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchMirroringDeploymentFromMirroringDeploymentName(mirroringDeploymentName)

matchMirroringDeploymentFromMirroringDeploymentName(mirroringDeploymentName: string): string | number;

Parse the mirroring_deployment from MirroringDeployment resource.

Parameter
Name Description
mirroringDeploymentName string

A fully-qualified path representing MirroringDeployment resource.

Returns
Type Description
string | number

{string} A string representing the mirroring_deployment.

matchMirroringDeploymentGroupFromMirroringDeploymentGroupName(mirroringDeploymentGroupName)

matchMirroringDeploymentGroupFromMirroringDeploymentGroupName(mirroringDeploymentGroupName: string): string | number;

Parse the mirroring_deployment_group from MirroringDeploymentGroup resource.

Parameter
Name Description
mirroringDeploymentGroupName string

A fully-qualified path representing MirroringDeploymentGroup resource.

Returns
Type Description
string | number

{string} A string representing the mirroring_deployment_group.

matchMirroringEndpointGroupAssociationFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName)

matchMirroringEndpointGroupAssociationFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName: string): string | number;

Parse the mirroring_endpoint_group_association from MirroringEndpointGroupAssociation resource.

Parameter
Name Description
mirroringEndpointGroupAssociationName string

A fully-qualified path representing MirroringEndpointGroupAssociation resource.

Returns
Type Description
string | number

{string} A string representing the mirroring_endpoint_group_association.

matchMirroringEndpointGroupFromMirroringEndpointGroupName(mirroringEndpointGroupName)

matchMirroringEndpointGroupFromMirroringEndpointGroupName(mirroringEndpointGroupName: string): string | number;

Parse the mirroring_endpoint_group from MirroringEndpointGroup resource.

Parameter
Name Description
mirroringEndpointGroupName string

A fully-qualified path representing MirroringEndpointGroup resource.

Returns
Type Description
string | number

{string} A string representing the mirroring_endpoint_group.

matchNetworkFromNetworkName(networkName)

matchNetworkFromNetworkName(networkName: string): string | number;

Parse the network from Network resource.

Parameter
Name Description
networkName string

A fully-qualified path representing Network resource.

Returns
Type Description
string | number

{string} A string representing the network.

matchOrganizationFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName)

matchOrganizationFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName: string): string | number;

Parse the organization from OrganizationLocationFirewallEndpoints resource.

Parameter
Name Description
organizationLocationFirewallEndpointsName string

A fully-qualified path representing organization_location_firewallEndpoints resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName)

matchOrganizationFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName: string): string | number;

Parse the organization from OrganizationLocationSecurityProfileGroup resource.

Parameter
Name Description
organizationLocationSecurityProfileGroupName string

A fully-qualified path representing organization_location_security_profile_group resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName)

matchOrganizationFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName: string): string | number;

Parse the organization from OrganizationLocationSecurityProfile resource.

Parameter
Name Description
organizationLocationSecurityProfileName string

A fully-qualified path representing organization_location_security_profile resource.

Returns
Type Description
string | number

{string} A string representing the organization.

matchPartnerSseGatewayFromPartnerSSEGatewayName(partnerSSEGatewayName)

matchPartnerSseGatewayFromPartnerSSEGatewayName(partnerSSEGatewayName: string): string | number;

Parse the partner_sse_gateway from PartnerSSEGateway resource.

Parameter
Name Description
partnerSSEGatewayName string

A fully-qualified path representing PartnerSSEGateway resource.

Returns
Type Description
string | number

{string} A string representing the partner_sse_gateway.

matchPartnerSseRealmFromPartnerSSERealmName(partnerSSERealmName)

matchPartnerSseRealmFromPartnerSSERealmName(partnerSSERealmName: string): string | number;

Parse the partner_sse_realm from PartnerSSERealm resource.

Parameter
Name Description
partnerSSERealmName string

A fully-qualified path representing PartnerSSERealm resource.

Returns
Type Description
string | number

{string} A string representing the partner_sse_realm.

matchProjectFromAuthorizationPolicyName(authorizationPolicyName)

matchProjectFromAuthorizationPolicyName(authorizationPolicyName: string): string | number;

Parse the project from AuthorizationPolicy resource.

Parameter
Name Description
authorizationPolicyName string

A fully-qualified path representing AuthorizationPolicy resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromAuthzPolicyName(authzPolicyName)

matchProjectFromAuthzPolicyName(authzPolicyName: string): string | number;

Parse the project from AuthzPolicy resource.

Parameter
Name Description
authzPolicyName string

A fully-qualified path representing AuthzPolicy resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromBackendAuthenticationConfigName(backendAuthenticationConfigName)

matchProjectFromBackendAuthenticationConfigName(backendAuthenticationConfigName: string): string | number;

Parse the project from BackendAuthenticationConfig resource.

Parameter
Name Description
backendAuthenticationConfigName string

A fully-qualified path representing BackendAuthenticationConfig resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromClientTlsPolicyName(clientTlsPolicyName)

matchProjectFromClientTlsPolicyName(clientTlsPolicyName: string): string | number;

Parse the project from ClientTlsPolicy resource.

Parameter
Name Description
clientTlsPolicyName string

A fully-qualified path representing ClientTlsPolicy resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDnsThreatDetectorName(dnsThreatDetectorName)

matchProjectFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number;

Parse the project from DnsThreatDetector resource.

Parameter
Name Description
dnsThreatDetectorName string

A fully-qualified path representing DnsThreatDetector resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromFirewallEndpointAssociationName(firewallEndpointAssociationName)

matchProjectFromFirewallEndpointAssociationName(firewallEndpointAssociationName: string): string | number;

Parse the project from FirewallEndpointAssociation resource.

Parameter
Name Description
firewallEndpointAssociationName string

A fully-qualified path representing FirewallEndpointAssociation resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromForwardingRuleName(forwardingRuleName)

matchProjectFromForwardingRuleName(forwardingRuleName: string): string | number;

Parse the project from ForwardingRule resource.

Parameter
Name Description
forwardingRuleName string

A fully-qualified path representing ForwardingRule resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromGatewaySecurityPolicyName(gatewaySecurityPolicyName)

matchProjectFromGatewaySecurityPolicyName(gatewaySecurityPolicyName: string): string | number;

Parse the project from GatewaySecurityPolicy resource.

Parameter
Name Description
gatewaySecurityPolicyName string

A fully-qualified path representing GatewaySecurityPolicy resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName)

matchProjectFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName: string): string | number;

Parse the project from GatewaySecurityPolicyRule resource.

Parameter
Name Description
gatewaySecurityPolicyRuleName string

A fully-qualified path representing GatewaySecurityPolicyRule resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromInterceptDeploymentGroupName(interceptDeploymentGroupName)

matchProjectFromInterceptDeploymentGroupName(interceptDeploymentGroupName: string): string | number;

Parse the project from InterceptDeploymentGroup resource.

Parameter
Name Description
interceptDeploymentGroupName string

A fully-qualified path representing InterceptDeploymentGroup resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromInterceptDeploymentName(interceptDeploymentName)

matchProjectFromInterceptDeploymentName(interceptDeploymentName: string): string | number;

Parse the project from InterceptDeployment resource.

Parameter
Name Description
interceptDeploymentName string

A fully-qualified path representing InterceptDeployment resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName)

matchProjectFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName: string): string | number;

Parse the project from InterceptEndpointGroupAssociation resource.

Parameter
Name Description
interceptEndpointGroupAssociationName string

A fully-qualified path representing InterceptEndpointGroupAssociation resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromInterceptEndpointGroupName(interceptEndpointGroupName)

matchProjectFromInterceptEndpointGroupName(interceptEndpointGroupName: string): string | number;

Parse the project from InterceptEndpointGroup resource.

Parameter
Name Description
interceptEndpointGroupName string

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

matchProjectFromMirroringDeploymentGroupName(mirroringDeploymentGroupName)

matchProjectFromMirroringDeploymentGroupName(mirroringDeploymentGroupName: string): string | number;

Parse the project from MirroringDeploymentGroup resource.

Parameter
Name Description
mirroringDeploymentGroupName string

A fully-qualified path representing MirroringDeploymentGroup resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromMirroringDeploymentName(mirroringDeploymentName)

matchProjectFromMirroringDeploymentName(mirroringDeploymentName: string): string | number;

Parse the project from MirroringDeployment resource.

Parameter
Name Description
mirroringDeploymentName string

A fully-qualified path representing MirroringDeployment resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName)

matchProjectFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName: string): string | number;

Parse the project from MirroringEndpointGroupAssociation resource.

Parameter
Name Description
mirroringEndpointGroupAssociationName string

A fully-qualified path representing MirroringEndpointGroupAssociation resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromMirroringEndpointGroupName(mirroringEndpointGroupName)

matchProjectFromMirroringEndpointGroupName(mirroringEndpointGroupName: string): string | number;

Parse the project from MirroringEndpointGroup resource.

Parameter
Name Description
mirroringEndpointGroupName string

A fully-qualified path representing MirroringEndpointGroup resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromNetworkName(networkName)

matchProjectFromNetworkName(networkName: string): string | number;

Parse the project from Network resource.

Parameter
Name Description
networkName string

A fully-qualified path representing Network resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromPartnerSSEGatewayName(partnerSSEGatewayName)

matchProjectFromPartnerSSEGatewayName(partnerSSEGatewayName: string): string | number;

Parse the project from PartnerSSEGateway resource.

Parameter
Name Description
partnerSSEGatewayName string

A fully-qualified path representing PartnerSSEGateway resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromPartnerSSERealmName(partnerSSERealmName)

matchProjectFromPartnerSSERealmName(partnerSSERealmName: string): string | number;

Parse the project from PartnerSSERealm resource.

Parameter
Name Description
partnerSSERealmName string

A fully-qualified path representing PartnerSSERealm resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName)

matchProjectFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName: string): string | number;

Parse the project from ProjectLocationFirewallEndpoints resource.

Parameter
Name Description
projectLocationFirewallEndpointsName string

A fully-qualified path representing project_location_firewallEndpoints resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName)

matchProjectFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName: string): string | number;

Parse the project from ProjectLocationSecurityProfileGroup resource.

Parameter
Name Description
projectLocationSecurityProfileGroupName string

A fully-qualified path representing project_location_security_profile_group resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName)

matchProjectFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName: string): string | number;

Parse the project from ProjectLocationSecurityProfile resource.

Parameter
Name Description
projectLocationSecurityProfileName string

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

matchProjectFromSACAttachmentName(sACAttachmentName)

matchProjectFromSACAttachmentName(sACAttachmentName: string): string | number;

Parse the project from SACAttachment resource.

Parameter
Name Description
sACAttachmentName string

A fully-qualified path representing SACAttachment resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromSACRealmName(sACRealmName)

matchProjectFromSACRealmName(sACRealmName: string): string | number;

Parse the project from SACRealm resource.

Parameter
Name Description
sACRealmName string

A fully-qualified path representing SACRealm resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromServerTlsPolicyName(serverTlsPolicyName)

matchProjectFromServerTlsPolicyName(serverTlsPolicyName: string): string | number;

Parse the project from ServerTlsPolicy resource.

Parameter
Name Description
serverTlsPolicyName string

A fully-qualified path representing ServerTlsPolicy resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromSSEGatewayReferenceName(sSEGatewayReferenceName)

matchProjectFromSSEGatewayReferenceName(sSEGatewayReferenceName: string): string | number;

Parse the project from SSEGatewayReference resource.

Parameter
Name Description
sSEGatewayReferenceName string

A fully-qualified path representing SSEGatewayReference resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromTlsInspectionPolicyName(tlsInspectionPolicyName)

matchProjectFromTlsInspectionPolicyName(tlsInspectionPolicyName: string): string | number;

Parse the project from TlsInspectionPolicy resource.

Parameter
Name Description
tlsInspectionPolicyName string

A fully-qualified path representing TlsInspectionPolicy resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromUrlListName(urlListName)

matchProjectFromUrlListName(urlListName: string): string | number;

Parse the project from UrlList resource.

Parameter
Name Description
urlListName string

A fully-qualified path representing UrlList resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchRuleFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName)

matchRuleFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName: string): string | number;

Parse the rule from GatewaySecurityPolicyRule resource.

Parameter
Name Description
gatewaySecurityPolicyRuleName string

A fully-qualified path representing GatewaySecurityPolicyRule resource.

Returns
Type Description
string | number

{string} A string representing the rule.

matchSacAttachmentFromSACAttachmentName(sACAttachmentName)

matchSacAttachmentFromSACAttachmentName(sACAttachmentName: string): string | number;

Parse the sac_attachment from SACAttachment resource.

Parameter
Name Description
sACAttachmentName string

A fully-qualified path representing SACAttachment resource.

Returns
Type Description
string | number

{string} A string representing the sac_attachment.

matchSacRealmFromSACRealmName(sACRealmName)

matchSacRealmFromSACRealmName(sACRealmName: string): string | number;

Parse the sac_realm from SACRealm resource.

Parameter
Name Description
sACRealmName string

A fully-qualified path representing SACRealm resource.

Returns
Type Description
string | number

{string} A string representing the sac_realm.

matchSecurityProfileFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName)

matchSecurityProfileFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName: string): string | number;

Parse the security_profile from OrganizationLocationSecurityProfile resource.

Parameter
Name Description
organizationLocationSecurityProfileName string

A fully-qualified path representing organization_location_security_profile resource.

Returns
Type Description
string | number

{string} A string representing the security_profile.

matchSecurityProfileFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName)

matchSecurityProfileFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName: string): string | number;

Parse the security_profile from ProjectLocationSecurityProfile resource.

Parameter
Name Description
projectLocationSecurityProfileName string

A fully-qualified path representing project_location_security_profile resource.

Returns
Type Description
string | number

{string} A string representing the security_profile.

matchSecurityProfileGroupFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName)

matchSecurityProfileGroupFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName: string): string | number;

Parse the security_profile_group from OrganizationLocationSecurityProfileGroup resource.

Parameter
Name Description
organizationLocationSecurityProfileGroupName string

A fully-qualified path representing organization_location_security_profile_group resource.

Returns
Type Description
string | number

{string} A string representing the security_profile_group.

matchSecurityProfileGroupFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName)

matchSecurityProfileGroupFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName: string): string | number;

Parse the security_profile_group from ProjectLocationSecurityProfileGroup resource.

Parameter
Name Description
projectLocationSecurityProfileGroupName string

A fully-qualified path representing project_location_security_profile_group resource.

Returns
Type Description
string | number

{string} A string representing the security_profile_group.

matchServerTlsPolicyFromServerTlsPolicyName(serverTlsPolicyName)

matchServerTlsPolicyFromServerTlsPolicyName(serverTlsPolicyName: string): string | number;

Parse the server_tls_policy from ServerTlsPolicy resource.

Parameter
Name Description
serverTlsPolicyName string

A fully-qualified path representing ServerTlsPolicy resource.

Returns
Type Description
string | number

{string} A string representing the server_tls_policy.

matchSseGatewayReferenceFromSSEGatewayReferenceName(sSEGatewayReferenceName)

matchSseGatewayReferenceFromSSEGatewayReferenceName(sSEGatewayReferenceName: string): string | number;

Parse the sse_gateway_reference from SSEGatewayReference resource.

Parameter
Name Description
sSEGatewayReferenceName string

A fully-qualified path representing SSEGatewayReference resource.

Returns
Type Description
string | number

{string} A string representing the sse_gateway_reference.

matchTlsInspectionPolicyFromTlsInspectionPolicyName(tlsInspectionPolicyName)

matchTlsInspectionPolicyFromTlsInspectionPolicyName(tlsInspectionPolicyName: string): string | number;

Parse the tls_inspection_policy from TlsInspectionPolicy resource.

Parameter
Name Description
tlsInspectionPolicyName string

A fully-qualified path representing TlsInspectionPolicy resource.

Returns
Type Description
string | number

{string} A string representing the tls_inspection_policy.

matchUrlListFromUrlListName(urlListName)

matchUrlListFromUrlListName(urlListName: string): string | number;

Parse the url_list from UrlList resource.

Parameter
Name Description
urlListName string

A fully-qualified path representing UrlList resource.

Returns
Type Description
string | number

{string} A string representing the url_list.

mirroringDeploymentGroupPath(project, location, mirroringDeploymentGroup)

mirroringDeploymentGroupPath(project: string, location: string, mirroringDeploymentGroup: string): string;

Return a fully-qualified mirroringDeploymentGroup resource name string.

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

{string} Resource name string.

mirroringDeploymentPath(project, location, mirroringDeployment)

mirroringDeploymentPath(project: string, location: string, mirroringDeployment: string): string;

Return a fully-qualified mirroringDeployment resource name string.

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

{string} Resource name string.

mirroringEndpointGroupAssociationPath(project, location, mirroringEndpointGroupAssociation)

mirroringEndpointGroupAssociationPath(project: string, location: string, mirroringEndpointGroupAssociation: string): string;

Return a fully-qualified mirroringEndpointGroupAssociation resource name string.

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

{string} Resource name string.

mirroringEndpointGroupPath(project, location, mirroringEndpointGroup)

mirroringEndpointGroupPath(project: string, location: string, mirroringEndpointGroup: string): string;

Return a fully-qualified mirroringEndpointGroup resource name string.

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

{string} Resource name string.

networkPath(project, network)

networkPath(project: string, network: string): string;

Return a fully-qualified network resource name string.

Parameters
Name Description
project string
network string
Returns
Type Description
string

{string} Resource name string.

organizationLocationFirewallEndpointsPath(organization, location, firewallEndpoint)

organizationLocationFirewallEndpointsPath(organization: string, location: string, firewallEndpoint: string): string;

Return a fully-qualified organizationLocationFirewallEndpoints resource name string.

Parameters
Name Description
organization string
location string
firewallEndpoint string
Returns
Type Description
string

{string} Resource name string.

organizationLocationSecurityProfileGroupPath(organization, location, securityProfileGroup)

organizationLocationSecurityProfileGroupPath(organization: string, location: string, securityProfileGroup: string): string;

Return a fully-qualified organizationLocationSecurityProfileGroup resource name string.

Parameters
Name Description
organization string
location string
securityProfileGroup string
Returns
Type Description
string

{string} Resource name string.

organizationLocationSecurityProfilePath(organization, location, securityProfile)

organizationLocationSecurityProfilePath(organization: string, location: string, securityProfile: string): string;

Return a fully-qualified organizationLocationSecurityProfile resource name string.

Parameters
Name Description
organization string
location string
securityProfile string
Returns
Type Description
string

{string} Resource name string.

partnerSSEGatewayPath(project, location, partnerSseGateway)

partnerSSEGatewayPath(project: string, location: string, partnerSseGateway: string): string;

Return a fully-qualified partnerSSEGateway resource name string.

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

{string} Resource name string.

partnerSSERealmPath(project, location, partnerSseRealm)

partnerSSERealmPath(project: string, location: string, partnerSseRealm: string): string;

Return a fully-qualified partnerSSERealm resource name string.

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

{string} Resource name string.

projectLocationFirewallEndpointsPath(project, location, firewallEndpoint)

projectLocationFirewallEndpointsPath(project: string, location: string, firewallEndpoint: string): string;

Return a fully-qualified projectLocationFirewallEndpoints resource name string.

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

{string} Resource name string.

projectLocationSecurityProfileGroupPath(project, location, securityProfileGroup)

projectLocationSecurityProfileGroupPath(project: string, location: string, securityProfileGroup: string): string;

Return a fully-qualified projectLocationSecurityProfileGroup resource name string.

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

{string} Resource name string.

projectLocationSecurityProfilePath(project, location, securityProfile)

projectLocationSecurityProfilePath(project: string, location: string, securityProfile: string): string;

Return a fully-qualified projectLocationSecurityProfile resource name string.

Parameters
Name Description
project string
location string
securityProfile 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.

sACAttachmentPath(project, location, sacAttachment)

sACAttachmentPath(project: string, location: string, sacAttachment: string): string;

Return a fully-qualified sACAttachment resource name string.

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

{string} Resource name string.

sACRealmPath(project, location, sacRealm)

sACRealmPath(project: string, location: string, sacRealm: string): string;

Return a fully-qualified sACRealm resource name string.

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

{string} Resource name string.

serverTlsPolicyPath(project, location, serverTlsPolicy)

serverTlsPolicyPath(project: string, location: string, serverTlsPolicy: string): string;

Return a fully-qualified serverTlsPolicy resource name string.

Parameters
Name Description
project string
location string
serverTlsPolicy 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.

sSEGatewayReferencePath(project, location, sseGatewayReference)

sSEGatewayReferencePath(project: string, location: string, sseGatewayReference: string): string;

Return a fully-qualified sSEGatewayReference resource name string.

Parameters
Name Description
project string
location string
sseGatewayReference 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.

tlsInspectionPolicyPath(project, location, tlsInspectionPolicy)

tlsInspectionPolicyPath(project: string, location: string, tlsInspectionPolicy: string): string;

Return a fully-qualified tlsInspectionPolicy resource name string.

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

{string} Resource name string.

updateInterceptDeployment(request, options)

updateInterceptDeployment(request?: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptDeploymentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a deployment. See https://google.aip.dev/134.

Parameters
Name Description
request IUpdateInterceptDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.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. The list of fields to update.
   *  Fields are specified relative to the deployment
   *  (e.g. `description`; *not* `intercept_deployment.description`).
   *  See https://google.aip.dev/161 for more details.
   */
  // const updateMask = {}
  /**
   *  Required. The deployment to update.
   */
  // const interceptDeployment = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callUpdateInterceptDeployment() {
    // Construct request
    const request = {
      interceptDeployment,
    };

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

  callUpdateInterceptDeployment();

updateInterceptDeployment(request, options, callback)

updateInterceptDeployment(request: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptDeploymentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInterceptDeploymentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInterceptDeployment(request, callback)

updateInterceptDeployment(request: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptDeploymentRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInterceptDeploymentRequest
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeployment, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInterceptDeploymentGroup(request, options)

updateInterceptDeploymentGroup(request?: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptDeploymentGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a deployment group. See https://google.aip.dev/134.

Parameters
Name Description
request IUpdateInterceptDeploymentGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.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. The list of fields to update.
   *  Fields are specified relative to the deployment group
   *  (e.g. `description`; *not*
   *  `intercept_deployment_group.description`). See
   *  https://google.aip.dev/161 for more details.
   */
  // const updateMask = {}
  /**
   *  Required. The deployment group to update.
   */
  // const interceptDeploymentGroup = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callUpdateInterceptDeploymentGroup() {
    // Construct request
    const request = {
      interceptDeploymentGroup,
    };

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

  callUpdateInterceptDeploymentGroup();

updateInterceptDeploymentGroup(request, options, callback)

updateInterceptDeploymentGroup(request: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptDeploymentGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInterceptDeploymentGroupRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInterceptDeploymentGroup(request, callback)

updateInterceptDeploymentGroup(request: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptDeploymentGroupRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInterceptDeploymentGroupRequest
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptDeploymentGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInterceptEndpointGroup(request, options)

updateInterceptEndpointGroup(request?: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptEndpointGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates an endpoint group. See https://google.aip.dev/134.

Parameters
Name Description
request IUpdateInterceptEndpointGroupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.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. The list of fields to update.
   *  Fields are specified relative to the endpoint group
   *  (e.g. `description`; *not* `intercept_endpoint_group.description`).
   *  See https://google.aip.dev/161 for more details.
   */
  // const updateMask = {}
  /**
   *  Required. The endpoint group to update.
   */
  // const interceptEndpointGroup = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callUpdateInterceptEndpointGroup() {
    // Construct request
    const request = {
      interceptEndpointGroup,
    };

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

  callUpdateInterceptEndpointGroup();

updateInterceptEndpointGroup(request, options, callback)

updateInterceptEndpointGroup(request: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptEndpointGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInterceptEndpointGroupRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInterceptEndpointGroup(request, callback)

updateInterceptEndpointGroup(request: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptEndpointGroupRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInterceptEndpointGroupRequest
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroup, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInterceptEndpointGroupAssociation(request, options)

updateInterceptEndpointGroupAssociation(request?: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptEndpointGroupAssociationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates an association. See https://google.aip.dev/134.

Parameters
Name Description
request IUpdateInterceptEndpointGroupAssociationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.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. The list of fields to update.
   *  Fields are specified relative to the association
   *  (e.g. `description`; *not*
   *  `intercept_endpoint_group_association.description`). See
   *  https://google.aip.dev/161 for more details.
   */
  // const updateMask = {}
  /**
   *  Required. The association to update.
   */
  // const interceptEndpointGroupAssociation = {}
  /**
   *  Optional. A unique identifier for this request. Must be a UUID4.
   *  This request is only idempotent if a `request_id` is provided.
   *  See https://google.aip.dev/155 for more details.
   */
  // const requestId = 'abc123'

  // Imports the Networksecurity library
  const {InterceptClient} = require('@google-cloud/network-security').v1alpha1;

  // Instantiates a client
  const networksecurityClient = new InterceptClient();

  async function callUpdateInterceptEndpointGroupAssociation() {
    // Construct request
    const request = {
      interceptEndpointGroupAssociation,
    };

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

  callUpdateInterceptEndpointGroupAssociation();

updateInterceptEndpointGroupAssociation(request, options, callback)

updateInterceptEndpointGroupAssociation(request: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptEndpointGroupAssociationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInterceptEndpointGroupAssociationRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInterceptEndpointGroupAssociation(request, callback)

updateInterceptEndpointGroupAssociation(request: protos.google.cloud.networksecurity.v1alpha1.IUpdateInterceptEndpointGroupAssociationRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInterceptEndpointGroupAssociationRequest
callback Callback<LROperation<protos.google.cloud.networksecurity.v1alpha1.IInterceptEndpointGroupAssociation, protos.google.cloud.networksecurity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

urlListPath(project, location, urlList)

urlListPath(project: string, location: string, urlList: string): string;

Return a fully-qualified urlList resource name string.

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

{string} Resource name string.