import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, IamClient, IamProtos, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Network Security API provides resources to configure authentication and * authorization policies. Refer to per API resource documentation for more * information. * @class * @memberof v1beta1 */ export declare class NetworkSecurityClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; iamClient: IamClient; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; networkSecurityStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of NetworkSecurityClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you * need to avoid loading the default gRPC version and want to use the fallback * HTTP implementation. Load only fallback version and pass it to the constructor: * ``` * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC * const client = new NetworkSecurityClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * Initialize the client. * Performs asynchronous operations (such as authentication) and prepares the client. * This function will be called automatically when any class method is called for the * first time, but if you need to initialize it before calling an actual method, * feel free to call initialize() directly. * * You can await on this method if you want to make sure the client is initialized. * * @returns {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * Gets details of a single AuthorizationPolicy. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. A name of the AuthorizationPolicy to get. Must be in the format * `projects/{project}/locations/{location}/authorizationPolicies/*`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.networksecurity.v1beta1.AuthorizationPolicy|AuthorizationPolicy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.get_authorization_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_GetAuthorizationPolicy_async */ getAuthorizationPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IGetAuthorizationPolicyRequest, options?: CallOptions): Promise<[ protos.google.cloud.networksecurity.v1beta1.IAuthorizationPolicy, (protos.google.cloud.networksecurity.v1beta1.IGetAuthorizationPolicyRequest | undefined), {} | undefined ]>; getAuthorizationPolicy(request: protos.google.cloud.networksecurity.v1beta1.IGetAuthorizationPolicyRequest, options: CallOptions, callback: Callback): void; getAuthorizationPolicy(request: protos.google.cloud.networksecurity.v1beta1.IGetAuthorizationPolicyRequest, callback: Callback): void; /** * Gets details of a single ServerTlsPolicy. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. A name of the ServerTlsPolicy to get. Must be in the format * `projects/* /locations/{location}/serverTlsPolicies/*`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.networksecurity.v1beta1.ServerTlsPolicy|ServerTlsPolicy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.get_server_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_GetServerTlsPolicy_async */ getServerTlsPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IGetServerTlsPolicyRequest, options?: CallOptions): Promise<[ protos.google.cloud.networksecurity.v1beta1.IServerTlsPolicy, (protos.google.cloud.networksecurity.v1beta1.IGetServerTlsPolicyRequest | undefined), {} | undefined ]>; getServerTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IGetServerTlsPolicyRequest, options: CallOptions, callback: Callback): void; getServerTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IGetServerTlsPolicyRequest, callback: Callback): void; /** * Gets details of a single ClientTlsPolicy. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. A name of the ClientTlsPolicy to get. Must be in the format * `projects/* /locations/{location}/clientTlsPolicies/*`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.networksecurity.v1beta1.ClientTlsPolicy|ClientTlsPolicy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.get_client_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_GetClientTlsPolicy_async */ getClientTlsPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IGetClientTlsPolicyRequest, options?: CallOptions): Promise<[ protos.google.cloud.networksecurity.v1beta1.IClientTlsPolicy, (protos.google.cloud.networksecurity.v1beta1.IGetClientTlsPolicyRequest | undefined), {} | undefined ]>; getClientTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IGetClientTlsPolicyRequest, options: CallOptions, callback: Callback): void; getClientTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IGetClientTlsPolicyRequest, callback: Callback): void; /** * Creates a new AuthorizationPolicy in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource of the AuthorizationPolicy. Must be in the * format `projects/{project}/locations/{location}`. * @param {string} request.authorizationPolicyId * Required. Short name of the AuthorizationPolicy resource to be created. * This value should be 1-63 characters long, containing only * letters, numbers, hyphens, and underscores, and should not start * with a number. E.g. "authz_policy". * @param {google.cloud.networksecurity.v1beta1.AuthorizationPolicy} request.authorizationPolicy * Required. AuthorizationPolicy resource to be created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.create_authorization_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_CreateAuthorizationPolicy_async */ createAuthorizationPolicy(request?: protos.google.cloud.networksecurity.v1beta1.ICreateAuthorizationPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createAuthorizationPolicy(request: protos.google.cloud.networksecurity.v1beta1.ICreateAuthorizationPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createAuthorizationPolicy(request: protos.google.cloud.networksecurity.v1beta1.ICreateAuthorizationPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createAuthorizationPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.create_authorization_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_CreateAuthorizationPolicy_async */ checkCreateAuthorizationPolicyProgress(name: string): Promise>; /** * Updates the parameters of a single AuthorizationPolicy. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Field mask is used to specify the fields to be overwritten in the * AuthorizationPolicy 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. * @param {google.cloud.networksecurity.v1beta1.AuthorizationPolicy} request.authorizationPolicy * Required. Updated AuthorizationPolicy resource. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.update_authorization_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_UpdateAuthorizationPolicy_async */ updateAuthorizationPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IUpdateAuthorizationPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateAuthorizationPolicy(request: protos.google.cloud.networksecurity.v1beta1.IUpdateAuthorizationPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateAuthorizationPolicy(request: protos.google.cloud.networksecurity.v1beta1.IUpdateAuthorizationPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateAuthorizationPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.update_authorization_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_UpdateAuthorizationPolicy_async */ checkUpdateAuthorizationPolicyProgress(name: string): Promise>; /** * Deletes a single AuthorizationPolicy. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. A name of the AuthorizationPolicy to delete. Must be in the * format `projects/{project}/locations/{location}/authorizationPolicies/*`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.delete_authorization_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_DeleteAuthorizationPolicy_async */ deleteAuthorizationPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IDeleteAuthorizationPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteAuthorizationPolicy(request: protos.google.cloud.networksecurity.v1beta1.IDeleteAuthorizationPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteAuthorizationPolicy(request: protos.google.cloud.networksecurity.v1beta1.IDeleteAuthorizationPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteAuthorizationPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.delete_authorization_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_DeleteAuthorizationPolicy_async */ checkDeleteAuthorizationPolicyProgress(name: string): Promise>; /** * Creates a new ServerTlsPolicy in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource of the ServerTlsPolicy. Must be in * the format `projects/* /locations/{location}`. * @param {string} request.serverTlsPolicyId * Required. Short name of the ServerTlsPolicy resource to be created. This * value should be 1-63 characters long, containing only letters, numbers, * hyphens, and underscores, and should not start with a number. E.g. * "server_mtls_policy". * @param {google.cloud.networksecurity.v1beta1.ServerTlsPolicy} request.serverTlsPolicy * Required. ServerTlsPolicy resource to be created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.create_server_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_CreateServerTlsPolicy_async */ createServerTlsPolicy(request?: protos.google.cloud.networksecurity.v1beta1.ICreateServerTlsPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createServerTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.ICreateServerTlsPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createServerTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.ICreateServerTlsPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createServerTlsPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.create_server_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_CreateServerTlsPolicy_async */ checkCreateServerTlsPolicyProgress(name: string): Promise>; /** * Updates the parameters of a single ServerTlsPolicy. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Field mask is used to specify the fields to be overwritten in the * ServerTlsPolicy 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. * @param {google.cloud.networksecurity.v1beta1.ServerTlsPolicy} request.serverTlsPolicy * Required. Updated ServerTlsPolicy resource. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.update_server_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_UpdateServerTlsPolicy_async */ updateServerTlsPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IUpdateServerTlsPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateServerTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IUpdateServerTlsPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateServerTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IUpdateServerTlsPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateServerTlsPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.update_server_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_UpdateServerTlsPolicy_async */ checkUpdateServerTlsPolicyProgress(name: string): Promise>; /** * Deletes a single ServerTlsPolicy. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. A name of the ServerTlsPolicy to delete. Must be in * the format `projects/* /locations/{location}/serverTlsPolicies/*`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.delete_server_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_DeleteServerTlsPolicy_async */ deleteServerTlsPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IDeleteServerTlsPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteServerTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IDeleteServerTlsPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteServerTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IDeleteServerTlsPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteServerTlsPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.delete_server_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_DeleteServerTlsPolicy_async */ checkDeleteServerTlsPolicyProgress(name: string): Promise>; /** * Creates a new ClientTlsPolicy in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource of the ClientTlsPolicy. Must be in * the format `projects/* /locations/{location}`. * @param {string} request.clientTlsPolicyId * Required. Short name of the ClientTlsPolicy resource to be created. This * value should be 1-63 characters long, containing only letters, numbers, * hyphens, and underscores, and should not start with a number. E.g. * "client_mtls_policy". * @param {google.cloud.networksecurity.v1beta1.ClientTlsPolicy} request.clientTlsPolicy * Required. ClientTlsPolicy resource to be created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.create_client_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_CreateClientTlsPolicy_async */ createClientTlsPolicy(request?: protos.google.cloud.networksecurity.v1beta1.ICreateClientTlsPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createClientTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.ICreateClientTlsPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createClientTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.ICreateClientTlsPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createClientTlsPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.create_client_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_CreateClientTlsPolicy_async */ checkCreateClientTlsPolicyProgress(name: string): Promise>; /** * Updates the parameters of a single ClientTlsPolicy. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Field mask is used to specify the fields to be overwritten in the * ClientTlsPolicy 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. * @param {google.cloud.networksecurity.v1beta1.ClientTlsPolicy} request.clientTlsPolicy * Required. Updated ClientTlsPolicy resource. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.update_client_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_UpdateClientTlsPolicy_async */ updateClientTlsPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IUpdateClientTlsPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateClientTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IUpdateClientTlsPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateClientTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IUpdateClientTlsPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateClientTlsPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.update_client_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_UpdateClientTlsPolicy_async */ checkUpdateClientTlsPolicyProgress(name: string): Promise>; /** * Deletes a single ClientTlsPolicy. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. A name of the ClientTlsPolicy to delete. Must be in * the format `projects/* /locations/{location}/clientTlsPolicies/*`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.delete_client_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_DeleteClientTlsPolicy_async */ deleteClientTlsPolicy(request?: protos.google.cloud.networksecurity.v1beta1.IDeleteClientTlsPolicyRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteClientTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IDeleteClientTlsPolicyRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteClientTlsPolicy(request: protos.google.cloud.networksecurity.v1beta1.IDeleteClientTlsPolicyRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteClientTlsPolicy()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.delete_client_tls_policy.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_DeleteClientTlsPolicy_async */ checkDeleteClientTlsPolicyProgress(name: string): Promise>; /** * Lists AuthorizationPolicies in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the AuthorizationPolicies * should be listed, specified in the format * `projects/{project}/locations/{location}`. * @param {number} request.pageSize * Maximum number of AuthorizationPolicies to return per call. * @param {string} request.pageToken * The value returned by the last * `ListAuthorizationPoliciesResponse` Indicates that this is a * continuation of a prior `ListAuthorizationPolicies` call, and * that the system should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.networksecurity.v1beta1.AuthorizationPolicy|AuthorizationPolicy}. * 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 `listAuthorizationPoliciesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAuthorizationPolicies(request?: protos.google.cloud.networksecurity.v1beta1.IListAuthorizationPoliciesRequest, options?: CallOptions): Promise<[ protos.google.cloud.networksecurity.v1beta1.IAuthorizationPolicy[], protos.google.cloud.networksecurity.v1beta1.IListAuthorizationPoliciesRequest | null, protos.google.cloud.networksecurity.v1beta1.IListAuthorizationPoliciesResponse ]>; listAuthorizationPolicies(request: protos.google.cloud.networksecurity.v1beta1.IListAuthorizationPoliciesRequest, options: CallOptions, callback: PaginationCallback): void; listAuthorizationPolicies(request: protos.google.cloud.networksecurity.v1beta1.IListAuthorizationPoliciesRequest, callback: PaginationCallback): void; /** * Equivalent to `listAuthorizationPolicies`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the AuthorizationPolicies * should be listed, specified in the format * `projects/{project}/locations/{location}`. * @param {number} request.pageSize * Maximum number of AuthorizationPolicies to return per call. * @param {string} request.pageToken * The value returned by the last * `ListAuthorizationPoliciesResponse` Indicates that this is a * continuation of a prior `ListAuthorizationPolicies` call, and * that the system should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.networksecurity.v1beta1.AuthorizationPolicy|AuthorizationPolicy} 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 `listAuthorizationPoliciesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAuthorizationPoliciesStream(request?: protos.google.cloud.networksecurity.v1beta1.IListAuthorizationPoliciesRequest, options?: CallOptions): Transform; /** * Equivalent to `listAuthorizationPolicies`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the AuthorizationPolicies * should be listed, specified in the format * `projects/{project}/locations/{location}`. * @param {number} request.pageSize * Maximum number of AuthorizationPolicies to return per call. * @param {string} request.pageToken * The value returned by the last * `ListAuthorizationPoliciesResponse` Indicates that this is a * continuation of a prior `ListAuthorizationPolicies` call, and * that the system should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.networksecurity.v1beta1.AuthorizationPolicy|AuthorizationPolicy}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.list_authorization_policies.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_ListAuthorizationPolicies_async */ listAuthorizationPoliciesAsync(request?: protos.google.cloud.networksecurity.v1beta1.IListAuthorizationPoliciesRequest, options?: CallOptions): AsyncIterable; /** * Lists ServerTlsPolicies in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the ServerTlsPolicies should * be listed, specified in the format `projects/* /locations/{location}`. * @param {number} request.pageSize * Maximum number of ServerTlsPolicies to return per call. * @param {string} request.pageToken * The value returned by the last `ListServerTlsPoliciesResponse` * Indicates that this is a continuation of a prior * `ListServerTlsPolicies` call, and that the system * should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.networksecurity.v1beta1.ServerTlsPolicy|ServerTlsPolicy}. * 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 `listServerTlsPoliciesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServerTlsPolicies(request?: protos.google.cloud.networksecurity.v1beta1.IListServerTlsPoliciesRequest, options?: CallOptions): Promise<[ protos.google.cloud.networksecurity.v1beta1.IServerTlsPolicy[], protos.google.cloud.networksecurity.v1beta1.IListServerTlsPoliciesRequest | null, protos.google.cloud.networksecurity.v1beta1.IListServerTlsPoliciesResponse ]>; listServerTlsPolicies(request: protos.google.cloud.networksecurity.v1beta1.IListServerTlsPoliciesRequest, options: CallOptions, callback: PaginationCallback): void; listServerTlsPolicies(request: protos.google.cloud.networksecurity.v1beta1.IListServerTlsPoliciesRequest, callback: PaginationCallback): void; /** * Equivalent to `listServerTlsPolicies`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the ServerTlsPolicies should * be listed, specified in the format `projects/* /locations/{location}`. * @param {number} request.pageSize * Maximum number of ServerTlsPolicies to return per call. * @param {string} request.pageToken * The value returned by the last `ListServerTlsPoliciesResponse` * Indicates that this is a continuation of a prior * `ListServerTlsPolicies` call, and that the system * should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.networksecurity.v1beta1.ServerTlsPolicy|ServerTlsPolicy} 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 `listServerTlsPoliciesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listServerTlsPoliciesStream(request?: protos.google.cloud.networksecurity.v1beta1.IListServerTlsPoliciesRequest, options?: CallOptions): Transform; /** * Equivalent to `listServerTlsPolicies`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the ServerTlsPolicies should * be listed, specified in the format `projects/* /locations/{location}`. * @param {number} request.pageSize * Maximum number of ServerTlsPolicies to return per call. * @param {string} request.pageToken * The value returned by the last `ListServerTlsPoliciesResponse` * Indicates that this is a continuation of a prior * `ListServerTlsPolicies` call, and that the system * should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.networksecurity.v1beta1.ServerTlsPolicy|ServerTlsPolicy}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.list_server_tls_policies.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_ListServerTlsPolicies_async */ listServerTlsPoliciesAsync(request?: protos.google.cloud.networksecurity.v1beta1.IListServerTlsPoliciesRequest, options?: CallOptions): AsyncIterable; /** * Lists ClientTlsPolicies in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the ClientTlsPolicies should * be listed, specified in the format `projects/* /locations/{location}`. * @param {number} request.pageSize * Maximum number of ClientTlsPolicies to return per call. * @param {string} request.pageToken * The value returned by the last `ListClientTlsPoliciesResponse` * Indicates that this is a continuation of a prior * `ListClientTlsPolicies` call, and that the system * should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.networksecurity.v1beta1.ClientTlsPolicy|ClientTlsPolicy}. * 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 `listClientTlsPoliciesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClientTlsPolicies(request?: protos.google.cloud.networksecurity.v1beta1.IListClientTlsPoliciesRequest, options?: CallOptions): Promise<[ protos.google.cloud.networksecurity.v1beta1.IClientTlsPolicy[], protos.google.cloud.networksecurity.v1beta1.IListClientTlsPoliciesRequest | null, protos.google.cloud.networksecurity.v1beta1.IListClientTlsPoliciesResponse ]>; listClientTlsPolicies(request: protos.google.cloud.networksecurity.v1beta1.IListClientTlsPoliciesRequest, options: CallOptions, callback: PaginationCallback): void; listClientTlsPolicies(request: protos.google.cloud.networksecurity.v1beta1.IListClientTlsPoliciesRequest, callback: PaginationCallback): void; /** * Equivalent to `listClientTlsPolicies`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the ClientTlsPolicies should * be listed, specified in the format `projects/* /locations/{location}`. * @param {number} request.pageSize * Maximum number of ClientTlsPolicies to return per call. * @param {string} request.pageToken * The value returned by the last `ListClientTlsPoliciesResponse` * Indicates that this is a continuation of a prior * `ListClientTlsPolicies` call, and that the system * should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.networksecurity.v1beta1.ClientTlsPolicy|ClientTlsPolicy} 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 `listClientTlsPoliciesAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listClientTlsPoliciesStream(request?: protos.google.cloud.networksecurity.v1beta1.IListClientTlsPoliciesRequest, options?: CallOptions): Transform; /** * Equivalent to `listClientTlsPolicies`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project and location from which the ClientTlsPolicies should * be listed, specified in the format `projects/* /locations/{location}`. * @param {number} request.pageSize * Maximum number of ClientTlsPolicies to return per call. * @param {string} request.pageToken * The value returned by the last `ListClientTlsPoliciesResponse` * Indicates that this is a continuation of a prior * `ListClientTlsPolicies` call, and that the system * should return the next page of data. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.networksecurity.v1beta1.ClientTlsPolicy|ClientTlsPolicy}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/network_security.list_client_tls_policies.js * region_tag:networksecurity_v1beta1_generated_NetworkSecurity_ListClientTlsPolicies_async */ listClientTlsPoliciesAsync(request?: protos.google.cloud.networksecurity.v1beta1.IListClientTlsPoliciesRequest, options?: CallOptions): AsyncIterable; /** * Gets the access control policy for a resource. Returns an empty policy * if the resource exists and does not have a policy set. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {Object} [request.options] * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. This field is only used by Cloud IAM. * * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. * The promise has a method named "cancel" which cancels the ongoing API call. */ getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback, callback?: Callback): 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. */ setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback, callback?: Callback): 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. * */ testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>; /** * Gets information about a location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Resource name for the location. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` * const [response] = await client.getLocation(request); * ``` */ getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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. * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource that owns the locations collection, if applicable. * @param {string} request.filter * The standard list filter. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` * const iterable = client.listLocationsAsync(request); * for await (const response of iterable) { * // process response * } * ``` */ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error, ?Object)=} callback * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * @return {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * The promise has a method named "cancel" which cancels the ongoing API call. * * @example * ``` * const client = longrunning.operationsClient(); * const name = ''; * const [response] = await client.getOperation({name}); * // doThingsWith(response) * ``` */ getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise<[protos.google.longrunning.Operation]>; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation collection. * @param {string} request.filter - The standard list filter. * @param {number=} request.pageSize - * The maximum number of resources contained in the underlying API * response. If page streaming is performed per-resource, this * parameter does not affect the return value. If page streaming is * performed per-page, this determines the maximum number of * resources in a page. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @returns {Object} * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}. * * @example * ``` * const client = longrunning.operationsClient(); * for await (const response of client.listOperationsAsync(request)); * // doThingsWith(response) * ``` */ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable; /** * 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 * {@link Operations.GetOperation} 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 {@link Operation.error} value with a {@link google.rpc.Status.code} of * 1, corresponding to `Code.CANCELLED`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be cancelled. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.cancelOperation({name: ''}); * ``` */ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be deleted. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.deleteOperation({name: ''}); * ``` */ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * Return a fully-qualified authorizationPolicy resource name string. * * @param {string} project * @param {string} location * @param {string} authorization_policy * @returns {string} Resource name string. */ authorizationPolicyPath(project: string, location: string, authorizationPolicy: string): string; /** * Parse the project from AuthorizationPolicy resource. * * @param {string} authorizationPolicyName * A fully-qualified path representing AuthorizationPolicy resource. * @returns {string} A string representing the project. */ matchProjectFromAuthorizationPolicyName(authorizationPolicyName: string): string | number; /** * Parse the location from AuthorizationPolicy resource. * * @param {string} authorizationPolicyName * A fully-qualified path representing AuthorizationPolicy resource. * @returns {string} A string representing the location. */ matchLocationFromAuthorizationPolicyName(authorizationPolicyName: string): string | number; /** * Parse the authorization_policy from AuthorizationPolicy resource. * * @param {string} authorizationPolicyName * A fully-qualified path representing AuthorizationPolicy resource. * @returns {string} A string representing the authorization_policy. */ matchAuthorizationPolicyFromAuthorizationPolicyName(authorizationPolicyName: string): string | number; /** * Return a fully-qualified clientTlsPolicy resource name string. * * @param {string} project * @param {string} location * @param {string} client_tls_policy * @returns {string} Resource name string. */ clientTlsPolicyPath(project: string, location: string, clientTlsPolicy: string): string; /** * Parse the project from ClientTlsPolicy resource. * * @param {string} clientTlsPolicyName * A fully-qualified path representing ClientTlsPolicy resource. * @returns {string} A string representing the project. */ matchProjectFromClientTlsPolicyName(clientTlsPolicyName: string): string | number; /** * Parse the location from ClientTlsPolicy resource. * * @param {string} clientTlsPolicyName * A fully-qualified path representing ClientTlsPolicy resource. * @returns {string} A string representing the location. */ matchLocationFromClientTlsPolicyName(clientTlsPolicyName: string): string | number; /** * Parse the client_tls_policy from ClientTlsPolicy resource. * * @param {string} clientTlsPolicyName * A fully-qualified path representing ClientTlsPolicy resource. * @returns {string} A string representing the client_tls_policy. */ matchClientTlsPolicyFromClientTlsPolicyName(clientTlsPolicyName: string): string | number; /** * Return a fully-qualified dnsThreatDetector resource name string. * * @param {string} project * @param {string} location * @param {string} dns_threat_detector * @returns {string} Resource name string. */ dnsThreatDetectorPath(project: string, location: string, dnsThreatDetector: string): string; /** * Parse the project from DnsThreatDetector resource. * * @param {string} dnsThreatDetectorName * A fully-qualified path representing DnsThreatDetector resource. * @returns {string} A string representing the project. */ matchProjectFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number; /** * Parse the location from DnsThreatDetector resource. * * @param {string} dnsThreatDetectorName * A fully-qualified path representing DnsThreatDetector resource. * @returns {string} A string representing the location. */ matchLocationFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number; /** * Parse the dns_threat_detector from DnsThreatDetector resource. * * @param {string} dnsThreatDetectorName * A fully-qualified path representing DnsThreatDetector resource. * @returns {string} A string representing the dns_threat_detector. */ matchDnsThreatDetectorFromDnsThreatDetectorName(dnsThreatDetectorName: string): string | number; /** * Return a fully-qualified serverTlsPolicy resource name string. * * @param {string} project * @param {string} location * @param {string} server_tls_policy * @returns {string} Resource name string. */ serverTlsPolicyPath(project: string, location: string, serverTlsPolicy: string): string; /** * Parse the project from ServerTlsPolicy resource. * * @param {string} serverTlsPolicyName * A fully-qualified path representing ServerTlsPolicy resource. * @returns {string} A string representing the project. */ matchProjectFromServerTlsPolicyName(serverTlsPolicyName: string): string | number; /** * Parse the location from ServerTlsPolicy resource. * * @param {string} serverTlsPolicyName * A fully-qualified path representing ServerTlsPolicy resource. * @returns {string} A string representing the location. */ matchLocationFromServerTlsPolicyName(serverTlsPolicyName: string): string | number; /** * Parse the server_tls_policy from ServerTlsPolicy resource. * * @param {string} serverTlsPolicyName * A fully-qualified path representing ServerTlsPolicy resource. * @returns {string} A string representing the server_tls_policy. */ matchServerTlsPolicyFromServerTlsPolicyName(serverTlsPolicyName: string): string | number; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }