The OrganizationSecurityPolicies API. v1
Package
@google-cloud/compute
Constructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of OrganizationSecurityPoliciesClient.
| Parameters |
| Name |
Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new OrganizationSecurityPoliciesClient({fallback: true}, gax); ```
|
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
organizationSecurityPoliciesStub
organizationSecurityPoliciesStub?: Promise<{
[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.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
addAssociation(request, options)
addAssociation(request?: protos.google.cloud.compute.v1.IAddAssociationOrganizationSecurityPolicyRequest, 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 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 of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* Name of the security policy to update.
*/
// const securityPolicy = 'abc123'
/**
* The body resource for this request
*/
// const securityPolicyAssociationResource = {}
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callAddAssociation() {
// Construct request
const request = {
securityPolicy,
securityPolicyAssociationResource,
};
// Run request
const response = await computeClient.addAssociation(request);
console.log(response);
}
callAddAssociation();
addAssociation(request, options, callback)
addAssociation(request: protos.google.cloud.compute.v1.IAddAssociationOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
addAssociation(request, callback)
addAssociation(request: protos.google.cloud.compute.v1.IAddAssociationOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
addRule(request, options)
addRule(request?: protos.google.cloud.compute.v1.IAddRuleOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Inserts a rule into a security policy.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* Name of the security policy to update.
*/
// const securityPolicy = 'abc123'
/**
* The body resource for this request
*/
// const securityPolicyRuleResource = {}
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callAddRule() {
// Construct request
const request = {
securityPolicy,
securityPolicyRuleResource,
};
// Run request
const response = await computeClient.addRule(request);
console.log(response);
}
callAddRule();
addRule(request, options, callback)
addRule(request: protos.google.cloud.compute.v1.IAddRuleOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
addRule(request, callback)
addRule(request: protos.google.cloud.compute.v1.IAddRuleOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Returns |
| Type |
Description |
Promise<void> |
{Promise} A promise that resolves when the client is closed.
|
copyRules(request, options)
copyRules(request?: protos.google.cloud.compute.v1.ICopyRulesOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* Name of the security policy to update.
*/
// const securityPolicy = 'abc123'
/**
* The security policy from which to copy rules.
*/
// const sourceSecurityPolicy = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callCopyRules() {
// Construct request
const request = {
securityPolicy,
};
// Run request
const response = await computeClient.copyRules(request);
console.log(response);
}
callCopyRules();
copyRules(request, options, callback)
copyRules(request: protos.google.cloud.compute.v1.ICopyRulesOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICopyRulesOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
copyRules(request, callback)
copyRules(request: protos.google.cloud.compute.v1.ICopyRulesOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ICopyRulesOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
delete(request, options)
delete(request?: protos.google.cloud.compute.v1.IDeleteOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* Name of the security policy to delete.
*/
// const securityPolicy = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callDelete() {
// Construct request
const request = {
securityPolicy,
};
// Run request
const response = await computeClient.delete(request);
console.log(response);
}
callDelete();
delete(request, options, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
delete(request, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
get(request, options)
get(request?: protos.google.cloud.compute.v1.IGetOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ISecurityPolicy,
protos.google.cloud.compute.v1.IGetOrganizationSecurityPolicyRequest | undefined,
{} | undefined
]>;
List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Name of the security policy to get.
*/
// const securityPolicy = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callGet() {
// Construct request
const request = {
securityPolicy,
};
// Run request
const response = await computeClient.get(request);
console.log(response);
}
callGet();
get(request, options, callback)
get(request: protos.google.cloud.compute.v1.IGetOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ISecurityPolicy, protos.google.cloud.compute.v1.IGetOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
get(request, callback)
get(request: protos.google.cloud.compute.v1.IGetOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.ISecurityPolicy, protos.google.cloud.compute.v1.IGetOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getAssociation(request, options)
getAssociation(request?: protos.google.cloud.compute.v1.IGetAssociationOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ISecurityPolicyAssociation,
protos.google.cloud.compute.v1.IGetAssociationOrganizationSecurityPolicyRequest | undefined,
{} | undefined
]>;
Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the association to get from the security policy.
*/
// const name = 'abc123'
/**
* Name of the security policy to which the queried rule belongs.
*/
// const securityPolicy = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callGetAssociation() {
// Construct request
const request = {
securityPolicy,
};
// Run request
const response = await computeClient.getAssociation(request);
console.log(response);
}
callGetAssociation();
getAssociation(request, options, callback)
getAssociation(request: protos.google.cloud.compute.v1.IGetAssociationOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ISecurityPolicyAssociation, protos.google.cloud.compute.v1.IGetAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getAssociation(request, callback)
getAssociation(request: protos.google.cloud.compute.v1.IGetAssociationOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.ISecurityPolicyAssociation, protos.google.cloud.compute.v1.IGetAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getProjectId()
getProjectId(): Promise<string>;
| Returns |
| Type |
Description |
Promise<string> |
|
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
| Parameter |
| Name |
Description |
callback |
Callback<string, undefined, undefined>
|
| Returns |
| Type |
Description |
void |
|
getRule(request, options)
getRule(request?: protos.google.cloud.compute.v1.IGetRuleOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ISecurityPolicyRule,
protos.google.cloud.compute.v1.IGetRuleOrganizationSecurityPolicyRequest | undefined,
{} | undefined
]>;
Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The priority of the rule to get from the security policy.
*/
// const priority = 1234
/**
* Name of the security policy to which the queried rule belongs.
*/
// const securityPolicy = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callGetRule() {
// Construct request
const request = {
securityPolicy,
};
// Run request
const response = await computeClient.getRule(request);
console.log(response);
}
callGetRule();
getRule(request, options, callback)
getRule(request: protos.google.cloud.compute.v1.IGetRuleOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ISecurityPolicyRule, protos.google.cloud.compute.v1.IGetRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
getRule(request, callback)
getRule(request: protos.google.cloud.compute.v1.IGetRuleOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.ISecurityPolicyRule, protos.google.cloud.compute.v1.IGetRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Returns |
| Type |
Description |
Promise<{
[name: string]: Function;
}> |
{Promise} A promise that resolves to an authenticated service stub.
|
insert(request, options)
insert(request?: protos.google.cloud.compute.v1.IInsertOrganizationSecurityPolicyRequest, 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. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* The body resource for this request
*/
// const securityPolicyResource = {}
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callInsert() {
// Construct request
const request = {
securityPolicyResource,
};
// Run request
const response = await computeClient.insert(request);
console.log(response);
}
callInsert();
insert(request, options, callback)
insert(request: protos.google.cloud.compute.v1.IInsertOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
insert(request, callback)
insert(request: protos.google.cloud.compute.v1.IInsertOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
list(request, options)
list(request?: protos.google.cloud.compute.v1.IListOrganizationSecurityPoliciesRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ISecurityPolicy[],
protos.google.cloud.compute.v1.IListOrganizationSecurityPoliciesRequest | null,
protos.google.cloud.compute.v1.ISecurityPolicyList
]>;
List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.
list(request, options, callback)
list(request: protos.google.cloud.compute.v1.IListOrganizationSecurityPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListOrganizationSecurityPoliciesRequest, protos.google.cloud.compute.v1.ISecurityPolicyList | null | undefined, protos.google.cloud.compute.v1.ISecurityPolicy>): void;
| Returns |
| Type |
Description |
void |
|
list(request, callback)
list(request: protos.google.cloud.compute.v1.IListOrganizationSecurityPoliciesRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListOrganizationSecurityPoliciesRequest, protos.google.cloud.compute.v1.ISecurityPolicyList | null | undefined, protos.google.cloud.compute.v1.ISecurityPolicy>): void;
| Returns |
| Type |
Description |
void |
|
listAssociations(request, options)
listAssociations(request?: protos.google.cloud.compute.v1.IListAssociationsOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IOrganizationSecurityPoliciesListAssociationsResponse,
protos.google.cloud.compute.v1.IListAssociationsOrganizationSecurityPolicyRequest | undefined,
{} | undefined
]>;
Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The target resource to list associations. It is an organization, or a folder.
*/
// const targetResource = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
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.IListAssociationsOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOrganizationSecurityPoliciesListAssociationsResponse, protos.google.cloud.compute.v1.IListAssociationsOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
listAssociations(request, callback)
listAssociations(request: protos.google.cloud.compute.v1.IListAssociationsOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOrganizationSecurityPoliciesListAssociationsResponse, protos.google.cloud.compute.v1.IListAssociationsOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
listAsync(request, options)
listAsync(request?: protos.google.cloud.compute.v1.IListOrganizationSecurityPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.ISecurityPolicy>;
Equivalent to list, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Returns |
| Type |
Description |
AsyncIterable<protos.google.cloud.compute.v1.ISecurityPolicy> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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 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)
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 Google RE2 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.
/
// 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. 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.
*/
// const returnPartialSuccess = true
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callList() {
// Construct request
const request = {
};
// Run request
const iterable = computeClient.listAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callList();
listPreconfiguredExpressionSets(request?: protos.google.cloud.compute.v1.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ISecurityPoliciesListPreconfiguredExpressionSetsResponse,
protos.google.cloud.compute.v1.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest | undefined,
{} | undefined
]>;
Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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 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)
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 Google RE2 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.
/
// 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. 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.
*/
// const returnPartialSuccess = true
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callListPreconfiguredExpressionSets() {
// Construct request
const request = {
};
// Run request
const response = await computeClient.listPreconfiguredExpressionSets(request);
console.log(response);
}
callListPreconfiguredExpressionSets();
listPreconfiguredExpressionSets(request: protos.google.cloud.compute.v1.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ISecurityPoliciesListPreconfiguredExpressionSetsResponse, protos.google.cloud.compute.v1.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
listPreconfiguredExpressionSets(request: protos.google.cloud.compute.v1.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, callback: Callback<protos.google.cloud.compute.v1.ISecurityPoliciesListPreconfiguredExpressionSetsResponse, protos.google.cloud.compute.v1.IListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
listStream(request, options)
listStream(request?: protos.google.cloud.compute.v1.IListOrganizationSecurityPoliciesRequest, options?: CallOptions): Transform;
Equivalent to list, but returns a NodeJS Stream object.
| Returns |
| Type |
Description |
Transform |
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
move(request, options)
move(request?: protos.google.cloud.compute.v1.IMoveOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The new parent of the security 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'
/**
* Name of the security policy to update.
*/
// const securityPolicy = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callMove() {
// Construct request
const request = {
securityPolicy,
};
// Run request
const response = await computeClient.move(request);
console.log(response);
}
callMove();
move(request, options, callback)
move(request: protos.google.cloud.compute.v1.IMoveOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IMoveOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
move(request, callback)
move(request: protos.google.cloud.compute.v1.IMoveOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IMoveOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
patch(request, options)
patch(request?: protos.google.cloud.compute.v1.IPatchOrganizationSecurityPolicyRequest, 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. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* Name of the security policy to update.
*/
// const securityPolicy = 'abc123'
/**
* The body resource for this request
*/
// const securityPolicyResource = {}
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callPatch() {
// Construct request
const request = {
securityPolicy,
securityPolicyResource,
};
// Run request
const response = await computeClient.patch(request);
console.log(response);
}
callPatch();
patch(request, options, callback)
patch(request: protos.google.cloud.compute.v1.IPatchOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
patch(request, callback)
patch(request: protos.google.cloud.compute.v1.IPatchOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
patchRule(request, options)
patchRule(request?: protos.google.cloud.compute.v1.IPatchRuleOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* Name of the security policy to update.
*/
// const securityPolicy = 'abc123'
/**
* The body resource for this request
*/
// const securityPolicyRuleResource = {}
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callPatchRule() {
// Construct request
const request = {
securityPolicy,
securityPolicyRuleResource,
};
// Run request
const response = await computeClient.patchRule(request);
console.log(response);
}
callPatchRule();
patchRule(request, options, callback)
patchRule(request: protos.google.cloud.compute.v1.IPatchRuleOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
patchRule(request, callback)
patchRule(request: protos.google.cloud.compute.v1.IPatchRuleOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
removeAssociation(request, options)
removeAssociation(request?: protos.google.cloud.compute.v1.IRemoveAssociationOrganizationSecurityPolicyRequest, 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 security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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'
/**
* Name of the security policy to update.
*/
// const securityPolicy = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callRemoveAssociation() {
// Construct request
const request = {
securityPolicy,
};
// Run request
const response = await computeClient.removeAssociation(request);
console.log(response);
}
callRemoveAssociation();
removeAssociation(request, options, callback)
removeAssociation(request: protos.google.cloud.compute.v1.IRemoveAssociationOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
removeAssociation(request, callback)
removeAssociation(request: protos.google.cloud.compute.v1.IRemoveAssociationOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveAssociationOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
removeRule(request, options)
removeRule(request?: protos.google.cloud.compute.v1.IRemoveRuleOrganizationSecurityPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Deletes a rule at the specified priority.
| Returns |
| Type |
Description |
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 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The priority of the rule to remove from the security 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'
/**
* Name of the security policy to update.
*/
// const securityPolicy = 'abc123'
// Imports the Compute library
const {OrganizationSecurityPoliciesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new OrganizationSecurityPoliciesClient();
async function callRemoveRule() {
// Construct request
const request = {
securityPolicy,
};
// Run request
const response = await computeClient.removeRule(request);
console.log(response);
}
callRemoveRule();
removeRule(request, options, callback)
removeRule(request: protos.google.cloud.compute.v1.IRemoveRuleOrganizationSecurityPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
removeRule(request, callback)
removeRule(request: protos.google.cloud.compute.v1.IRemoveRuleOrganizationSecurityPolicyRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveRuleOrganizationSecurityPolicyRequest | null | undefined, {} | null | undefined>): void;
| Returns |
| Type |
Description |
void |
|
