Class v1.FirewallPoliciesClient (3.1.2)

The FirewallPolicies API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of FirewallPoliciesClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

firewallPoliciesStub

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

innerApiCalls

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

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

Methods

addAssociation(request, options)

addAssociation(request?: protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Inserts an association for the specified firewall policy.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to update.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  The body resource for this request
   */
  // const firewallPolicyAssociationResource = {}
  /**
   *  Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
   */
  // const replaceExistingAssociation = true
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callAddAssociation() {
    // Construct request
    const request = {
      firewallPolicy,
      firewallPolicyAssociationResource,
    };

    // Run request
    const response = await computeClient.addAssociation(request);
    console.log(response);
  }

  callAddAssociation();

addAssociation(request, options, callback)

addAssociation(request: protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addAssociation(request, callback)

addAssociation(request: protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addRule(request, options)

addRule(request?: protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Inserts a rule into a firewall policy.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to update.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  The body resource for this request
   */
  // const firewallPolicyRuleResource = {}
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callAddRule() {
    // Construct request
    const request = {
      firewallPolicy,
      firewallPolicyRuleResource,
    };

    // Run request
    const response = await computeClient.addRule(request);
    console.log(response);
  }

  callAddRule();

addRule(request, options, callback)

addRule(request: protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addRule(request, callback)

addRule(request: protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cloneRules(request, options)

cloneRules(request?: protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Copies rules to the specified firewall policy.

Parameters
NameDescription
request protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to update.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'
  /**
   *  The firewall policy from which to copy rules.
   */
  // const sourceFirewallPolicy = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callCloneRules() {
    // Construct request
    const request = {
      firewallPolicy,
    };

    // Run request
    const response = await computeClient.cloneRules(request);
    console.log(response);
  }

  callCloneRules();

cloneRules(request, options, callback)

cloneRules(request: protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cloneRules(request, callback)

cloneRules(request: protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICloneRulesFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
TypeDescription
Promise<void>

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

delete(request, options)

delete(request?: protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Deletes the specified policy.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to delete.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callDelete() {
    // Construct request
    const request = {
      firewallPolicy,
    };

    // Run request
    const response = await computeClient.delete(request);
    console.log(response);
  }

  callDelete();

delete(request, options, callback)

delete(request: protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

delete(request, callback)

delete(request: protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, options)

get(request?: protos.google.cloud.compute.v1.IGetFirewallPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IFirewallPolicy,
        protos.google.cloud.compute.v1.IGetFirewallPolicyRequest | undefined,
        {} | undefined
    ]>;

Returns the specified firewall policy.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IFirewallPolicy, protos.google.cloud.compute.v1.IGetFirewallPolicyRequest | undefined, {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to get.
   */
  // const firewallPolicy = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callGet() {
    // Construct request
    const request = {
      firewallPolicy,
    };

    // Run request
    const response = await computeClient.get(request);
    console.log(response);
  }

  callGet();

get(request, options, callback)

get(request: protos.google.cloud.compute.v1.IGetFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IFirewallPolicy, protos.google.cloud.compute.v1.IGetFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IFirewallPolicy, protos.google.cloud.compute.v1.IGetFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

get(request: protos.google.cloud.compute.v1.IGetFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IFirewallPolicy, protos.google.cloud.compute.v1.IGetFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IFirewallPolicy, protos.google.cloud.compute.v1.IGetFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAssociation(request, options)

getAssociation(request?: protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IFirewallPolicyAssociation,
        (protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest | undefined),
        {} | undefined
    ]>;

Gets an association with the specified name.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IFirewallPolicyAssociation, (protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest | undefined), {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to which the queried rule belongs.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  The name of the association to get from the firewall policy.
   */
  // const name = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callGetAssociation() {
    // Construct request
    const request = {
      firewallPolicy,
    };

    // Run request
    const response = await computeClient.getAssociation(request);
    console.log(response);
  }

  callGetAssociation();

getAssociation(request, options, callback)

getAssociation(request: protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IFirewallPolicyAssociation, protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IFirewallPolicyAssociation, protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAssociation(request, callback)

getAssociation(request: protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IFirewallPolicyAssociation, protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IFirewallPolicyAssociation, protos.google.cloud.compute.v1.IGetAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IPolicy,
        (protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest | undefined),
        {} | undefined
    ]>;

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IPolicy, (protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest | undefined), {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Requested IAM Policy version.
   */
  // const optionsRequestedPolicyVersion = 1234
  /**
   *  Name or id of the resource for this request.
   */
  // const resource = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callGetIamPolicy() {
    // Construct request
    const request = {
      resource,
    };

    // Run request
    const response = await computeClient.getIamPolicy(request);
    console.log(response);
  }

  callGetIamPolicy();

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.IGetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

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

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

getRule(request, options)

getRule(request?: protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IFirewallPolicyRule,
        protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest | undefined,
        {} | undefined
    ]>;

Gets a rule of the specified priority.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IFirewallPolicyRule, protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest | undefined, {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to which the queried rule belongs.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  The priority of the rule to get from the firewall policy.
   */
  // const priority = 1234

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callGetRule() {
    // Construct request
    const request = {
      firewallPolicy,
    };

    // Run request
    const response = await computeClient.getRule(request);
    console.log(response);
  }

  callGetRule();

getRule(request, options, callback)

getRule(request: protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IFirewallPolicyRule, protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IFirewallPolicyRule, protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRule(request, callback)

getRule(request: protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IFirewallPolicyRule, protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IFirewallPolicyRule, protos.google.cloud.compute.v1.IGetRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

initialize()

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

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

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

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

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

insert(request, options)

insert(request?: protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new policy in the specified project using the data included in the request.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The body resource for this request
   */
  // const firewallPolicyResource = {}
  /**
   *  Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
   */
  // const parentId = 'abc123'
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callInsert() {
    // Construct request
    const request = {
      firewallPolicyResource,
    };

    // Run request
    const response = await computeClient.insert(request);
    console.log(response);
  }

  callInsert();

insert(request, options, callback)

insert(request: protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

insert(request, callback)

insert(request: protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IFirewallPolicy[],
        protos.google.cloud.compute.v1.IListFirewallPoliciesRequest | null,
        protos.google.cloud.compute.v1.IFirewallPolicyList
    ]>;

Lists all the policies that have been configured for the specified folder or organization.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListFirewallPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IFirewallPolicy[], protos.google.cloud.compute.v1.IListFirewallPoliciesRequest | null, protos.google.cloud.compute.v1.IFirewallPolicyList ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [FirewallPolicy]. 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 listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

list(request, options, callback)

list(request: protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, protos.google.cloud.compute.v1.IFirewallPolicyList | null | undefined, protos.google.cloud.compute.v1.IFirewallPolicy>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListFirewallPoliciesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, protos.google.cloud.compute.v1.IFirewallPolicyList | null | undefined, protos.google.cloud.compute.v1.IFirewallPolicy>
Returns
TypeDescription
void

list(request, callback)

list(request: protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, protos.google.cloud.compute.v1.IFirewallPolicyList | null | undefined, protos.google.cloud.compute.v1.IFirewallPolicy>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListFirewallPoliciesRequest
callback PaginationCallback<protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, protos.google.cloud.compute.v1.IFirewallPolicyList | null | undefined, protos.google.cloud.compute.v1.IFirewallPolicy>
Returns
TypeDescription
void

listAssociations(request, options)

listAssociations(request?: protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IFirewallPoliciesListAssociationsResponse,
        (protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest | undefined),
        {} | undefined
    ]>;

Lists associations of a specified target, i.e., organization or folder.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IFirewallPoliciesListAssociationsResponse, (protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest | undefined), {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The target resource to list associations. It is an organization, or a folder.
   */
  // const targetResource = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callListAssociations() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await computeClient.listAssociations(request);
    console.log(response);
  }

  callListAssociations();

listAssociations(request, options, callback)

listAssociations(request: protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IFirewallPoliciesListAssociationsResponse, protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IFirewallPoliciesListAssociationsResponse, protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

listAssociations(request, callback)

listAssociations(request: protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IFirewallPoliciesListAssociationsResponse, protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IFirewallPoliciesListAssociationsResponse, protos.google.cloud.compute.v1.IListAssociationsFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

listAsync(request, options)

listAsync(request?: protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.IFirewallPolicy>;

Equivalent to list, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListFirewallPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IFirewallPolicy>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [FirewallPolicy]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
   */
  // const maxResults = 1234
  /**
   *  Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
   */
  // const orderBy = 'abc123'
  /**
   *  Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
   */
  // const pageToken = 'abc123'
  /**
   *  Parent ID for this request.
   */
  // const parentId = 'abc123'
  /**
   *  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
   */
  // const returnPartialSuccess = true

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callList() {
    // Construct request
    const request = {
    };

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

  callList();

listStream(request, options)

listStream(request?: protos.google.cloud.compute.v1.IListFirewallPoliciesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListFirewallPoliciesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [FirewallPolicy] 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 listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

move(request, options)

move(request?: protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Moves the specified firewall policy.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to update.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  The new parent of the firewall policy.
   */
  // const parentId = 'abc123'
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callMove() {
    // Construct request
    const request = {
      firewallPolicy,
    };

    // Run request
    const response = await computeClient.move(request);
    console.log(response);
  }

  callMove();

move(request, options, callback)

move(request: protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

move(request, callback)

move(request: protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IMoveFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

patch(request, options)

patch(request?: protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Patches the specified policy with the data included in the request.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to update.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  The body resource for this request
   */
  // const firewallPolicyResource = {}
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callPatch() {
    // Construct request
    const request = {
      firewallPolicy,
      firewallPolicyResource,
    };

    // Run request
    const response = await computeClient.patch(request);
    console.log(response);
  }

  callPatch();

patch(request, options, callback)

patch(request: protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

patch(request, callback)

patch(request: protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

patchRule(request, options)

patchRule(request?: protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Patches a rule of the specified priority.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to update.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  The body resource for this request
   */
  // const firewallPolicyRuleResource = {}
  /**
   *  The priority of the rule to patch.
   */
  // const priority = 1234
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callPatchRule() {
    // Construct request
    const request = {
      firewallPolicy,
      firewallPolicyRuleResource,
    };

    // Run request
    const response = await computeClient.patchRule(request);
    console.log(response);
  }

  callPatchRule();

patchRule(request, options, callback)

patchRule(request: protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

patchRule(request, callback)

patchRule(request: protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

removeAssociation(request, options)

removeAssociation(request?: protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Removes an association for the specified firewall policy.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to update.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  Name for the attachment that will be removed.
   */
  // const name = 'abc123'
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callRemoveAssociation() {
    // Construct request
    const request = {
      firewallPolicy,
    };

    // Run request
    const response = await computeClient.removeAssociation(request);
    console.log(response);
  }

  callRemoveAssociation();

removeAssociation(request, options, callback)

removeAssociation(request: protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

removeAssociation(request, callback)

removeAssociation(request: protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

removeRule(request, options)

removeRule(request?: protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a rule of the specified priority.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.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. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the firewall policy to update.
   */
  // const firewallPolicy = 'abc123'
  /**
   *  The priority of the rule to remove from the firewall policy.
   */
  // const priority = 1234
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callRemoveRule() {
    // Construct request
    const request = {
      firewallPolicy,
    };

    // Run request
    const response = await computeClient.removeRule(request);
    console.log(response);
  }

  callRemoveRule();

removeRule(request, options, callback)

removeRule(request: protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

removeRule(request, callback)

removeRule(request: protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IPolicy,
        (protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest | undefined),
        {} | undefined
    ]>;

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
request protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IPolicy, (protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest | undefined), {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The body resource for this request
   */
  // const globalOrganizationSetPolicyRequestResource = {}
  /**
   *  Name or id of the resource for this request.
   */
  // const resource = 'abc123'

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callSetIamPolicy() {
    // Construct request
    const request = {
      globalOrganizationSetPolicyRequestResource,
      resource,
    };

    // Run request
    const response = await computeClient.setIamPolicy(request);
    console.log(response);
  }

  callSetIamPolicy();

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.IPolicy, protos.google.cloud.compute.v1.ISetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.ITestPermissionsResponse,
        (protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest | undefined),
        {} | undefined
    ]>;

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
request protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.ITestPermissionsResponse, (protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest | undefined), {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name or id of the resource for this request.
   */
  // const resource = 'abc123'
  /**
   *  The body resource for this request
   */
  // const testPermissionsRequestResource = {}

  // Imports the Compute library
  const {FirewallPoliciesClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new FirewallPoliciesClient();

  async function callTestIamPermissions() {
    // Construct request
    const request = {
      resource,
      testPermissionsRequestResource,
    };

    // Run request
    const response = await computeClient.testIamPermissions(request);
    console.log(response);
  }

  callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest
callback Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsFirewallPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void