@google-cloud/iam/build/src/v3beta/access_policies_client.d.ts

Identity and Access Management client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Manages Identity and Access Management (IAM) access policies.
 * @class
 * @memberof v3beta
 */
export declare class AccessPoliciesClient {
    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;
    };
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    accessPoliciesStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of AccessPoliciesClient.
     *
     * @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 AccessPoliciesClient({fallback: true}, gax);
     *     ```
     */
    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * Initialize the client.
     * Performs asynchronous operations (such as authentication) and prepares the client.
     * This function will be called automatically when any class method is called for the
     * first time, but if you need to initialize it before calling an actual method,
     * feel free to call initialize() directly.
     *
     * You can await on this method if you want to make sure the client is initialized.
     *
     * @returns {Promise} A promise that resolves to an authenticated service stub.
     */
    initialize(): Promise<{
        [name: string]: Function;
    }>;
    /**
     * The DNS address for this API service.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get servicePath(): string;
    /**
     * The DNS address for this API service - same as servicePath.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get apiEndpoint(): string;
    /**
     * The DNS address for this API service.
     * @returns {string} The DNS address for this service.
     */
    get apiEndpoint(): string;
    get universeDomain(): string;
    /**
     * The port for this API service.
     * @returns {number} The default port for this service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     * @returns {string[]} List of default scopes.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Gets an access policy.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the access policy to retrieve.
     *
     *   Format:
     *     `projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *     `projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}`
     *     `folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *     `organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}`
     * @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.iam.v3beta.AccessPolicy|AccessPolicy}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v3beta/access_policies.get_access_policy.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_GetAccessPolicy_async
     */
    getAccessPolicy(request?: protos.google.iam.v3beta.IGetAccessPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v3beta.IAccessPolicy,
        protos.google.iam.v3beta.IGetAccessPolicyRequest | undefined,
        {} | undefined
    ]>;
    getAccessPolicy(request: protos.google.iam.v3beta.IGetAccessPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v3beta.IAccessPolicy, protos.google.iam.v3beta.IGetAccessPolicyRequest | null | undefined, {} | null | undefined>): void;
    getAccessPolicy(request: protos.google.iam.v3beta.IGetAccessPolicyRequest, callback: Callback<protos.google.iam.v3beta.IAccessPolicy, protos.google.iam.v3beta.IGetAccessPolicyRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates an access policy, and returns a long running operation.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource where this access policy will be created.
     *
     *   Format:
     *     `projects/{project_id}/locations/{location}`
     *     `projects/{project_number}/locations/{location}`
     *     `folders/{folder_id}/locations/{location}`
     *     `organizations/{organization_id}/locations/{location}`
     * @param {string} request.accessPolicyId
     *   Required. The ID to use for the access policy, which
     *   will become the final component of the access policy's
     *   resource name.
     *
     *   This value must start with a lowercase letter followed by up to 62
     *   lowercase letters, numbers, hyphens, or dots. Pattern,
     *   /{@link protos.a-z0-9-\.|a-z}{2,62}/.
     *
     *   This value must be unique among all access policies with the same parent.
     * @param {google.iam.v3beta.AccessPolicy} request.accessPolicy
     *   Required. The access policy to create.
     * @param {boolean} [request.validateOnly]
     *   Optional. If set, validate the request and preview the creation, but do not
     *   actually post it.
     * @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 <caption>include:samples/generated/v3beta/access_policies.create_access_policy.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_CreateAccessPolicy_async
     */
    createAccessPolicy(request?: protos.google.iam.v3beta.ICreateAccessPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.iam.v3beta.IAccessPolicy, protos.google.iam.v3beta.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createAccessPolicy(request: protos.google.iam.v3beta.ICreateAccessPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v3beta.IAccessPolicy, protos.google.iam.v3beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createAccessPolicy(request: protos.google.iam.v3beta.ICreateAccessPolicyRequest, callback: Callback<LROperation<protos.google.iam.v3beta.IAccessPolicy, protos.google.iam.v3beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `createAccessPolicy()`.
     * @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 <caption>include:samples/generated/v3beta/access_policies.create_access_policy.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_CreateAccessPolicy_async
     */
    checkCreateAccessPolicyProgress(name: string): Promise<LROperation<protos.google.iam.v3beta.AccessPolicy, protos.google.iam.v3beta.OperationMetadata>>;
    /**
     * Updates an access policy.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.iam.v3beta.AccessPolicy} request.accessPolicy
     *   Required. The access policy to update.
     *
     *   The access policy's `name` field is used to identify the
     *   policy to update.
     * @param {boolean} [request.validateOnly]
     *   Optional. If set, validate the request and preview the update, but do not
     *   actually post it.
     * @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 <caption>include:samples/generated/v3beta/access_policies.update_access_policy.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_UpdateAccessPolicy_async
     */
    updateAccessPolicy(request?: protos.google.iam.v3beta.IUpdateAccessPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.iam.v3beta.IAccessPolicy, protos.google.iam.v3beta.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateAccessPolicy(request: protos.google.iam.v3beta.IUpdateAccessPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v3beta.IAccessPolicy, protos.google.iam.v3beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateAccessPolicy(request: protos.google.iam.v3beta.IUpdateAccessPolicyRequest, callback: Callback<LROperation<protos.google.iam.v3beta.IAccessPolicy, protos.google.iam.v3beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `updateAccessPolicy()`.
     * @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 <caption>include:samples/generated/v3beta/access_policies.update_access_policy.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_UpdateAccessPolicy_async
     */
    checkUpdateAccessPolicyProgress(name: string): Promise<LROperation<protos.google.iam.v3beta.AccessPolicy, protos.google.iam.v3beta.OperationMetadata>>;
    /**
     * Deletes an access policy.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the access policy to delete.
     *
     *   Format:
     *     `projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *     `projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}`
     *     `folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *     `organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}`
     * @param {string} [request.etag]
     *   Optional. The etag of the access policy. If this is provided, it must match
     *   the server's etag.
     * @param {boolean} [request.validateOnly]
     *   Optional. If set, validate the request and preview the deletion, but do not
     *   actually post it.
     * @param {boolean} [request.force]
     *   Optional. If set to true, the request will force the deletion of the Policy
     *   even if the Policy references PolicyBindings.
     * @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 <caption>include:samples/generated/v3beta/access_policies.delete_access_policy.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_DeleteAccessPolicy_async
     */
    deleteAccessPolicy(request?: protos.google.iam.v3beta.IDeleteAccessPolicyRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.iam.v3beta.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteAccessPolicy(request: protos.google.iam.v3beta.IDeleteAccessPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.iam.v3beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteAccessPolicy(request: protos.google.iam.v3beta.IDeleteAccessPolicyRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.iam.v3beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deleteAccessPolicy()`.
     * @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 <caption>include:samples/generated/v3beta/access_policies.delete_access_policy.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_DeleteAccessPolicy_async
     */
    checkDeleteAccessPolicyProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.iam.v3beta.OperationMetadata>>;
    /**
    * Lists access policies.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The parent resource, which owns the collection of access policy
    *   resources.
    *
    *   Format:
    *     `projects/{project_id}/locations/{location}`
    *     `projects/{project_number}/locations/{location}`
    *     `folders/{folder_id}/locations/{location}`
    *     `organizations/{organization_id}/locations/{location}`
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of access policies to return. The
    *   service may return fewer than this value.
    *
    *   If unspecified, at most 50 access policies will be returned. Valid value
    *   ranges from 1 to 1000; values above 1000 will be coerced to 1000.
    * @param {string} [request.pageToken]
    *   Optional. A page token, received from a previous
    *   `ListAccessPolicies` call. Provide this to retrieve the
    *   subsequent page.
    *
    *   When paginating, all other parameters provided to
    *   `ListAccessPolicies` must match the call that provided the
    *   page token.
    * @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.iam.v3beta.AccessPolicy|AccessPolicy}.
    *   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 `listAccessPoliciesAsync()`
    *   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.
    */
    listAccessPolicies(request?: protos.google.iam.v3beta.IListAccessPoliciesRequest, options?: CallOptions): Promise<[
        protos.google.iam.v3beta.IAccessPolicy[],
        protos.google.iam.v3beta.IListAccessPoliciesRequest | null,
        protos.google.iam.v3beta.IListAccessPoliciesResponse
    ]>;
    listAccessPolicies(request: protos.google.iam.v3beta.IListAccessPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.iam.v3beta.IListAccessPoliciesRequest, protos.google.iam.v3beta.IListAccessPoliciesResponse | null | undefined, protos.google.iam.v3beta.IAccessPolicy>): void;
    listAccessPolicies(request: protos.google.iam.v3beta.IListAccessPoliciesRequest, callback: PaginationCallback<protos.google.iam.v3beta.IListAccessPoliciesRequest, protos.google.iam.v3beta.IListAccessPoliciesResponse | null | undefined, protos.google.iam.v3beta.IAccessPolicy>): void;
    /**
     * Equivalent to `listAccessPolicies`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource, which owns the collection of access policy
     *   resources.
     *
     *   Format:
     *     `projects/{project_id}/locations/{location}`
     *     `projects/{project_number}/locations/{location}`
     *     `folders/{folder_id}/locations/{location}`
     *     `organizations/{organization_id}/locations/{location}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of access policies to return. The
     *   service may return fewer than this value.
     *
     *   If unspecified, at most 50 access policies will be returned. Valid value
     *   ranges from 1 to 1000; values above 1000 will be coerced to 1000.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous
     *   `ListAccessPolicies` call. Provide this to retrieve the
     *   subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   `ListAccessPolicies` must match the call that provided the
     *   page token.
     * @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.iam.v3beta.AccessPolicy|AccessPolicy} 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 `listAccessPoliciesAsync()`
     *   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.
     */
    listAccessPoliciesStream(request?: protos.google.iam.v3beta.IListAccessPoliciesRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listAccessPolicies`, 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 parent resource, which owns the collection of access policy
     *   resources.
     *
     *   Format:
     *     `projects/{project_id}/locations/{location}`
     *     `projects/{project_number}/locations/{location}`
     *     `folders/{folder_id}/locations/{location}`
     *     `organizations/{organization_id}/locations/{location}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of access policies to return. The
     *   service may return fewer than this value.
     *
     *   If unspecified, at most 50 access policies will be returned. Valid value
     *   ranges from 1 to 1000; values above 1000 will be coerced to 1000.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous
     *   `ListAccessPolicies` call. Provide this to retrieve the
     *   subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   `ListAccessPolicies` must match the call that provided the
     *   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 protos.google.iam.v3beta.AccessPolicy|AccessPolicy}. 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 <caption>include:samples/generated/v3beta/access_policies.list_access_policies.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_ListAccessPolicies_async
     */
    listAccessPoliciesAsync(request?: protos.google.iam.v3beta.IListAccessPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.iam.v3beta.IAccessPolicy>;
    /**
    * Returns all policy bindings that bind a specific policy if a user has
    * searchPolicyBindings permission on that policy.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.name
    *   Required. The name of the access policy.
    *   Format:
    *    `organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}`
    *    `folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}`
    *    `projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}`
    *    `projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}`
    * @param {number} [request.pageSize]
    *   Optional. The maximum number of policy bindings to return. The service may
    *   return fewer than this value.
    *
    *   If unspecified, at most 50 policy bindings will be returned.
    *   The maximum value is 1000; values above 1000 will be coerced to 1000.
    * @param {string} [request.pageToken]
    *   Optional. A page token, received from a previous
    *   `SearchAccessPolicyBindingsRequest` call. Provide this to
    *   retrieve the subsequent page.
    *
    *   When paginating, all other parameters provided to
    *   `SearchAccessPolicyBindingsRequest` must match the call
    *   that provided the page token.
    * @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.iam.v3beta.PolicyBinding|PolicyBinding}.
    *   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 `searchAccessPolicyBindingsAsync()`
    *   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.
    */
    searchAccessPolicyBindings(request?: protos.google.iam.v3beta.ISearchAccessPolicyBindingsRequest, options?: CallOptions): Promise<[
        protos.google.iam.v3beta.IPolicyBinding[],
        protos.google.iam.v3beta.ISearchAccessPolicyBindingsRequest | null,
        protos.google.iam.v3beta.ISearchAccessPolicyBindingsResponse
    ]>;
    searchAccessPolicyBindings(request: protos.google.iam.v3beta.ISearchAccessPolicyBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.iam.v3beta.ISearchAccessPolicyBindingsRequest, protos.google.iam.v3beta.ISearchAccessPolicyBindingsResponse | null | undefined, protos.google.iam.v3beta.IPolicyBinding>): void;
    searchAccessPolicyBindings(request: protos.google.iam.v3beta.ISearchAccessPolicyBindingsRequest, callback: PaginationCallback<protos.google.iam.v3beta.ISearchAccessPolicyBindingsRequest, protos.google.iam.v3beta.ISearchAccessPolicyBindingsResponse | null | undefined, protos.google.iam.v3beta.IPolicyBinding>): void;
    /**
     * Equivalent to `searchAccessPolicyBindings`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the access policy.
     *   Format:
     *    `organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *    `folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *    `projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *    `projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of policy bindings to return. The service may
     *   return fewer than this value.
     *
     *   If unspecified, at most 50 policy bindings will be returned.
     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous
     *   `SearchAccessPolicyBindingsRequest` call. Provide this to
     *   retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   `SearchAccessPolicyBindingsRequest` must match the call
     *   that provided the page token.
     * @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.iam.v3beta.PolicyBinding|PolicyBinding} 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 `searchAccessPolicyBindingsAsync()`
     *   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.
     */
    searchAccessPolicyBindingsStream(request?: protos.google.iam.v3beta.ISearchAccessPolicyBindingsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `searchAccessPolicyBindings`, 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.name
     *   Required. The name of the access policy.
     *   Format:
     *    `organizations/{organization_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *    `folders/{folder_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *    `projects/{project_id}/locations/{location}/accessPolicies/{access_policy_id}`
     *    `projects/{project_number}/locations/{location}/accessPolicies/{access_policy_id}`
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of policy bindings to return. The service may
     *   return fewer than this value.
     *
     *   If unspecified, at most 50 policy bindings will be returned.
     *   The maximum value is 1000; values above 1000 will be coerced to 1000.
     * @param {string} [request.pageToken]
     *   Optional. A page token, received from a previous
     *   `SearchAccessPolicyBindingsRequest` call. Provide this to
     *   retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   `SearchAccessPolicyBindingsRequest` must match the call
     *   that provided the 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 protos.google.iam.v3beta.PolicyBinding|PolicyBinding}. 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 <caption>include:samples/generated/v3beta/access_policies.search_access_policy_bindings.js</caption>
     * region_tag:iam_v3beta_generated_AccessPolicies_SearchAccessPolicyBindings_async
     */
    searchAccessPolicyBindingsAsync(request?: protos.google.iam.v3beta.ISearchAccessPolicyBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.iam.v3beta.IPolicyBinding>;
    /**
       * 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<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>;
    /**
       * 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<LocationProtos.google.cloud.location.ILocation>;
    /**
       * 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<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]>;
    /**
     * 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<protos.google.longrunning.IOperation>;
    /**
     * 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<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>;
    /**
     * 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<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>;
    /**
     * Return a fully-qualified folderLocationAccessPolicies resource name string.
     *
     * @param {string} folder
     * @param {string} location
     * @param {string} access_policy
     * @returns {string} Resource name string.
     */
    folderLocationAccessPoliciesPath(folder: string, location: string, accessPolicy: string): string;
    /**
     * Parse the folder from FolderLocationAccessPolicies resource.
     *
     * @param {string} folderLocationAccessPoliciesName
     *   A fully-qualified path representing folder_location_accessPolicies resource.
     * @returns {string} A string representing the folder.
     */
    matchFolderFromFolderLocationAccessPoliciesName(folderLocationAccessPoliciesName: string): string | number;
    /**
     * Parse the location from FolderLocationAccessPolicies resource.
     *
     * @param {string} folderLocationAccessPoliciesName
     *   A fully-qualified path representing folder_location_accessPolicies resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromFolderLocationAccessPoliciesName(folderLocationAccessPoliciesName: string): string | number;
    /**
     * Parse the access_policy from FolderLocationAccessPolicies resource.
     *
     * @param {string} folderLocationAccessPoliciesName
     *   A fully-qualified path representing folder_location_accessPolicies resource.
     * @returns {string} A string representing the access_policy.
     */
    matchAccessPolicyFromFolderLocationAccessPoliciesName(folderLocationAccessPoliciesName: string): string | number;
    /**
     * Return a fully-qualified folderLocationPolicyBindings resource name string.
     *
     * @param {string} folder
     * @param {string} location
     * @param {string} policy_binding
     * @returns {string} Resource name string.
     */
    folderLocationPolicyBindingsPath(folder: string, location: string, policyBinding: string): string;
    /**
     * Parse the folder from FolderLocationPolicyBindings resource.
     *
     * @param {string} folderLocationPolicyBindingsName
     *   A fully-qualified path representing folder_location_policyBindings resource.
     * @returns {string} A string representing the folder.
     */
    matchFolderFromFolderLocationPolicyBindingsName(folderLocationPolicyBindingsName: string): string | number;
    /**
     * Parse the location from FolderLocationPolicyBindings resource.
     *
     * @param {string} folderLocationPolicyBindingsName
     *   A fully-qualified path representing folder_location_policyBindings resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromFolderLocationPolicyBindingsName(folderLocationPolicyBindingsName: string): string | number;
    /**
     * Parse the policy_binding from FolderLocationPolicyBindings resource.
     *
     * @param {string} folderLocationPolicyBindingsName
     *   A fully-qualified path representing folder_location_policyBindings resource.
     * @returns {string} A string representing the policy_binding.
     */
    matchPolicyBindingFromFolderLocationPolicyBindingsName(folderLocationPolicyBindingsName: string): string | number;
    /**
     * Return a fully-qualified organization resource name string.
     *
     * @param {string} organization
     * @returns {string} Resource name string.
     */
    organizationPath(organization: string): string;
    /**
     * Parse the organization from Organization resource.
     *
     * @param {string} organizationName
     *   A fully-qualified path representing Organization resource.
     * @returns {string} A string representing the organization.
     */
    matchOrganizationFromOrganizationName(organizationName: string): string | number;
    /**
     * Return a fully-qualified organizationLocation resource name string.
     *
     * @param {string} organization
     * @param {string} location
     * @returns {string} Resource name string.
     */
    organizationLocationPath(organization: string, location: string): string;
    /**
     * Parse the organization from OrganizationLocation resource.
     *
     * @param {string} organizationLocationName
     *   A fully-qualified path representing OrganizationLocation resource.
     * @returns {string} A string representing the organization.
     */
    matchOrganizationFromOrganizationLocationName(organizationLocationName: string): string | number;
    /**
     * Parse the location from OrganizationLocation resource.
     *
     * @param {string} organizationLocationName
     *   A fully-qualified path representing OrganizationLocation resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromOrganizationLocationName(organizationLocationName: string): string | number;
    /**
     * Return a fully-qualified organizationLocationAccessPolicies resource name string.
     *
     * @param {string} organization
     * @param {string} location
     * @param {string} access_policy
     * @returns {string} Resource name string.
     */
    organizationLocationAccessPoliciesPath(organization: string, location: string, accessPolicy: string): string;
    /**
     * Parse the organization from OrganizationLocationAccessPolicies resource.
     *
     * @param {string} organizationLocationAccessPoliciesName
     *   A fully-qualified path representing organization_location_accessPolici