@google-cloud/compute

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 OrganizationSecurityPolicies API. * @class * @memberof v1beta */ export declare class OrganizationSecurityPoliciesClient { 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; }; organizationSecurityPoliciesStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of OrganizationSecurityPoliciesClient. * * @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 OrganizationSecurityPoliciesClient({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 security policy. * * This has billing implications. Projects in the hierarchy with effective * hierarchical security policies will be automatically enrolled into Cloud * Armor Enterprise if not already enrolled. * * Use this API to modify Cloud Armor policies. Previously, alpha and beta * versions of this API were used to modify firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.addAssociation * instead. * * @param {Object} request * The request object that will be sent. * @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 {string} request.securityPolicy * Name of the security policy to update. * @param {google.cloud.compute.v1beta.SecurityPolicyAssociation} request.securityPolicyAssociationResource * The body 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 * 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/organization_security_policies.add_association.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_AddAssociation_async */ addAssociation(request?: protos.google.cloud.compute.v1beta.IAddAssociationOrganizationSecurityPolicyRequest, 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.IAddAssociationOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; addAssociation(request: protos.google.cloud.compute.v1beta.IAddAssociationOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Inserts a rule into a security policy. * * Use this API to modify Cloud Armor policies. Previously, alpha and beta * versions of this API were used to modify firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.addRule instead. * * @param {Object} request * The request object that will be sent. * @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.securityPolicy * Name of the security policy to update. * @param {google.cloud.compute.v1beta.SecurityPolicyRule} request.securityPolicyRuleResource * The body 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 * 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/organization_security_policies.add_rule.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_AddRule_async */ addRule(request?: protos.google.cloud.compute.v1beta.IAddRuleOrganizationSecurityPolicyRequest, 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.IAddRuleOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; addRule(request: protos.google.cloud.compute.v1beta.IAddRuleOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IAddRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Copies rules to the specified security policy. * * Use this API to modify Cloud Armor policies. Previously, alpha and beta * versions of this API were used to modify firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.cloneRules * instead. * * @param {Object} request * The request object that will be sent. * @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.securityPolicy * Name of the security policy to update. * @param {string} request.sourceSecurityPolicy * The security 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/organization_security_policies.copy_rules.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_CopyRules_async */ copyRules(request?: protos.google.cloud.compute.v1beta.ICopyRulesOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; copyRules(request: protos.google.cloud.compute.v1beta.ICopyRulesOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.ICopyRulesOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; copyRules(request: protos.google.cloud.compute.v1beta.ICopyRulesOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.ICopyRulesOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Deletes the specified policy. * * Use this API to remove Cloud Armor policies. Previously, alpha and beta * versions of this API were used to remove firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.delete instead. * * @param {Object} request * The request object that will be sent. * @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.securityPolicy * Name of the security policy to delete. * @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/organization_security_policies.delete.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_Delete_async */ delete(request?: protos.google.cloud.compute.v1beta.IDeleteOrganizationSecurityPolicyRequest, 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.IDeleteOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; delete(request: protos.google.cloud.compute.v1beta.IDeleteOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * List all of the ordered rules present in a single specified policy. * * Use this API to read Cloud Armor policies. Previously, alpha and beta * versions of this API were used to read firewall policies. This usage is now * disabled for most organizations. Use firewallPolicies.get instead. * * @param {Object} request * The request object that will be sent. * @param {string} request.securityPolicy * Name of the security 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.SecurityPolicy|SecurityPolicy}. * 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/organization_security_policies.get.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_Get_async */ get(request?: protos.google.cloud.compute.v1beta.IGetOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.ISecurityPolicy, protos.google.cloud.compute.v1beta.IGetOrganizationSecurityPolicyRequest | undefined, {} | undefined ]>; get(request: protos.google.cloud.compute.v1beta.IGetOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.ISecurityPolicy, protos.google.cloud.compute.v1beta.IGetOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; get(request: protos.google.cloud.compute.v1beta.IGetOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.ISecurityPolicy, protos.google.cloud.compute.v1beta.IGetOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Gets an association with the specified name. * * Use this API to read Cloud Armor policies. Previously, alpha and beta * versions of this API were used to read firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.getAssociation * instead. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * The name of the association to get from the security policy. * @param {string} request.securityPolicy * Name of the security policy to which the queried rule belongs. * @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.SecurityPolicyAssociation|SecurityPolicyAssociation}. * 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/organization_security_policies.get_association.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_GetAssociation_async */ getAssociation(request?: protos.google.cloud.compute.v1beta.IGetAssociationOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.ISecurityPolicyAssociation, protos.google.cloud.compute.v1beta.IGetAssociationOrganizationSecurityPolicyRequest | undefined, {} | undefined ]>; getAssociation(request: protos.google.cloud.compute.v1beta.IGetAssociationOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.ISecurityPolicyAssociation, protos.google.cloud.compute.v1beta.IGetAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; getAssociation(request: protos.google.cloud.compute.v1beta.IGetAssociationOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.ISecurityPolicyAssociation, protos.google.cloud.compute.v1beta.IGetAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Gets a rule at the specified priority. * * Use this API to read Cloud Armor policies. Previously, alpha and beta * versions of this API were used to read firewall policies. This usage is now * disabled for most organizations. Use firewallPolicies.getRule instead. * * @param {Object} request * The request object that will be sent. * @param {number} request.priority * The priority of the rule to get from the security policy. * @param {string} request.securityPolicy * Name of the security policy to which the queried rule belongs. * @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.SecurityPolicyRule|SecurityPolicyRule}. * 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/organization_security_policies.get_rule.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_GetRule_async */ getRule(request?: protos.google.cloud.compute.v1beta.IGetRuleOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.ISecurityPolicyRule, protos.google.cloud.compute.v1beta.IGetRuleOrganizationSecurityPolicyRequest | undefined, {} | undefined ]>; getRule(request: protos.google.cloud.compute.v1beta.IGetRuleOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.ISecurityPolicyRule, protos.google.cloud.compute.v1beta.IGetRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; getRule(request: protos.google.cloud.compute.v1beta.IGetRuleOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.ISecurityPolicyRule, protos.google.cloud.compute.v1beta.IGetRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Creates a new policy in the specified organization using the data included * in the request. * * Use this API to add Cloud Armor policies. Previously, alpha and beta * versions of this API were used to add firewall policies. This usage is now * disabled for most organizations. Use firewallPolicies.insert instead. * * @param {Object} request * The request object that will be sent. * @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 {google.cloud.compute.v1beta.SecurityPolicy} request.securityPolicyResource * The body 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 * 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/organization_security_policies.insert.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_Insert_async */ insert(request?: protos.google.cloud.compute.v1beta.IInsertOrganizationSecurityPolicyRequest, 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.IInsertOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; insert(request: protos.google.cloud.compute.v1beta.IInsertOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Lists associations of a specified target, i.e., organization or folder. * * Use this API to read Cloud Armor policies. Previously, alpha and beta * versions of this API were used to read firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.listAssociations * instead. * * @param {Object} request * The request object that will be sent. * @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.OrganizationSecurityPoliciesListAssociationsResponse|OrganizationSecurityPoliciesListAssociationsResponse}. * 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/organization_security_policies.list_associations.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_ListAssociations_async */ listAssociations(request?: protos.google.cloud.compute.v1beta.IListAssociationsOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.IOrganizationSecurityPoliciesListAssociationsResponse, protos.google.cloud.compute.v1beta.IListAssociationsOrganizationSecurityPolicyRequest | undefined, {} | undefined ]>; listAssociations(request: protos.google.cloud.compute.v1beta.IListAssociationsOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOrganizationSecurityPoliciesListAssociationsResponse, protos.google.cloud.compute.v1beta.IListAssociationsOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; listAssociations(request: protos.google.cloud.compute.v1beta.IListAssociationsOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOrganizationSecurityPoliciesListAssociationsResponse, protos.google.cloud.compute.v1beta.IListAssociationsOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Gets the current list of preconfigured Web Application Firewall (WAF) * expressions. * * @param {Object} request * The request object that will be sent. * @param {string} request.filter * A filter expression that filters resources listed in the response. Most * Compute resources support two types of filter expressions: * expressions that support regular expressions and expressions that follow * API improvement proposal AIP-160. * These two types of filter expressions cannot be mixed in one request. * * If you want to use AIP-160, your 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 `:*` 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 onresource 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) * ``` * * If you want to use a regular expression, use the `eq` (equal) or `ne` * (not equal) operator against a single un-parenthesized expression with or * without quotes or against multiple parenthesized expressions. Examples: * * `fieldname eq unquoted literal` * `fieldname eq 'single quoted literal'` * `fieldname eq "double quoted literal"` * `(fieldname1 eq literal) (fieldname2 ne "literal")` * * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. * The literal value must match the entire field. * * For example, to filter for instances that do not end with name "instance", * you would use `name ne .*instance`. * * You cannot combine constraints on multiple fields using regular * expressions. * @param {number} request.maxResults * 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`) * @param {string} request.orderBy * 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. * @param {string} request.pageToken * Specifies a page token to use. Set `pageToken` to the * `nextPageToken` returned by a previous list request to get * the next page of results. * @param {string} request.parentId * Parent ID for this request. * @param {boolean} request.returnPartialSuccess * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. * * For example, when partial success behavior is enabled, aggregatedList for a * single zone scope either returns all resources in the zone or no resources, * with an error code. * @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.SecurityPoliciesListPreconfiguredExpressionSetsResponse|SecurityPoliciesListPreconfiguredExpressionSetsResponse}. * 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/organization_security_policies.list_preconfigured_expression_sets.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_ListPreconfiguredExpressionSets_async */ listPreconfiguredExpressionSets(request?: protos.google.cloud.compute.v1beta.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.ISecurityPoliciesListPreconfiguredExpressionSetsResponse, protos.google.cloud.compute.v1beta.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest | undefined, {} | undefined ]>; listPreconfiguredExpressionSets(request: protos.google.cloud.compute.v1beta.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.ISecurityPoliciesListPreconfiguredExpressionSetsResponse, protos.google.cloud.compute.v1beta.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest | null | undefined, {} | null | undefined>): void; listPreconfiguredExpressionSets(request: protos.google.cloud.compute.v1beta.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, callback: Callback<protos.google.cloud.compute.v1beta.ISecurityPoliciesListPreconfiguredExpressionSetsResponse, protos.google.cloud.compute.v1beta.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest | null | undefined, {} | null | undefined>): void; /** * Moves the specified security policy. * * Use this API to modify Cloud Armor policies. Previously, alpha and beta * versions of this API were used to modify firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.move instead. * * @param {Object} request * The request object that will be sent. * @param {string} request.parentId * The new parent of the security policy. * @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.securityPolicy * Name of the security policy to update. * @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/organization_security_policies.move.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_Move_async */ move(request?: protos.google.cloud.compute.v1beta.IMoveOrganizationSecurityPolicyRequest, 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.IMoveOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IMoveOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; move(request: protos.google.cloud.compute.v1beta.IMoveOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IMoveOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Patches the specified policy with the data included in the request. * * Use this API to modify Cloud Armor policies. Previously, alpha and beta * versions of this API were used to modify firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.patch instead. * * @param {Object} request * The request object that will be sent. * @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.securityPolicy * Name of the security policy to update. * @param {google.cloud.compute.v1beta.SecurityPolicy} request.securityPolicyResource * The body resource for this request * @param {string} request.updateMask * Indicates fields to be cleared as part of 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 * 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/organization_security_policies.patch.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_Patch_async */ patch(request?: protos.google.cloud.compute.v1beta.IPatchOrganizationSecurityPolicyRequest, 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.IPatchOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; patch(request: protos.google.cloud.compute.v1beta.IPatchOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Patches a rule at the specified priority. * * Use this API to modify Cloud Armor policies. Previously, alpha and beta * versions of this API were used to modify firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.patchRule * instead. * * @param {Object} request * The request object that will be sent. * @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 {string} request.securityPolicy * Name of the security policy to update. * @param {google.cloud.compute.v1beta.SecurityPolicyRule} request.securityPolicyRuleResource * The body resource for this request * @param {string} request.updateMask * Indicates fields to be cleared as part of 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 * 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/organization_security_policies.patch_rule.js</caption> * region_tag:compute_v1beta_generated_OrganizationSecurityPolicies_PatchRule_async */ patchRule(request?: protos.google.cloud.compute.v1beta.IPatchRuleOrganizationSecurityPolicyRequest, 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.IPatchRuleOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; patchRule(request: protos.google.cloud.compute.v1beta.IPatchRuleOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Removes an association for the specified security policy. * * Use this API to modify Cloud Armor policies. Previously, alpha and beta * versions of this API were used to modify firewall policies. This usage is * now disabled for most organizations. Use firewallPolicies.removeAssociation * instead. * * @param {Object} request * The request object that will be sent. * @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 * tha