@google-cloud/compute
Version:
Google Compute Engine Client Library for Node.js
739 lines • 81.3 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* The FirewallPolicies API.
* @class
* @memberof v1beta
*/
export declare class FirewallPoliciesClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
firewallPoliciesStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of FirewallPoliciesClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: 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 FirewallPoliciesClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* 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 {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Inserts an association for the specified firewall policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {google.cloud.compute.v1beta.FirewallPolicyAssociation} request.firewallPolicyAssociationResource
* The body resource for this request
* @param {boolean} request.replaceExistingAssociation
* 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.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.add_association.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_AddAssociation_async
*/
addAssociation(request?: protos.google.cloud.compute.v1beta.IAddAssociationFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
addAssociation(request: protos.google.cloud.compute.v1beta.IAddAssociationFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
addAssociation(request: protos.google.cloud.compute.v1beta.IAddAssociationFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Inserts a packet mirroring rule into a firewall policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {google.cloud.compute.v1beta.FirewallPolicyRule} request.firewallPolicyRuleResource
* The body resource for this request
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.add_packet_mirroring_rule.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_AddPacketMirroringRule_async
*/
addPacketMirroringRule(request?: protos.google.cloud.compute.v1beta.IAddPacketMirroringRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
addPacketMirroringRule(request: protos.google.cloud.compute.v1beta.IAddPacketMirroringRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddPacketMirroringRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
addPacketMirroringRule(request: protos.google.cloud.compute.v1beta.IAddPacketMirroringRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddPacketMirroringRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Inserts a rule into a firewall policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {google.cloud.compute.v1beta.FirewallPolicyRule} request.firewallPolicyRuleResource
* The body resource for this request
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.add_rule.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_AddRule_async
*/
addRule(request?: protos.google.cloud.compute.v1beta.IAddRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
addRule(request: protos.google.cloud.compute.v1beta.IAddRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
addRule(request: protos.google.cloud.compute.v1beta.IAddRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Copies rules to the specified firewall policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {string} request.requestId
* 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).
* @param {string} request.sourceFirewallPolicy
* The firewall policy from which to copy rules.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.clone_rules.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_CloneRules_async
*/
cloneRules(request?: protos.google.cloud.compute.v1beta.ICloneRulesFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
cloneRules(request: protos.google.cloud.compute.v1beta.ICloneRulesFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.ICloneRulesFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
cloneRules(request: protos.google.cloud.compute.v1beta.ICloneRulesFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.ICloneRulesFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes the specified policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to delete.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.delete.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_Delete_async
*/
delete(request?: protos.google.cloud.compute.v1beta.IDeleteFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
delete(request: protos.google.cloud.compute.v1beta.IDeleteFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
delete(request: protos.google.cloud.compute.v1beta.IDeleteFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Returns the specified firewall policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to get.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1beta.FirewallPolicy|FirewallPolicy}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta/firewall_policies.get.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_Get_async
*/
get(request?: protos.google.cloud.compute.v1beta.IGetFirewallPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1beta.IFirewallPolicy,
protos.google.cloud.compute.v1beta.IGetFirewallPolicyRequest | undefined,
{} | undefined
]>;
get(request: protos.google.cloud.compute.v1beta.IGetFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPolicy, protos.google.cloud.compute.v1beta.IGetFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
get(request: protos.google.cloud.compute.v1beta.IGetFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPolicy, protos.google.cloud.compute.v1beta.IGetFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets an association with the specified name.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to which the queried rule belongs.
* @param {string} request.name
* The name of the association to get from the firewall policy.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1beta.FirewallPolicyAssociation|FirewallPolicyAssociation}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta/firewall_policies.get_association.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_GetAssociation_async
*/
getAssociation(request?: protos.google.cloud.compute.v1beta.IGetAssociationFirewallPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1beta.IFirewallPolicyAssociation,
protos.google.cloud.compute.v1beta.IGetAssociationFirewallPolicyRequest | undefined,
{} | undefined
]>;
getAssociation(request: protos.google.cloud.compute.v1beta.IGetAssociationFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPolicyAssociation, protos.google.cloud.compute.v1beta.IGetAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
getAssociation(request: protos.google.cloud.compute.v1beta.IGetAssociationFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPolicyAssociation, protos.google.cloud.compute.v1beta.IGetAssociationFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets the access control policy for a resource. May be empty if no such
* policy or resource exists.
*
* @param {Object} request
* The request object that will be sent.
* @param {number} request.optionsRequestedPolicyVersion
* Requested IAM Policy version.
* @param {string} request.resource
* Name or id of the resource for this request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1beta.Policy|Policy}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta/firewall_policies.get_iam_policy.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_GetIamPolicy_async
*/
getIamPolicy(request?: protos.google.cloud.compute.v1beta.IGetIamPolicyFirewallPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1beta.IPolicy,
protos.google.cloud.compute.v1beta.IGetIamPolicyFirewallPolicyRequest | undefined,
{} | undefined
]>;
getIamPolicy(request: protos.google.cloud.compute.v1beta.IGetIamPolicyFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IPolicy, protos.google.cloud.compute.v1beta.IGetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
getIamPolicy(request: protos.google.cloud.compute.v1beta.IGetIamPolicyFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IPolicy, protos.google.cloud.compute.v1beta.IGetIamPolicyFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets a packet mirroring rule of the specified priority.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to which the queried rule belongs.
* @param {number} request.priority
* The priority of the rule to get from the firewall policy.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1beta.FirewallPolicyRule|FirewallPolicyRule}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta/firewall_policies.get_packet_mirroring_rule.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_GetPacketMirroringRule_async
*/
getPacketMirroringRule(request?: protos.google.cloud.compute.v1beta.IGetPacketMirroringRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1beta.IFirewallPolicyRule,
protos.google.cloud.compute.v1beta.IGetPacketMirroringRuleFirewallPolicyRequest | undefined,
{} | undefined
]>;
getPacketMirroringRule(request: protos.google.cloud.compute.v1beta.IGetPacketMirroringRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPolicyRule, protos.google.cloud.compute.v1beta.IGetPacketMirroringRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
getPacketMirroringRule(request: protos.google.cloud.compute.v1beta.IGetPacketMirroringRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPolicyRule, protos.google.cloud.compute.v1beta.IGetPacketMirroringRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets a rule of the specified priority.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to which the queried rule belongs.
* @param {number} request.priority
* The priority of the rule to get from the firewall policy.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1beta.FirewallPolicyRule|FirewallPolicyRule}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta/firewall_policies.get_rule.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_GetRule_async
*/
getRule(request?: protos.google.cloud.compute.v1beta.IGetRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1beta.IFirewallPolicyRule,
protos.google.cloud.compute.v1beta.IGetRuleFirewallPolicyRequest | undefined,
{} | undefined
]>;
getRule(request: protos.google.cloud.compute.v1beta.IGetRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPolicyRule, protos.google.cloud.compute.v1beta.IGetRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
getRule(request: protos.google.cloud.compute.v1beta.IGetRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPolicyRule, protos.google.cloud.compute.v1beta.IGetRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a new policy in the specified project using the data included in
* the request.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.compute.v1beta.FirewallPolicy} request.firewallPolicyResource
* The body resource for this request
* @param {string} request.parentId
* 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.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.insert.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_Insert_async
*/
insert(request?: protos.google.cloud.compute.v1beta.IInsertFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
insert(request: protos.google.cloud.compute.v1beta.IInsertFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
insert(request: protos.google.cloud.compute.v1beta.IInsertFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Lists associations of a specified target, i.e., organization or folder.
*
* @param {Object} request
* The request object that will be sent.
* @param {boolean} request.includeInheritedPolicies
* If set to "true", the response will contain a list of all associations for
* the containing folders and the containing organization of the target. The
* parameter has no effect if the target is an organization.
* @param {string} request.targetResource
* The target resource to list associations. It is an organization, or a
* folder.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.compute.v1beta.FirewallPoliciesListAssociationsResponse|FirewallPoliciesListAssociationsResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta/firewall_policies.list_associations.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_ListAssociations_async
*/
listAssociations(request?: protos.google.cloud.compute.v1beta.IListAssociationsFirewallPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1beta.IFirewallPoliciesListAssociationsResponse,
protos.google.cloud.compute.v1beta.IListAssociationsFirewallPolicyRequest | undefined,
{} | undefined
]>;
listAssociations(request: protos.google.cloud.compute.v1beta.IListAssociationsFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPoliciesListAssociationsResponse, protos.google.cloud.compute.v1beta.IListAssociationsFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
listAssociations(request: protos.google.cloud.compute.v1beta.IListAssociationsFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IFirewallPoliciesListAssociationsResponse, protos.google.cloud.compute.v1beta.IListAssociationsFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Moves the specified firewall policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {string} request.parentId
* The new parent of the firewall policy. 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.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.move.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_Move_async
*/
move(request?: protos.google.cloud.compute.v1beta.IMoveFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
move(request: protos.google.cloud.compute.v1beta.IMoveFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IMoveFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
move(request: protos.google.cloud.compute.v1beta.IMoveFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IMoveFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Patches the specified policy with the data included in the request.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {google.cloud.compute.v1beta.FirewallPolicy} request.firewallPolicyResource
* The body resource for this request
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.patch.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_Patch_async
*/
patch(request?: protos.google.cloud.compute.v1beta.IPatchFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
patch(request: protos.google.cloud.compute.v1beta.IPatchFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
patch(request: protos.google.cloud.compute.v1beta.IPatchFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Patches a packet mirroring rule of the specified priority.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {google.cloud.compute.v1beta.FirewallPolicyRule} request.firewallPolicyRuleResource
* The body resource for this request
* @param {number} request.priority
* The priority of the rule to patch.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.patch_packet_mirroring_rule.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_PatchPacketMirroringRule_async
*/
patchPacketMirroringRule(request?: protos.google.cloud.compute.v1beta.IPatchPacketMirroringRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
patchPacketMirroringRule(request: protos.google.cloud.compute.v1beta.IPatchPacketMirroringRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchPacketMirroringRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
patchPacketMirroringRule(request: protos.google.cloud.compute.v1beta.IPatchPacketMirroringRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchPacketMirroringRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Patches a rule of the specified priority.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {google.cloud.compute.v1beta.FirewallPolicyRule} request.firewallPolicyRuleResource
* The body resource for this request
* @param {number} request.priority
* The priority of the rule to patch.
* @param {string} request.requestId
* 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).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* 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 <caption>include:samples/generated/v1beta/firewall_policies.patch_rule.js</caption>
* region_tag:compute_v1beta_generated_FirewallPolicies_PatchRule_async
*/
patchRule(request?: protos.google.cloud.compute.v1beta.IPatchRuleFirewallPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1beta.IOperation, null>,
protos.google.cloud.compute.v1beta.IOperation | undefined,
{} | undefined
]>;
patchRule(request: protos.google.cloud.compute.v1beta.IPatchRuleFirewallPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
patchRule(request: protos.google.cloud.compute.v1beta.IPatchRuleFirewallPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRuleFirewallPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Removes an association for the specified firewall policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.firewallPolicy
* Name of the firewall policy to update.
* @param {string} request.name
* Name for the attachment that will be removed.
* @param {string} request.requestId
* 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