Class v1alpha1.DnsThreatDetectorServiceClient (3.6.0)

The Network Security API for DNS Threat Detectors. v1alpha1

Package

@google-cloud/network-security

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of DnsThreatDetectorServiceClient.

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

dnsThreatDetectorServiceStub

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

iamClient

iamClient: IamClient;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

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.

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.

createDnsThreatDetector(request, options)

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

Creates a new DnsThreatDetector in a given project and location.

Parameters
Name Description
request ICreateDnsThreatDetectorRequest

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.IDnsThreatDetector, (protos.google.cloud.networksecurity.v1alpha1.ICreateDnsThreatDetectorRequest | 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 value for the parent of the DnsThreatDetector resource.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The ID of the requesting DnsThreatDetector object.
   *  If this field is not supplied, the service generates an identifier.
   */
  // const dnsThreatDetectorId = 'abc123'
  /**
   *  Required. The `DnsThreatDetector` resource to create.
   */
  // const dnsThreatDetector = {}

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

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

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

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

  callCreateDnsThreatDetector();

createDnsThreatDetector(request, options, callback)

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

createDnsThreatDetector(request, callback)

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

deleteDnsThreatDetector(request, options)

deleteDnsThreatDetector(request?: protos.google.cloud.networksecurity.v1alpha1.IDeleteDnsThreatDetectorRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.networksecurity.v1alpha1.IDeleteDnsThreatDetectorRequest | undefined),
        {} | undefined
    ]>;

Deletes a single DnsThreatDetector.

Parameters
Name Description
request IDeleteDnsThreatDetectorRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.networksecurity.v1alpha1.IDeleteDnsThreatDetectorRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 DnsThreatDetector resource.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteDnsThreatDetector();

deleteDnsThreatDetector(request, options, callback)

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

deleteDnsThreatDetector(request, callback)

deleteDnsThreatDetector(request: protos.google.cloud.networksecurity.v1alpha1.IDeleteDnsThreatDetectorRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IDeleteDnsThreatDetectorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDnsThreatDetectorRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1alpha1.IDeleteDnsThreatDetectorRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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.

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.

getDnsThreatDetector(request, options)

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

Gets the details of a single DnsThreatDetector.

Parameters
Name Description
request IGetDnsThreatDetectorRequest

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.IDnsThreatDetector, (protos.google.cloud.networksecurity.v1alpha1.IGetDnsThreatDetectorRequest | 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. Name of the DnsThreatDetector resource.
   */
  // const name = 'abc123'

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

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

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

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

  callGetDnsThreatDetector();

getDnsThreatDetector(request, options, callback)

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

getDnsThreatDetector(request, callback)

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

getIamPolicy(request, options, callback)

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

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

Parameters
Name Description
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.
options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

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

The second parameter to the callback is an object representing .
Returns
Type Description
Promise<[google.iam.v1.Policy]>

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

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);

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.

listDnsThreatDetectors(request, options)

listDnsThreatDetectors(request?: protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networksecurity.v1alpha1.IDnsThreatDetector[],
        protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest | null,
        protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsResponse
    ]>;

Lists DnsThreatDetectors in a given project and location.

Parameters
Name Description
request IListDnsThreatDetectorsRequest

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.IDnsThreatDetector[], protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest | null, protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsResponse ]>

{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 listDnsThreatDetectorsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDnsThreatDetectors(request, options, callback)

listDnsThreatDetectors(request: protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest, protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IDnsThreatDetector>): void;
Parameters
Name Description
request IListDnsThreatDetectorsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest, protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IDnsThreatDetector>
Returns
Type Description
void

listDnsThreatDetectors(request, callback)

listDnsThreatDetectors(request: protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest, callback: PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest, protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IDnsThreatDetector>): void;
Parameters
Name Description
request IListDnsThreatDetectorsRequest
callback PaginationCallback<protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest, protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsResponse | null | undefined, protos.google.cloud.networksecurity.v1alpha1.IDnsThreatDetector>
Returns
Type Description
void

listDnsThreatDetectorsAsync(request, options)

listDnsThreatDetectorsAsync(request?: protos.google.cloud.networksecurity.v1alpha1.IListDnsThreatDetectorsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networksecurity.v1alpha1.IDnsThreatDetector>;

Equivalent to listDnsThreatDetectors, but returns an iterable object.

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

Parameters
Name Description
request IListDnsThreatDetectorsRequest

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

{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 value for `ListDnsThreatDetectorsRequest`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The requested page size. The server may return fewer items than
   *  requested. If unspecified, the server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token received from a previous
   *  `ListDnsThreatDetectorsRequest` call. Provide this to retrieve the
   *  subsequent page.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListDnsThreatDetectors();

listDnsThreatDetectorsStream(request, options)

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

Equivalent to listDnsThreatDetectors, but returns a NodeJS Stream object.

Parameters
Name Description
request IListDnsThreatDetectorsRequest

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 listDnsThreatDetectorsAsync() 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
}

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.

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.

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.

updateDnsThreatDetector(request, options)

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

Updates a single DnsThreatDetector.

Parameters
Name Description
request IUpdateDnsThreatDetectorRequest

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.IDnsThreatDetector, (protos.google.cloud.networksecurity.v1alpha1.IUpdateDnsThreatDetectorRequest | 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.
   */
  /**
   *  Optional. The field mask is used to specify the fields to be overwritten in
   *  the DnsThreatDetector resource by the update. The fields specified in the
   *  update_mask are relative to the resource, not the full request. A field
   *  will be overwritten if it is in the mask. If the mask is not provided then
   *  all fields present in the request will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The DnsThreatDetector resource being updated.
   */
  // const dnsThreatDetector = {}

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

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

  async function callUpdateDnsThreatDetector() {
    // Construct request
    const request = {
      dnsThreatDetector,
    };

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

  callUpdateDnsThreatDetector();

updateDnsThreatDetector(request, options, callback)

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

updateDnsThreatDetector(request, callback)

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