Service for managing Firewall Endpoints and Associations. v1
Package
@google-cloud/network-securityConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);Construct an instance of FirewallActivationClient.
| Parameters | |
|---|---|
| Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;descriptors
descriptors: Descriptors;firewallActivationStub
firewallActivationStub?: Promise<{
[name: string]: Function;
}>;iamClient
iamClient: IamClient;innerApiCalls
innerApiCalls: {
[name: string]: Function;
};locationsClient
locationsClient: LocationsClient;operationsClient
operationsClient: gax.OperationsClient;pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};port
static get port(): number;The port for this API service.
scopes
static get scopes(): string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;The DNS address for this API service.
universeDomain
get universeDomain(): string;warn
warn: (code: string, message: string, warnType?: string) => void;Methods
authorizationPolicyPath(project, location, authorizationPolicy)
authorizationPolicyPath(project: string, location: string, authorizationPolicy: string): string;Return a fully-qualified authorizationPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
authorizationPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
authzPolicyPath(project, location, authzPolicy)
authzPolicyPath(project: string, location: string, authzPolicy: string): string;Return a fully-qualified authzPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
authzPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
backendAuthenticationConfigPath(project, location, backendAuthenticationConfig)
backendAuthenticationConfigPath(project: string, location: string, backendAuthenticationConfig: string): string;Return a fully-qualified backendAuthenticationConfig resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
backendAuthenticationConfig |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
cancelOperation(request, optionsOrCallback, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
optionsOrCallback |
CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
|
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<protos.google.protobuf.Empty> |
|
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkCreateFirewallEndpointAssociationProgress(name)
checkCreateFirewallEndpointAssociationProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by createFirewallEndpointAssociation().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Optional. Id of the requesting object.
* If auto-generating Id server-side, remove this field and
* firewall_endpoint_association_id from the method_signature of Create RPC.
*/
// const firewallEndpointAssociationId = 'abc123'
/**
* Required. The resource being created
*/
// const firewallEndpointAssociation = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callCreateFirewallEndpointAssociation() {
// Construct request
const request = {
parent,
firewallEndpointAssociation,
};
// Run request
const [operation] = await networksecurityClient.createFirewallEndpointAssociation(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateFirewallEndpointAssociation();
checkCreateFirewallEndpointProgress(name)
checkCreateFirewallEndpointProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpoint, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by createFirewallEndpoint().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpoint, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Required. Id of the requesting object.
* If auto-generating Id server-side, remove this field and
* firewall_endpoint_id from the method_signature of Create RPC.
*/
// const firewallEndpointId = 'abc123'
/**
* Required. The resource being created
*/
// const firewallEndpoint = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callCreateFirewallEndpoint() {
// Construct request
const request = {
parent,
firewallEndpointId,
firewallEndpoint,
};
// Run request
const [operation] = await networksecurityClient.createFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateFirewallEndpoint();
checkCreateProjectFirewallEndpointProgress(name)
checkCreateProjectFirewallEndpointProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpoint, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by createProjectFirewallEndpoint().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpoint, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Required. Id of the requesting object.
* If auto-generating Id server-side, remove this field and
* firewall_endpoint_id from the method_signature of Create RPC.
*/
// const firewallEndpointId = 'abc123'
/**
* Required. The resource being created
*/
// const firewallEndpoint = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callCreateProjectFirewallEndpoint() {
// Construct request
const request = {
parent,
firewallEndpointId,
firewallEndpoint,
};
// Run request
const [operation] = await networksecurityClient.createProjectFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateProjectFirewallEndpoint();
checkDeleteFirewallEndpointAssociationProgress(name)
checkDeleteFirewallEndpointAssociationProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by deleteFirewallEndpointAssociation().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callDeleteFirewallEndpointAssociation() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await networksecurityClient.deleteFirewallEndpointAssociation(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteFirewallEndpointAssociation();
checkDeleteFirewallEndpointProgress(name)
checkDeleteFirewallEndpointProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by deleteFirewallEndpoint().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callDeleteFirewallEndpoint() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await networksecurityClient.deleteFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteFirewallEndpoint();
checkDeleteProjectFirewallEndpointProgress(name)
checkDeleteProjectFirewallEndpointProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by deleteProjectFirewallEndpoint().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callDeleteProjectFirewallEndpoint() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await networksecurityClient.deleteProjectFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteProjectFirewallEndpoint();
checkUpdateFirewallEndpointAssociationProgress(name)
checkUpdateFirewallEndpointAssociationProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by updateFirewallEndpointAssociation().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* Association resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const firewallEndpointAssociation = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callUpdateFirewallEndpointAssociation() {
// Construct request
const request = {
updateMask,
firewallEndpointAssociation,
};
// Run request
const [operation] = await networksecurityClient.updateFirewallEndpointAssociation(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateFirewallEndpointAssociation();
checkUpdateFirewallEndpointProgress(name)
checkUpdateFirewallEndpointProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpoint, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by updateFirewallEndpoint().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpoint, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* Endpoint resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const firewallEndpoint = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callUpdateFirewallEndpoint() {
// Construct request
const request = {
updateMask,
firewallEndpoint,
};
// Run request
const [operation] = await networksecurityClient.updateFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateFirewallEndpoint();
checkUpdateProjectFirewallEndpointProgress(name)
checkUpdateProjectFirewallEndpointProgress(name: string): Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpoint, protos.google.cloud.networksecurity.v1.OperationMetadata>>;Check the status of the long running operation returned by updateProjectFirewallEndpoint().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.cloud.networksecurity.v1.FirewallEndpoint, protos.google.cloud.networksecurity.v1.OperationMetadata>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* Endpoint resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const firewallEndpoint = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callUpdateProjectFirewallEndpoint() {
// Construct request
const request = {
updateMask,
firewallEndpoint,
};
// Run request
const [operation] = await networksecurityClient.updateProjectFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateProjectFirewallEndpoint();
clientTlsPolicyPath(project, location, clientTlsPolicy)
clientTlsPolicyPath(project: string, location: string, clientTlsPolicy: string): string;Return a fully-qualified clientTlsPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
clientTlsPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
close()
close(): Promise<void>;Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Returns | |
|---|---|
| Type | Description |
Promise<void> |
{Promise} A promise that resolves when the client is closed. |
createFirewallEndpoint(request, options)
createFirewallEndpoint(request?: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Creates a new FirewallEndpoint in a given organization and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Required. Id of the requesting object.
* If auto-generating Id server-side, remove this field and
* firewall_endpoint_id from the method_signature of Create RPC.
*/
// const firewallEndpointId = 'abc123'
/**
* Required. The resource being created
*/
// const firewallEndpoint = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callCreateFirewallEndpoint() {
// Construct request
const request = {
parent,
firewallEndpointId,
firewallEndpoint,
};
// Run request
const [operation] = await networksecurityClient.createFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateFirewallEndpoint();
createFirewallEndpoint(request, options, callback)
createFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createFirewallEndpoint(request, callback)
createFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointRequest
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createFirewallEndpointAssociation(request, options)
createFirewallEndpointAssociation(request?: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointAssociationRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Creates a new FirewallEndpointAssociation in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointAssociationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Optional. Id of the requesting object.
* If auto-generating Id server-side, remove this field and
* firewall_endpoint_association_id from the method_signature of Create RPC.
*/
// const firewallEndpointAssociationId = 'abc123'
/**
* Required. The resource being created
*/
// const firewallEndpointAssociation = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callCreateFirewallEndpointAssociation() {
// Construct request
const request = {
parent,
firewallEndpointAssociation,
};
// Run request
const [operation] = await networksecurityClient.createFirewallEndpointAssociation(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateFirewallEndpointAssociation();
createFirewallEndpointAssociation(request, options, callback)
createFirewallEndpointAssociation(request: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointAssociationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointAssociationRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createFirewallEndpointAssociation(request, callback)
createFirewallEndpointAssociation(request: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointAssociationRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointAssociationRequest
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createProjectFirewallEndpoint(request, options)
createProjectFirewallEndpoint(request?: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Creates a new FirewallEndpoint in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Required. Id of the requesting object.
* If auto-generating Id server-side, remove this field and
* firewall_endpoint_id from the method_signature of Create RPC.
*/
// const firewallEndpointId = 'abc123'
/**
* Required. The resource being created
*/
// const firewallEndpoint = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callCreateProjectFirewallEndpoint() {
// Construct request
const request = {
parent,
firewallEndpointId,
firewallEndpoint,
};
// Run request
const [operation] = await networksecurityClient.createProjectFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateProjectFirewallEndpoint();
createProjectFirewallEndpoint(request, options, callback)
createProjectFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createProjectFirewallEndpoint(request, callback)
createProjectFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.ICreateFirewallEndpointRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateFirewallEndpointRequest
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteFirewallEndpoint(request, options)
deleteFirewallEndpoint(request?: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes a single org Endpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callDeleteFirewallEndpoint() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await networksecurityClient.deleteFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteFirewallEndpoint();
deleteFirewallEndpoint(request, options, callback)
deleteFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteFirewallEndpoint(request, callback)
deleteFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteFirewallEndpointAssociation(request, options)
deleteFirewallEndpointAssociation(request?: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointAssociationRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes a single FirewallEndpointAssociation.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointAssociationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callDeleteFirewallEndpointAssociation() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await networksecurityClient.deleteFirewallEndpointAssociation(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteFirewallEndpointAssociation();
deleteFirewallEndpointAssociation(request, options, callback)
deleteFirewallEndpointAssociation(request: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointAssociationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointAssociationRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteFirewallEndpointAssociation(request, callback)
deleteFirewallEndpointAssociation(request: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointAssociationRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointAssociationRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteOperation(request, optionsOrCallback, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
optionsOrCallback |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
|
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<protos.google.protobuf.Empty> |
|
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
deleteProjectFirewallEndpoint(request, options)
deleteProjectFirewallEndpoint(request?: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes a single project Endpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callDeleteProjectFirewallEndpoint() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await networksecurityClient.deleteProjectFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteProjectFirewallEndpoint();
deleteProjectFirewallEndpoint(request, options, callback)
deleteProjectFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteProjectFirewallEndpoint(request, callback)
deleteProjectFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IDeleteFirewallEndpointRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFirewallEndpointRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
dnsThreatDetectorPath(project, location, dnsThreatDetector)
dnsThreatDetectorPath(project: string, location: string, dnsThreatDetector: string): string;Return a fully-qualified dnsThreatDetector resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
dnsThreatDetector |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
firewallEndpointAssociationPath(project, location, firewallEndpointAssociation)
firewallEndpointAssociationPath(project: string, location: string, firewallEndpointAssociation: string): string;Return a fully-qualified firewallEndpointAssociation resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
firewallEndpointAssociation |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
gatewaySecurityPolicyPath(project, location, gatewaySecurityPolicy)
gatewaySecurityPolicyPath(project: string, location: string, gatewaySecurityPolicy: string): string;Return a fully-qualified gatewaySecurityPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
gatewaySecurityPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
gatewaySecurityPolicyRulePath(project, location, gatewaySecurityPolicy, rule)
gatewaySecurityPolicyRulePath(project: string, location: string, gatewaySecurityPolicy: string, rule: string): string;Return a fully-qualified gatewaySecurityPolicyRule resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
gatewaySecurityPolicy |
string
|
rule |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
getFirewallEndpoint(request, options)
getFirewallEndpoint(request?: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest, options?: CallOptions): Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpoint,
(protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | undefined),
{} | undefined
]>;Gets details of a single org Endpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpoint,
(protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callGetFirewallEndpoint() {
// Construct request
const request = {
name,
};
// Run request
const response = await networksecurityClient.getFirewallEndpoint(request);
console.log(response);
}
callGetFirewallEndpoint();
getFirewallEndpoint(request, options, callback)
getFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getFirewallEndpoint(request, callback)
getFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest, callback: Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointRequest
|
callback |
Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getFirewallEndpointAssociation(request, options)
getFirewallEndpointAssociation(request?: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest, options?: CallOptions): Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation,
(protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest | undefined),
{} | undefined
]>;Gets details of a single FirewallEndpointAssociation.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointAssociationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation,
(protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callGetFirewallEndpointAssociation() {
// Construct request
const request = {
name,
};
// Run request
const response = await networksecurityClient.getFirewallEndpointAssociation(request);
console.log(response);
}
callGetFirewallEndpointAssociation();
getFirewallEndpointAssociation(request, options, callback)
getFirewallEndpointAssociation(request: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest, options: CallOptions, callback: Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointAssociationRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getFirewallEndpointAssociation(request, callback)
getFirewallEndpointAssociation(request: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest, callback: Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointAssociationRequest
|
callback |
Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointAssociationRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getIamPolicy(request, options, callback)
getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
| Parameters | |
|---|---|
| Name | Description |
request |
IamProtos.google.iam.v1.GetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
| Returns | |
|---|---|
| Type | Description |
Promise<[google.iam.v1.Policy]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details. |
callback |
Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.location.ILocation> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
const [response] = await client.getLocation(request);
getOperation(request, optionsOrCallback, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
optionsOrCallback |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
|
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.longrunning.Operation]> |
|
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getProjectFirewallEndpoint(request, options)
getProjectFirewallEndpoint(request?: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest, options?: CallOptions): Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpoint,
(protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | undefined),
{} | undefined
]>;Gets details of a single project Endpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpoint,
(protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource
*/
// const name = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callGetProjectFirewallEndpoint() {
// Construct request
const request = {
name,
};
// Run request
const response = await networksecurityClient.getProjectFirewallEndpoint(request);
console.log(response);
}
callGetProjectFirewallEndpoint();
getProjectFirewallEndpoint(request, options, callback)
getProjectFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getProjectFirewallEndpoint(request, callback)
getProjectFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest, callback: Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetFirewallEndpointRequest
|
callback |
Callback<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IGetFirewallEndpointRequest | null | undefined, {} | null | undefined>
|
| 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 |
|
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Returns | |
|---|---|
| Type | Description |
Promise<{
[name: string]: Function;
}> |
{Promise} A promise that resolves to an authenticated service stub. |
interceptDeploymentGroupPath(project, location, interceptDeploymentGroup)
interceptDeploymentGroupPath(project: string, location: string, interceptDeploymentGroup: string): string;Return a fully-qualified interceptDeploymentGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
interceptDeploymentGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
interceptDeploymentPath(project, location, interceptDeployment)
interceptDeploymentPath(project: string, location: string, interceptDeployment: string): string;Return a fully-qualified interceptDeployment resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
interceptDeployment |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
interceptEndpointGroupAssociationPath(project, location, interceptEndpointGroupAssociation)
interceptEndpointGroupAssociationPath(project: string, location: string, interceptEndpointGroupAssociation: string): string;Return a fully-qualified interceptEndpointGroupAssociation resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
interceptEndpointGroupAssociation |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
interceptEndpointGroupPath(project, location, interceptEndpointGroup)
interceptEndpointGroupPath(project: string, location: string, interceptEndpointGroup: string): string;Return a fully-qualified interceptEndpointGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
interceptEndpointGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
listFirewallEndpointAssociations(request, options)
listFirewallEndpointAssociations(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, options?: CallOptions): Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation[],
protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest | null,
protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsResponse
]>;Lists Associations in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointAssociationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation[],
protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest | null,
protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listFirewallEndpointAssociations(request, options, callback)
listFirewallEndpointAssociations(request: protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointAssociationsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listFirewallEndpointAssociations(request, callback)
listFirewallEndpointAssociations(request: protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, callback: PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointAssociationsRequest
|
callback |
PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listFirewallEndpointAssociationsAsync(request, options)
listFirewallEndpointAssociationsAsync(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation>;Equivalent to listFirewallEndpointAssociations, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointAssociationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation> |
{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. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Parent value for ListAssociationsRequest
*/
// const parent = 'abc123'
/**
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
/**
* Optional. Filtering results
*/
// const filter = 'abc123'
/**
* Hint for how to order the results
*/
// const orderBy = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callListFirewallEndpointAssociations() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = networksecurityClient.listFirewallEndpointAssociationsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListFirewallEndpointAssociations();
listFirewallEndpointAssociationsStream(request, options)
listFirewallEndpointAssociationsStream(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointAssociationsRequest, options?: CallOptions): Transform;Equivalent to listFirewallEndpointAssociations, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointAssociationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listFirewallEndpoints(request, options)
listFirewallEndpoints(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, options?: CallOptions): Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpoint[],
protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest | null,
protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse
]>;Lists FirewallEndpoints in a given organization and location.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpoint[],
protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest | null,
protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listFirewallEndpoints(request, options, callback)
listFirewallEndpoints(request: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpoint>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listFirewallEndpoints(request, callback)
listFirewallEndpoints(request: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, callback: PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpoint>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
|
callback |
PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listFirewallEndpointsAsync(request, options)
listFirewallEndpointsAsync(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networksecurity.v1.IFirewallEndpoint>;Equivalent to listFirewallEndpoints, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.networksecurity.v1.IFirewallEndpoint> |
{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. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Parent value for ListEndpointsRequest
*/
// const parent = 'abc123'
/**
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
/**
* Optional. Filtering results
*/
// const filter = 'abc123'
/**
* Hint for how to order the results
*/
// const orderBy = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callListFirewallEndpoints() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = networksecurityClient.listFirewallEndpointsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListFirewallEndpoints();
listFirewallEndpointsStream(request, options)
listFirewallEndpointsStream(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, options?: CallOptions): Transform;Equivalent to listFirewallEndpoints, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;Lists information about the supported locations for this service. Returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<google.cloud.location.ILocation> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.longrunning.IOperation> |
{Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
listProjectFirewallEndpoints(request, options)
listProjectFirewallEndpoints(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, options?: CallOptions): Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpoint[],
protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest | null,
protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse
]>;Lists FirewallEndpoints in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.cloud.networksecurity.v1.IFirewallEndpoint[],
protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest | null,
protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listProjectFirewallEndpoints(request, options, callback)
listProjectFirewallEndpoints(request: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpoint>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listProjectFirewallEndpoints(request, callback)
listProjectFirewallEndpoints(request: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, callback: PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpoint>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
|
callback |
PaginationCallback<protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, protos.google.cloud.networksecurity.v1.IListFirewallEndpointsResponse | null | undefined, protos.google.cloud.networksecurity.v1.IFirewallEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listProjectFirewallEndpointsAsync(request, options)
listProjectFirewallEndpointsAsync(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networksecurity.v1.IFirewallEndpoint>;Equivalent to listProjectFirewallEndpoints, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.networksecurity.v1.IFirewallEndpoint> |
{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. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Parent value for ListEndpointsRequest
*/
// const parent = 'abc123'
/**
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
/**
* Optional. Filtering results
*/
// const filter = 'abc123'
/**
* Hint for how to order the results
*/
// const orderBy = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callListProjectFirewallEndpoints() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = networksecurityClient.listProjectFirewallEndpointsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProjectFirewallEndpoints();
listProjectFirewallEndpointsStream(request, options)
listProjectFirewallEndpointsStream(request?: protos.google.cloud.networksecurity.v1.IListFirewallEndpointsRequest, options?: CallOptions): Transform;Equivalent to listProjectFirewallEndpoints, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFirewallEndpointsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
locationPath(project, location)
locationPath(project: string, location: string): string;Return a fully-qualified location resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
matchAddressGroupFromOrganizationLocationAddressGroupName(organizationLocationAddressGroupName)
matchAddressGroupFromOrganizationLocationAddressGroupName(organizationLocationAddressGroupName: string): string | number;Parse the address_group from OrganizationLocationAddressGroup resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationAddressGroupName |
string
A fully-qualified path representing organization_location_address_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the address_group. |
matchAddressGroupFromProjectLocationAddressGroupName(projectLocationAddressGroupName)
matchAddressGroupFromProjectLocationAddressGroupName(projectLocationAddressGroupName: string): string | number;Parse the address_group from ProjectLocationAddressGroup resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationAddressGroupName |
string
A fully-qualified path representing project_location_address_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the address_group. |
matchAuthorizationPolicyFromAuthorizationPolicyName(authorizationPolicyName)
matchAuthorizationPolicyFromAuthorizationPolicyName(authorizationPolicyName: string): string | number;Parse the authorization_policy from AuthorizationPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
authorizationPolicyName |
string
A fully-qualified path representing AuthorizationPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the authorization_policy. |
matchAuthzPolicyFromAuthzPolicyName(authzPolicyName)
matchAuthzPolicyFromAuthzPolicyName(authzPolicyName: string): string | number;Parse the authz_policy from AuthzPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
authzPolicyName |
string
A fully-qualified path representing AuthzPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the authz_policy. |
matchBackendAuthenticationConfigFromBackendAuthenticationConfigName(backendAuthenticationConfigName)
matchBackendAuthenticationConfigFromBackendAuthenticationConfigName(backendAuthenticationConfigName: string): string | number;Parse the backend_authentication_config from BackendAuthenticationConfig resource.
| Parameter | |
|---|---|
| Name | Description |
backendAuthenticationConfigName |
string
A fully-qualified path representing BackendAuthenticationConfig resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the backend_authentication_config. |
matchClientTlsPolicyFromClientTlsPolicyName(clientTlsPolicyName)
matchClientTlsPolicyFromClientTlsPolicyName(clientTlsPolicyName: string): string | number;Parse the client_tls_policy from ClientTlsPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
clientTlsPolicyName |
string
A fully-qualified path representing ClientTlsPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the client_tls_policy. |
matchDnsThreatDetectorFromDnsThreatDetectorName(dnsThreatDetectorName)
matchDnsThreatDetectorFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number;Parse the dns_threat_detector from DnsThreatDetector resource.
| Parameter | |
|---|---|
| Name | Description |
dnsThreatDetectorName |
string
A fully-qualified path representing DnsThreatDetector resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the dns_threat_detector. |
matchFirewallEndpointAssociationFromFirewallEndpointAssociationName(firewallEndpointAssociationName)
matchFirewallEndpointAssociationFromFirewallEndpointAssociationName(firewallEndpointAssociationName: string): string | number;Parse the firewall_endpoint_association from FirewallEndpointAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
firewallEndpointAssociationName |
string
A fully-qualified path representing FirewallEndpointAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the firewall_endpoint_association. |
matchFirewallEndpointFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName)
matchFirewallEndpointFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName: string): string | number;Parse the firewall_endpoint from OrganizationLocationFirewallEndpoints resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationFirewallEndpointsName |
string
A fully-qualified path representing organization_location_firewallEndpoints resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the firewall_endpoint. |
matchFirewallEndpointFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName)
matchFirewallEndpointFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName: string): string | number;Parse the firewall_endpoint from ProjectLocationFirewallEndpoints resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationFirewallEndpointsName |
string
A fully-qualified path representing project_location_firewallEndpoints resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the firewall_endpoint. |
matchGatewaySecurityPolicyFromGatewaySecurityPolicyName(gatewaySecurityPolicyName)
matchGatewaySecurityPolicyFromGatewaySecurityPolicyName(gatewaySecurityPolicyName: string): string | number;Parse the gateway_security_policy from GatewaySecurityPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
gatewaySecurityPolicyName |
string
A fully-qualified path representing GatewaySecurityPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the gateway_security_policy. |
matchGatewaySecurityPolicyFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName)
matchGatewaySecurityPolicyFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName: string): string | number;Parse the gateway_security_policy from GatewaySecurityPolicyRule resource.
| Parameter | |
|---|---|
| Name | Description |
gatewaySecurityPolicyRuleName |
string
A fully-qualified path representing GatewaySecurityPolicyRule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the gateway_security_policy. |
matchInterceptDeploymentFromInterceptDeploymentName(interceptDeploymentName)
matchInterceptDeploymentFromInterceptDeploymentName(interceptDeploymentName: string): string | number;Parse the intercept_deployment from InterceptDeployment resource.
| Parameter | |
|---|---|
| Name | Description |
interceptDeploymentName |
string
A fully-qualified path representing InterceptDeployment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the intercept_deployment. |
matchInterceptDeploymentGroupFromInterceptDeploymentGroupName(interceptDeploymentGroupName)
matchInterceptDeploymentGroupFromInterceptDeploymentGroupName(interceptDeploymentGroupName: string): string | number;Parse the intercept_deployment_group from InterceptDeploymentGroup resource.
| Parameter | |
|---|---|
| Name | Description |
interceptDeploymentGroupName |
string
A fully-qualified path representing InterceptDeploymentGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the intercept_deployment_group. |
matchInterceptEndpointGroupAssociationFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName)
matchInterceptEndpointGroupAssociationFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName: string): string | number;Parse the intercept_endpoint_group_association from InterceptEndpointGroupAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
interceptEndpointGroupAssociationName |
string
A fully-qualified path representing InterceptEndpointGroupAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the intercept_endpoint_group_association. |
matchInterceptEndpointGroupFromInterceptEndpointGroupName(interceptEndpointGroupName)
matchInterceptEndpointGroupFromInterceptEndpointGroupName(interceptEndpointGroupName: string): string | number;Parse the intercept_endpoint_group from InterceptEndpointGroup resource.
| Parameter | |
|---|---|
| Name | Description |
interceptEndpointGroupName |
string
A fully-qualified path representing InterceptEndpointGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the intercept_endpoint_group. |
matchLocationFromAuthorizationPolicyName(authorizationPolicyName)
matchLocationFromAuthorizationPolicyName(authorizationPolicyName: string): string | number;Parse the location from AuthorizationPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
authorizationPolicyName |
string
A fully-qualified path representing AuthorizationPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAuthzPolicyName(authzPolicyName)
matchLocationFromAuthzPolicyName(authzPolicyName: string): string | number;Parse the location from AuthzPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
authzPolicyName |
string
A fully-qualified path representing AuthzPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromBackendAuthenticationConfigName(backendAuthenticationConfigName)
matchLocationFromBackendAuthenticationConfigName(backendAuthenticationConfigName: string): string | number;Parse the location from BackendAuthenticationConfig resource.
| Parameter | |
|---|---|
| Name | Description |
backendAuthenticationConfigName |
string
A fully-qualified path representing BackendAuthenticationConfig resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromClientTlsPolicyName(clientTlsPolicyName)
matchLocationFromClientTlsPolicyName(clientTlsPolicyName: string): string | number;Parse the location from ClientTlsPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
clientTlsPolicyName |
string
A fully-qualified path representing ClientTlsPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromDnsThreatDetectorName(dnsThreatDetectorName)
matchLocationFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number;Parse the location from DnsThreatDetector resource.
| Parameter | |
|---|---|
| Name | Description |
dnsThreatDetectorName |
string
A fully-qualified path representing DnsThreatDetector resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromFirewallEndpointAssociationName(firewallEndpointAssociationName)
matchLocationFromFirewallEndpointAssociationName(firewallEndpointAssociationName: string): string | number;Parse the location from FirewallEndpointAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
firewallEndpointAssociationName |
string
A fully-qualified path representing FirewallEndpointAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromGatewaySecurityPolicyName(gatewaySecurityPolicyName)
matchLocationFromGatewaySecurityPolicyName(gatewaySecurityPolicyName: string): string | number;Parse the location from GatewaySecurityPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
gatewaySecurityPolicyName |
string
A fully-qualified path representing GatewaySecurityPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName)
matchLocationFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName: string): string | number;Parse the location from GatewaySecurityPolicyRule resource.
| Parameter | |
|---|---|
| Name | Description |
gatewaySecurityPolicyRuleName |
string
A fully-qualified path representing GatewaySecurityPolicyRule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromInterceptDeploymentGroupName(interceptDeploymentGroupName)
matchLocationFromInterceptDeploymentGroupName(interceptDeploymentGroupName: string): string | number;Parse the location from InterceptDeploymentGroup resource.
| Parameter | |
|---|---|
| Name | Description |
interceptDeploymentGroupName |
string
A fully-qualified path representing InterceptDeploymentGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromInterceptDeploymentName(interceptDeploymentName)
matchLocationFromInterceptDeploymentName(interceptDeploymentName: string): string | number;Parse the location from InterceptDeployment resource.
| Parameter | |
|---|---|
| Name | Description |
interceptDeploymentName |
string
A fully-qualified path representing InterceptDeployment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName)
matchLocationFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName: string): string | number;Parse the location from InterceptEndpointGroupAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
interceptEndpointGroupAssociationName |
string
A fully-qualified path representing InterceptEndpointGroupAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromInterceptEndpointGroupName(interceptEndpointGroupName)
matchLocationFromInterceptEndpointGroupName(interceptEndpointGroupName: string): string | number;Parse the location from InterceptEndpointGroup resource.
| Parameter | |
|---|---|
| Name | Description |
interceptEndpointGroupName |
string
A fully-qualified path representing InterceptEndpointGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;Parse the location from Location resource.
| Parameter | |
|---|---|
| Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromMirroringDeploymentGroupName(mirroringDeploymentGroupName)
matchLocationFromMirroringDeploymentGroupName(mirroringDeploymentGroupName: string): string | number;Parse the location from MirroringDeploymentGroup resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringDeploymentGroupName |
string
A fully-qualified path representing MirroringDeploymentGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromMirroringDeploymentName(mirroringDeploymentName)
matchLocationFromMirroringDeploymentName(mirroringDeploymentName: string): string | number;Parse the location from MirroringDeployment resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringDeploymentName |
string
A fully-qualified path representing MirroringDeployment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName)
matchLocationFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName: string): string | number;Parse the location from MirroringEndpointGroupAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringEndpointGroupAssociationName |
string
A fully-qualified path representing MirroringEndpointGroupAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromMirroringEndpointGroupName(mirroringEndpointGroupName)
matchLocationFromMirroringEndpointGroupName(mirroringEndpointGroupName: string): string | number;Parse the location from MirroringEndpointGroup resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringEndpointGroupName |
string
A fully-qualified path representing MirroringEndpointGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromOrganizationLocationAddressGroupName(organizationLocationAddressGroupName)
matchLocationFromOrganizationLocationAddressGroupName(organizationLocationAddressGroupName: string): string | number;Parse the location from OrganizationLocationAddressGroup resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationAddressGroupName |
string
A fully-qualified path representing organization_location_address_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName)
matchLocationFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName: string): string | number;Parse the location from OrganizationLocationFirewallEndpoints resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationFirewallEndpointsName |
string
A fully-qualified path representing organization_location_firewallEndpoints resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromOrganizationLocationName(organizationLocationName)
matchLocationFromOrganizationLocationName(organizationLocationName: string): string | number;Parse the location from OrganizationLocation resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationName |
string
A fully-qualified path representing OrganizationLocation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName)
matchLocationFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName: string): string | number;Parse the location from OrganizationLocationSecurityProfileGroup resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationSecurityProfileGroupName |
string
A fully-qualified path representing organization_location_security_profile_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName)
matchLocationFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName: string): string | number;Parse the location from OrganizationLocationSecurityProfile resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationSecurityProfileName |
string
A fully-qualified path representing organization_location_security_profile resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationAddressGroupName(projectLocationAddressGroupName)
matchLocationFromProjectLocationAddressGroupName(projectLocationAddressGroupName: string): string | number;Parse the location from ProjectLocationAddressGroup resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationAddressGroupName |
string
A fully-qualified path representing project_location_address_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName)
matchLocationFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName: string): string | number;Parse the location from ProjectLocationFirewallEndpoints resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationFirewallEndpointsName |
string
A fully-qualified path representing project_location_firewallEndpoints resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName)
matchLocationFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName: string): string | number;Parse the location from ProjectLocationSecurityProfileGroup resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationSecurityProfileGroupName |
string
A fully-qualified path representing project_location_security_profile_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName)
matchLocationFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName: string): string | number;Parse the location from ProjectLocationSecurityProfile resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationSecurityProfileName |
string
A fully-qualified path representing project_location_security_profile resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromSACAttachmentName(sACAttachmentName)
matchLocationFromSACAttachmentName(sACAttachmentName: string): string | number;Parse the location from SACAttachment resource.
| Parameter | |
|---|---|
| Name | Description |
sACAttachmentName |
string
A fully-qualified path representing SACAttachment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromSACRealmName(sACRealmName)
matchLocationFromSACRealmName(sACRealmName: string): string | number;Parse the location from SACRealm resource.
| Parameter | |
|---|---|
| Name | Description |
sACRealmName |
string
A fully-qualified path representing SACRealm resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromServerTlsPolicyName(serverTlsPolicyName)
matchLocationFromServerTlsPolicyName(serverTlsPolicyName: string): string | number;Parse the location from ServerTlsPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
serverTlsPolicyName |
string
A fully-qualified path representing ServerTlsPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromTlsInspectionPolicyName(tlsInspectionPolicyName)
matchLocationFromTlsInspectionPolicyName(tlsInspectionPolicyName: string): string | number;Parse the location from TlsInspectionPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
tlsInspectionPolicyName |
string
A fully-qualified path representing TlsInspectionPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromUrlListName(urlListName)
matchLocationFromUrlListName(urlListName: string): string | number;Parse the location from UrlList resource.
| Parameter | |
|---|---|
| Name | Description |
urlListName |
string
A fully-qualified path representing UrlList resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchMirroringDeploymentFromMirroringDeploymentName(mirroringDeploymentName)
matchMirroringDeploymentFromMirroringDeploymentName(mirroringDeploymentName: string): string | number;Parse the mirroring_deployment from MirroringDeployment resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringDeploymentName |
string
A fully-qualified path representing MirroringDeployment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the mirroring_deployment. |
matchMirroringDeploymentGroupFromMirroringDeploymentGroupName(mirroringDeploymentGroupName)
matchMirroringDeploymentGroupFromMirroringDeploymentGroupName(mirroringDeploymentGroupName: string): string | number;Parse the mirroring_deployment_group from MirroringDeploymentGroup resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringDeploymentGroupName |
string
A fully-qualified path representing MirroringDeploymentGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the mirroring_deployment_group. |
matchMirroringEndpointGroupAssociationFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName)
matchMirroringEndpointGroupAssociationFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName: string): string | number;Parse the mirroring_endpoint_group_association from MirroringEndpointGroupAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringEndpointGroupAssociationName |
string
A fully-qualified path representing MirroringEndpointGroupAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the mirroring_endpoint_group_association. |
matchMirroringEndpointGroupFromMirroringEndpointGroupName(mirroringEndpointGroupName)
matchMirroringEndpointGroupFromMirroringEndpointGroupName(mirroringEndpointGroupName: string): string | number;Parse the mirroring_endpoint_group from MirroringEndpointGroup resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringEndpointGroupName |
string
A fully-qualified path representing MirroringEndpointGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the mirroring_endpoint_group. |
matchOrganizationFromOrganizationLocationAddressGroupName(organizationLocationAddressGroupName)
matchOrganizationFromOrganizationLocationAddressGroupName(organizationLocationAddressGroupName: string): string | number;Parse the organization from OrganizationLocationAddressGroup resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationAddressGroupName |
string
A fully-qualified path representing organization_location_address_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the organization. |
matchOrganizationFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName)
matchOrganizationFromOrganizationLocationFirewallEndpointsName(organizationLocationFirewallEndpointsName: string): string | number;Parse the organization from OrganizationLocationFirewallEndpoints resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationFirewallEndpointsName |
string
A fully-qualified path representing organization_location_firewallEndpoints resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the organization. |
matchOrganizationFromOrganizationLocationName(organizationLocationName)
matchOrganizationFromOrganizationLocationName(organizationLocationName: string): string | number;Parse the organization from OrganizationLocation resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationName |
string
A fully-qualified path representing OrganizationLocation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the organization. |
matchOrganizationFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName)
matchOrganizationFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName: string): string | number;Parse the organization from OrganizationLocationSecurityProfileGroup resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationSecurityProfileGroupName |
string
A fully-qualified path representing organization_location_security_profile_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the organization. |
matchOrganizationFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName)
matchOrganizationFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName: string): string | number;Parse the organization from OrganizationLocationSecurityProfile resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationSecurityProfileName |
string
A fully-qualified path representing organization_location_security_profile resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the organization. |
matchOrganizationFromOrganizationName(organizationName)
matchOrganizationFromOrganizationName(organizationName: string): string | number;Parse the organization from Organization resource.
| Parameter | |
|---|---|
| Name | Description |
organizationName |
string
A fully-qualified path representing Organization resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the organization. |
matchProjectFromAuthorizationPolicyName(authorizationPolicyName)
matchProjectFromAuthorizationPolicyName(authorizationPolicyName: string): string | number;Parse the project from AuthorizationPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
authorizationPolicyName |
string
A fully-qualified path representing AuthorizationPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAuthzPolicyName(authzPolicyName)
matchProjectFromAuthzPolicyName(authzPolicyName: string): string | number;Parse the project from AuthzPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
authzPolicyName |
string
A fully-qualified path representing AuthzPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromBackendAuthenticationConfigName(backendAuthenticationConfigName)
matchProjectFromBackendAuthenticationConfigName(backendAuthenticationConfigName: string): string | number;Parse the project from BackendAuthenticationConfig resource.
| Parameter | |
|---|---|
| Name | Description |
backendAuthenticationConfigName |
string
A fully-qualified path representing BackendAuthenticationConfig resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromClientTlsPolicyName(clientTlsPolicyName)
matchProjectFromClientTlsPolicyName(clientTlsPolicyName: string): string | number;Parse the project from ClientTlsPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
clientTlsPolicyName |
string
A fully-qualified path representing ClientTlsPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromDnsThreatDetectorName(dnsThreatDetectorName)
matchProjectFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number;Parse the project from DnsThreatDetector resource.
| Parameter | |
|---|---|
| Name | Description |
dnsThreatDetectorName |
string
A fully-qualified path representing DnsThreatDetector resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromFirewallEndpointAssociationName(firewallEndpointAssociationName)
matchProjectFromFirewallEndpointAssociationName(firewallEndpointAssociationName: string): string | number;Parse the project from FirewallEndpointAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
firewallEndpointAssociationName |
string
A fully-qualified path representing FirewallEndpointAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromGatewaySecurityPolicyName(gatewaySecurityPolicyName)
matchProjectFromGatewaySecurityPolicyName(gatewaySecurityPolicyName: string): string | number;Parse the project from GatewaySecurityPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
gatewaySecurityPolicyName |
string
A fully-qualified path representing GatewaySecurityPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName)
matchProjectFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName: string): string | number;Parse the project from GatewaySecurityPolicyRule resource.
| Parameter | |
|---|---|
| Name | Description |
gatewaySecurityPolicyRuleName |
string
A fully-qualified path representing GatewaySecurityPolicyRule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromInterceptDeploymentGroupName(interceptDeploymentGroupName)
matchProjectFromInterceptDeploymentGroupName(interceptDeploymentGroupName: string): string | number;Parse the project from InterceptDeploymentGroup resource.
| Parameter | |
|---|---|
| Name | Description |
interceptDeploymentGroupName |
string
A fully-qualified path representing InterceptDeploymentGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromInterceptDeploymentName(interceptDeploymentName)
matchProjectFromInterceptDeploymentName(interceptDeploymentName: string): string | number;Parse the project from InterceptDeployment resource.
| Parameter | |
|---|---|
| Name | Description |
interceptDeploymentName |
string
A fully-qualified path representing InterceptDeployment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName)
matchProjectFromInterceptEndpointGroupAssociationName(interceptEndpointGroupAssociationName: string): string | number;Parse the project from InterceptEndpointGroupAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
interceptEndpointGroupAssociationName |
string
A fully-qualified path representing InterceptEndpointGroupAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromInterceptEndpointGroupName(interceptEndpointGroupName)
matchProjectFromInterceptEndpointGroupName(interceptEndpointGroupName: string): string | number;Parse the project from InterceptEndpointGroup resource.
| Parameter | |
|---|---|
| Name | Description |
interceptEndpointGroupName |
string
A fully-qualified path representing InterceptEndpointGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;Parse the project from Location resource.
| Parameter | |
|---|---|
| Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromMirroringDeploymentGroupName(mirroringDeploymentGroupName)
matchProjectFromMirroringDeploymentGroupName(mirroringDeploymentGroupName: string): string | number;Parse the project from MirroringDeploymentGroup resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringDeploymentGroupName |
string
A fully-qualified path representing MirroringDeploymentGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromMirroringDeploymentName(mirroringDeploymentName)
matchProjectFromMirroringDeploymentName(mirroringDeploymentName: string): string | number;Parse the project from MirroringDeployment resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringDeploymentName |
string
A fully-qualified path representing MirroringDeployment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName)
matchProjectFromMirroringEndpointGroupAssociationName(mirroringEndpointGroupAssociationName: string): string | number;Parse the project from MirroringEndpointGroupAssociation resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringEndpointGroupAssociationName |
string
A fully-qualified path representing MirroringEndpointGroupAssociation resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromMirroringEndpointGroupName(mirroringEndpointGroupName)
matchProjectFromMirroringEndpointGroupName(mirroringEndpointGroupName: string): string | number;Parse the project from MirroringEndpointGroup resource.
| Parameter | |
|---|---|
| Name | Description |
mirroringEndpointGroupName |
string
A fully-qualified path representing MirroringEndpointGroup resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationAddressGroupName(projectLocationAddressGroupName)
matchProjectFromProjectLocationAddressGroupName(projectLocationAddressGroupName: string): string | number;Parse the project from ProjectLocationAddressGroup resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationAddressGroupName |
string
A fully-qualified path representing project_location_address_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName)
matchProjectFromProjectLocationFirewallEndpointsName(projectLocationFirewallEndpointsName: string): string | number;Parse the project from ProjectLocationFirewallEndpoints resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationFirewallEndpointsName |
string
A fully-qualified path representing project_location_firewallEndpoints resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName)
matchProjectFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName: string): string | number;Parse the project from ProjectLocationSecurityProfileGroup resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationSecurityProfileGroupName |
string
A fully-qualified path representing project_location_security_profile_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName)
matchProjectFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName: string): string | number;Parse the project from ProjectLocationSecurityProfile resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationSecurityProfileName |
string
A fully-qualified path representing project_location_security_profile resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;Parse the project from Project resource.
| Parameter | |
|---|---|
| Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromSACAttachmentName(sACAttachmentName)
matchProjectFromSACAttachmentName(sACAttachmentName: string): string | number;Parse the project from SACAttachment resource.
| Parameter | |
|---|---|
| Name | Description |
sACAttachmentName |
string
A fully-qualified path representing SACAttachment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromSACRealmName(sACRealmName)
matchProjectFromSACRealmName(sACRealmName: string): string | number;Parse the project from SACRealm resource.
| Parameter | |
|---|---|
| Name | Description |
sACRealmName |
string
A fully-qualified path representing SACRealm resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromServerTlsPolicyName(serverTlsPolicyName)
matchProjectFromServerTlsPolicyName(serverTlsPolicyName: string): string | number;Parse the project from ServerTlsPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
serverTlsPolicyName |
string
A fully-qualified path representing ServerTlsPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromTlsInspectionPolicyName(tlsInspectionPolicyName)
matchProjectFromTlsInspectionPolicyName(tlsInspectionPolicyName: string): string | number;Parse the project from TlsInspectionPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
tlsInspectionPolicyName |
string
A fully-qualified path representing TlsInspectionPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromUrlListName(urlListName)
matchProjectFromUrlListName(urlListName: string): string | number;Parse the project from UrlList resource.
| Parameter | |
|---|---|
| Name | Description |
urlListName |
string
A fully-qualified path representing UrlList resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchRuleFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName)
matchRuleFromGatewaySecurityPolicyRuleName(gatewaySecurityPolicyRuleName: string): string | number;Parse the rule from GatewaySecurityPolicyRule resource.
| Parameter | |
|---|---|
| Name | Description |
gatewaySecurityPolicyRuleName |
string
A fully-qualified path representing GatewaySecurityPolicyRule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the rule. |
matchSacAttachmentFromSACAttachmentName(sACAttachmentName)
matchSacAttachmentFromSACAttachmentName(sACAttachmentName: string): string | number;Parse the sac_attachment from SACAttachment resource.
| Parameter | |
|---|---|
| Name | Description |
sACAttachmentName |
string
A fully-qualified path representing SACAttachment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the sac_attachment. |
matchSacRealmFromSACRealmName(sACRealmName)
matchSacRealmFromSACRealmName(sACRealmName: string): string | number;Parse the sac_realm from SACRealm resource.
| Parameter | |
|---|---|
| Name | Description |
sACRealmName |
string
A fully-qualified path representing SACRealm resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the sac_realm. |
matchSecurityProfileFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName)
matchSecurityProfileFromOrganizationLocationSecurityProfileName(organizationLocationSecurityProfileName: string): string | number;Parse the security_profile from OrganizationLocationSecurityProfile resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationSecurityProfileName |
string
A fully-qualified path representing organization_location_security_profile resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the security_profile. |
matchSecurityProfileFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName)
matchSecurityProfileFromProjectLocationSecurityProfileName(projectLocationSecurityProfileName: string): string | number;Parse the security_profile from ProjectLocationSecurityProfile resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationSecurityProfileName |
string
A fully-qualified path representing project_location_security_profile resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the security_profile. |
matchSecurityProfileGroupFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName)
matchSecurityProfileGroupFromOrganizationLocationSecurityProfileGroupName(organizationLocationSecurityProfileGroupName: string): string | number;Parse the security_profile_group from OrganizationLocationSecurityProfileGroup resource.
| Parameter | |
|---|---|
| Name | Description |
organizationLocationSecurityProfileGroupName |
string
A fully-qualified path representing organization_location_security_profile_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the security_profile_group. |
matchSecurityProfileGroupFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName)
matchSecurityProfileGroupFromProjectLocationSecurityProfileGroupName(projectLocationSecurityProfileGroupName: string): string | number;Parse the security_profile_group from ProjectLocationSecurityProfileGroup resource.
| Parameter | |
|---|---|
| Name | Description |
projectLocationSecurityProfileGroupName |
string
A fully-qualified path representing project_location_security_profile_group resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the security_profile_group. |
matchServerTlsPolicyFromServerTlsPolicyName(serverTlsPolicyName)
matchServerTlsPolicyFromServerTlsPolicyName(serverTlsPolicyName: string): string | number;Parse the server_tls_policy from ServerTlsPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
serverTlsPolicyName |
string
A fully-qualified path representing ServerTlsPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the server_tls_policy. |
matchTlsInspectionPolicyFromTlsInspectionPolicyName(tlsInspectionPolicyName)
matchTlsInspectionPolicyFromTlsInspectionPolicyName(tlsInspectionPolicyName: string): string | number;Parse the tls_inspection_policy from TlsInspectionPolicy resource.
| Parameter | |
|---|---|
| Name | Description |
tlsInspectionPolicyName |
string
A fully-qualified path representing TlsInspectionPolicy resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the tls_inspection_policy. |
matchUrlListFromUrlListName(urlListName)
matchUrlListFromUrlListName(urlListName: string): string | number;Parse the url_list from UrlList resource.
| Parameter | |
|---|---|
| Name | Description |
urlListName |
string
A fully-qualified path representing UrlList resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the url_list. |
mirroringDeploymentGroupPath(project, location, mirroringDeploymentGroup)
mirroringDeploymentGroupPath(project: string, location: string, mirroringDeploymentGroup: string): string;Return a fully-qualified mirroringDeploymentGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
mirroringDeploymentGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
mirroringDeploymentPath(project, location, mirroringDeployment)
mirroringDeploymentPath(project: string, location: string, mirroringDeployment: string): string;Return a fully-qualified mirroringDeployment resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
mirroringDeployment |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
mirroringEndpointGroupAssociationPath(project, location, mirroringEndpointGroupAssociation)
mirroringEndpointGroupAssociationPath(project: string, location: string, mirroringEndpointGroupAssociation: string): string;Return a fully-qualified mirroringEndpointGroupAssociation resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
mirroringEndpointGroupAssociation |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
mirroringEndpointGroupPath(project, location, mirroringEndpointGroup)
mirroringEndpointGroupPath(project: string, location: string, mirroringEndpointGroup: string): string;Return a fully-qualified mirroringEndpointGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
mirroringEndpointGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
organizationLocationAddressGroupPath(organization, location, addressGroup)
organizationLocationAddressGroupPath(organization: string, location: string, addressGroup: string): string;Return a fully-qualified organizationLocationAddressGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
addressGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
organizationLocationFirewallEndpointsPath(organization, location, firewallEndpoint)
organizationLocationFirewallEndpointsPath(organization: string, location: string, firewallEndpoint: string): string;Return a fully-qualified organizationLocationFirewallEndpoints resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
firewallEndpoint |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
organizationLocationPath(organization, location)
organizationLocationPath(organization: string, location: string): string;Return a fully-qualified organizationLocation resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
organizationLocationSecurityProfileGroupPath(organization, location, securityProfileGroup)
organizationLocationSecurityProfileGroupPath(organization: string, location: string, securityProfileGroup: string): string;Return a fully-qualified organizationLocationSecurityProfileGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
securityProfileGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
organizationLocationSecurityProfilePath(organization, location, securityProfile)
organizationLocationSecurityProfilePath(organization: string, location: string, securityProfile: string): string;Return a fully-qualified organizationLocationSecurityProfile resource name string.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
securityProfile |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
organizationPath(organization)
organizationPath(organization: string): string;Return a fully-qualified organization resource name string.
| Parameter | |
|---|---|
| Name | Description |
organization |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
projectLocationAddressGroupPath(project, location, addressGroup)
projectLocationAddressGroupPath(project: string, location: string, addressGroup: string): string;Return a fully-qualified projectLocationAddressGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
addressGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
projectLocationFirewallEndpointsPath(project, location, firewallEndpoint)
projectLocationFirewallEndpointsPath(project: string, location: string, firewallEndpoint: string): string;Return a fully-qualified projectLocationFirewallEndpoints resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
firewallEndpoint |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
projectLocationSecurityProfileGroupPath(project, location, securityProfileGroup)
projectLocationSecurityProfileGroupPath(project: string, location: string, securityProfileGroup: string): string;Return a fully-qualified projectLocationSecurityProfileGroup resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
securityProfileGroup |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
projectLocationSecurityProfilePath(project, location, securityProfile)
projectLocationSecurityProfilePath(project: string, location: string, securityProfile: string): string;Return a fully-qualified projectLocationSecurityProfile resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
securityProfile |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
projectPath(project)
projectPath(project: string): string;Return a fully-qualified project resource name string.
| Parameter | |
|---|---|
| Name | Description |
project |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
sACAttachmentPath(project, location, sacAttachment)
sACAttachmentPath(project: string, location: string, sacAttachment: string): string;Return a fully-qualified sACAttachment resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
sacAttachment |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
sACRealmPath(project, location, sacRealm)
sACRealmPath(project: string, location: string, sacRealm: string): string;Return a fully-qualified sACRealm resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
sacRealm |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
serverTlsPolicyPath(project, location, serverTlsPolicy)
serverTlsPolicyPath(project: string, location: string, serverTlsPolicy: string): string;Return a fully-qualified serverTlsPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
serverTlsPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
setIamPolicy(request, options, callback)
setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
| Parameters | |
|---|---|
| Name | Description |
request |
IamProtos.google.iam.v1.SetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
| Returns | |
|---|---|
| Type | Description |
Promise<[google.iam.v1.Policy]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
testIamPermissions(request, options, callback)
testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
| Parameters | |
|---|---|
| Name | Description |
request |
IamProtos.google.iam.v1.TestIamPermissionsRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . |
| Returns | |
|---|---|
| Type | Description |
Promise<[google.iam.v1.TestIamPermissionsResponse]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
tlsInspectionPolicyPath(project, location, tlsInspectionPolicy)
tlsInspectionPolicyPath(project: string, location: string, tlsInspectionPolicy: string): string;Return a fully-qualified tlsInspectionPolicy resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
tlsInspectionPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
updateFirewallEndpoint(request, options)
updateFirewallEndpoint(request?: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Update a single org Endpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* Endpoint resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const firewallEndpoint = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callUpdateFirewallEndpoint() {
// Construct request
const request = {
updateMask,
firewallEndpoint,
};
// Run request
const [operation] = await networksecurityClient.updateFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateFirewallEndpoint();
updateFirewallEndpoint(request, options, callback)
updateFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateFirewallEndpoint(request, callback)
updateFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointRequest
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateFirewallEndpointAssociation(request, options)
updateFirewallEndpointAssociation(request?: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointAssociationRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Update a single FirewallEndpointAssociation.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointAssociationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* Association resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const firewallEndpointAssociation = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callUpdateFirewallEndpointAssociation() {
// Construct request
const request = {
updateMask,
firewallEndpointAssociation,
};
// Run request
const [operation] = await networksecurityClient.updateFirewallEndpointAssociation(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateFirewallEndpointAssociation();
updateFirewallEndpointAssociation(request, options, callback)
updateFirewallEndpointAssociation(request: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointAssociationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointAssociationRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateFirewallEndpointAssociation(request, callback)
updateFirewallEndpointAssociation(request: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointAssociationRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointAssociationRequest
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpointAssociation, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateProjectFirewallEndpoint(request, options)
updateProjectFirewallEndpoint(request?: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Update a single project Endpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>,
protos.google.longrunning.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. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* Endpoint resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const firewallEndpoint = {}
/**
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Networksecurity library
const {FirewallActivationClient} = require('@google-cloud/network-security').v1;
// Instantiates a client
const networksecurityClient = new FirewallActivationClient();
async function callUpdateProjectFirewallEndpoint() {
// Construct request
const request = {
updateMask,
firewallEndpoint,
};
// Run request
const [operation] = await networksecurityClient.updateProjectFirewallEndpoint(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateProjectFirewallEndpoint();
updateProjectFirewallEndpoint(request, options, callback)
updateProjectFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateProjectFirewallEndpoint(request, callback)
updateProjectFirewallEndpoint(request: protos.google.cloud.networksecurity.v1.IUpdateFirewallEndpointRequest, callback: Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFirewallEndpointRequest
|
callback |
Callback<LROperation<protos.google.cloud.networksecurity.v1.IFirewallEndpoint, protos.google.cloud.networksecurity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
urlListPath(project, location, urlList)
urlListPath(project: string, location: string, urlList: string): string;Return a fully-qualified urlList resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
urlList |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |