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'; /** * An interface for managing Identity and Access Management (IAM) policy * bindings. * @class * @memberof v3 */ export declare class PolicyBindingsClient { 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; policyBindingsStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of PolicyBindingsClient. * * @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 PolicyBindingsClient({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 a policy binding. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the policy binding to retrieve. * * Format: * * * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_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.v3.PolicyBinding|PolicyBinding}. * 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/v3/policy_bindings.get_policy_binding.js * region_tag:iam_v3_generated_PolicyBindings_GetPolicyBinding_async */ getPolicyBinding(request?: protos.google.iam.v3.IGetPolicyBindingRequest, options?: CallOptions): Promise<[ protos.google.iam.v3.IPolicyBinding, protos.google.iam.v3.IGetPolicyBindingRequest | undefined, {} | undefined ]>; getPolicyBinding(request: protos.google.iam.v3.IGetPolicyBindingRequest, options: CallOptions, callback: Callback): void; getPolicyBinding(request: protos.google.iam.v3.IGetPolicyBindingRequest, callback: Callback): void; /** * Creates a policy binding and returns a long-running operation. * Callers will need the IAM permissions on both the policy and target. * After the binding is created, the policy is applied to the target. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource where this policy binding will be created. * The binding parent is the closest Resource Manager resource (project, * folder or organization) to the binding target. * * Format: * * * `projects/{project_id}/locations/{location}` * * `projects/{project_number}/locations/{location}` * * `folders/{folder_id}/locations/{location}` * * `organizations/{organization_id}/locations/{location}` * @param {string} request.policyBindingId * Required. The ID to use for the policy binding, which will become the final * component of the policy binding'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}/. * @param {google.iam.v3.PolicyBinding} request.policyBinding * Required. The policy binding 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 include:samples/generated/v3/policy_bindings.create_policy_binding.js * region_tag:iam_v3_generated_PolicyBindings_CreatePolicyBinding_async */ createPolicyBinding(request?: protos.google.iam.v3.ICreatePolicyBindingRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createPolicyBinding(request: protos.google.iam.v3.ICreatePolicyBindingRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createPolicyBinding(request: protos.google.iam.v3.ICreatePolicyBindingRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createPolicyBinding()`. * @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/v3/policy_bindings.create_policy_binding.js * region_tag:iam_v3_generated_PolicyBindings_CreatePolicyBinding_async */ checkCreatePolicyBindingProgress(name: string): Promise>; /** * Updates a policy binding and returns a long-running operation. * Callers will need the IAM permissions on the policy and target in the * binding to update. Target and policy are immutable and cannot be updated. * * @param {Object} request * The request object that will be sent. * @param {google.iam.v3.PolicyBinding} request.policyBinding * Required. The policy binding to update. * * The policy binding's `name` field is used to identify the policy binding to * update. * @param {boolean} [request.validateOnly] * Optional. If set, validate the request and preview the update, but do not * actually post it. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. The list of fields to update * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. 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/v3/policy_bindings.update_policy_binding.js * region_tag:iam_v3_generated_PolicyBindings_UpdatePolicyBinding_async */ updatePolicyBinding(request?: protos.google.iam.v3.IUpdatePolicyBindingRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updatePolicyBinding(request: protos.google.iam.v3.IUpdatePolicyBindingRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updatePolicyBinding(request: protos.google.iam.v3.IUpdatePolicyBindingRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updatePolicyBinding()`. * @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/v3/policy_bindings.update_policy_binding.js * region_tag:iam_v3_generated_PolicyBindings_UpdatePolicyBinding_async */ checkUpdatePolicyBindingProgress(name: string): Promise>; /** * Deletes a policy binding and returns a long-running operation. * Callers will need the IAM permissions on both the policy and target. * After the binding is deleted, the policy no longer applies to the target. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the policy binding to delete. * * Format: * * * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}` * @param {string} [request.etag] * Optional. The etag of the policy binding. * 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 {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/v3/policy_bindings.delete_policy_binding.js * region_tag:iam_v3_generated_PolicyBindings_DeletePolicyBinding_async */ deletePolicyBinding(request?: protos.google.iam.v3.IDeletePolicyBindingRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deletePolicyBinding(request: protos.google.iam.v3.IDeletePolicyBindingRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deletePolicyBinding(request: protos.google.iam.v3.IDeletePolicyBindingRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deletePolicyBinding()`. * @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/v3/policy_bindings.delete_policy_binding.js * region_tag:iam_v3_generated_PolicyBindings_DeletePolicyBinding_async */ checkDeletePolicyBindingProgress(name: string): Promise>; /** * Lists policy bindings. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource, which owns the collection of policy * bindings. * * 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 policy bindings to return. The service may * return fewer than this value. * * The default value is 50. The maximum value is 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListPolicyBindings` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListPolicyBindings` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. An expression for filtering the results of the request. Filter * rules are case insensitive. Some eligible fields for filtering are the * following: * * + `target` * + `policy` * * Some examples of filter queries: * * * `target:ex*`: The binding target's name starts with "ex". * * `target:example`: The binding target's name is `example`. * * `policy:example`: The binding policy's name is `example`. * @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.v3.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 `listPolicyBindingsAsync()` * 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. */ listPolicyBindings(request?: protos.google.iam.v3.IListPolicyBindingsRequest, options?: CallOptions): Promise<[ protos.google.iam.v3.IPolicyBinding[], protos.google.iam.v3.IListPolicyBindingsRequest | null, protos.google.iam.v3.IListPolicyBindingsResponse ]>; listPolicyBindings(request: protos.google.iam.v3.IListPolicyBindingsRequest, options: CallOptions, callback: PaginationCallback): void; listPolicyBindings(request: protos.google.iam.v3.IListPolicyBindingsRequest, callback: PaginationCallback): void; /** * Equivalent to `listPolicyBindings`, 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 policy * bindings. * * 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 policy bindings to return. The service may * return fewer than this value. * * The default value is 50. The maximum value is 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListPolicyBindings` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListPolicyBindings` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. An expression for filtering the results of the request. Filter * rules are case insensitive. Some eligible fields for filtering are the * following: * * + `target` * + `policy` * * Some examples of filter queries: * * * `target:ex*`: The binding target's name starts with "ex". * * `target:example`: The binding target's name is `example`. * * `policy:example`: The binding policy's name is `example`. * @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.v3.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 `listPolicyBindingsAsync()` * 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. */ listPolicyBindingsStream(request?: protos.google.iam.v3.IListPolicyBindingsRequest, options?: CallOptions): Transform; /** * Equivalent to `listPolicyBindings`, 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 policy * bindings. * * 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 policy bindings to return. The service may * return fewer than this value. * * The default value is 50. The maximum value is 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListPolicyBindings` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListPolicyBindings` must * match the call that provided the page token. * @param {string} [request.filter] * Optional. An expression for filtering the results of the request. Filter * rules are case insensitive. Some eligible fields for filtering are the * following: * * + `target` * + `policy` * * Some examples of filter queries: * * * `target:ex*`: The binding target's name starts with "ex". * * `target:example`: The binding target's name is `example`. * * `policy:example`: The binding policy's name is `example`. * @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.v3.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 include:samples/generated/v3/policy_bindings.list_policy_bindings.js * region_tag:iam_v3_generated_PolicyBindings_ListPolicyBindings_async */ listPolicyBindingsAsync(request?: protos.google.iam.v3.IListPolicyBindingsRequest, options?: CallOptions): AsyncIterable; /** * Search policy bindings by target. Returns all policy binding objects bound * directly to target. * * @param {Object} request * The request object that will be sent. * @param {string} request.target * Required. The target resource, which is bound to the policy in the binding. * * Format: * * * `//iam.googleapis.com/locations/global/workforcePools/POOL_ID` * * `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID` * * `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * * `//cloudresourcemanager.googleapis.com/projects/{project_number}` * * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}` * @param {number} [request.pageSize] * Optional. The maximum number of policy bindings to return. The service may * return fewer than this value. * * The default value is 50. The maximum value is 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchTargetPolicyBindingsRequest` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `SearchTargetPolicyBindingsRequest` must match the call that provided the * page token. * @param {string} request.parent * Required. The parent resource where this search will be performed. This * should be the nearest Resource Manager resource (project, folder, or * organization) to the target. * * Format: * * * `projects/{project_id}/locations/{location}` * * `projects/{project_number}/locations/{location}` * * `folders/{folder_id}/locations/{location}` * * `organizations/{organization_id}/locations/{location}` * @param {string} [request.filter] * Optional. Filtering currently only supports the kind of policies to return, * and must be in the format "policy_kind={policy_kind}". * * If String is empty, bindings bound to all kinds of policies would be * returned. * * The only supported values are the following: * * * "policy_kind=PRINCIPAL_ACCESS_BOUNDARY", * * "policy_kind=ACCESS" * @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.v3.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 `searchTargetPolicyBindingsAsync()` * 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. */ searchTargetPolicyBindings(request?: protos.google.iam.v3.ISearchTargetPolicyBindingsRequest, options?: CallOptions): Promise<[ protos.google.iam.v3.IPolicyBinding[], protos.google.iam.v3.ISearchTargetPolicyBindingsRequest | null, protos.google.iam.v3.ISearchTargetPolicyBindingsResponse ]>; searchTargetPolicyBindings(request: protos.google.iam.v3.ISearchTargetPolicyBindingsRequest, options: CallOptions, callback: PaginationCallback): void; searchTargetPolicyBindings(request: protos.google.iam.v3.ISearchTargetPolicyBindingsRequest, callback: PaginationCallback): void; /** * Equivalent to `searchTargetPolicyBindings`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.target * Required. The target resource, which is bound to the policy in the binding. * * Format: * * * `//iam.googleapis.com/locations/global/workforcePools/POOL_ID` * * `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID` * * `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * * `//cloudresourcemanager.googleapis.com/projects/{project_number}` * * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}` * @param {number} [request.pageSize] * Optional. The maximum number of policy bindings to return. The service may * return fewer than this value. * * The default value is 50. The maximum value is 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchTargetPolicyBindingsRequest` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `SearchTargetPolicyBindingsRequest` must match the call that provided the * page token. * @param {string} request.parent * Required. The parent resource where this search will be performed. This * should be the nearest Resource Manager resource (project, folder, or * organization) to the target. * * Format: * * * `projects/{project_id}/locations/{location}` * * `projects/{project_number}/locations/{location}` * * `folders/{folder_id}/locations/{location}` * * `organizations/{organization_id}/locations/{location}` * @param {string} [request.filter] * Optional. Filtering currently only supports the kind of policies to return, * and must be in the format "policy_kind={policy_kind}". * * If String is empty, bindings bound to all kinds of policies would be * returned. * * The only supported values are the following: * * * "policy_kind=PRINCIPAL_ACCESS_BOUNDARY", * * "policy_kind=ACCESS" * @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.v3.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 `searchTargetPolicyBindingsAsync()` * 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. */ searchTargetPolicyBindingsStream(request?: protos.google.iam.v3.ISearchTargetPolicyBindingsRequest, options?: CallOptions): Transform; /** * Equivalent to `searchTargetPolicyBindings`, 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.target * Required. The target resource, which is bound to the policy in the binding. * * Format: * * * `//iam.googleapis.com/locations/global/workforcePools/POOL_ID` * * `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID` * * `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * * `//cloudresourcemanager.googleapis.com/projects/{project_number}` * * `//cloudresourcemanager.googleapis.com/folders/{folder_id}` * * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}` * @param {number} [request.pageSize] * Optional. The maximum number of policy bindings to return. The service may * return fewer than this value. * * The default value is 50. The maximum value is 1000. * @param {string} [request.pageToken] * Optional. A page token, received from a previous * `SearchTargetPolicyBindingsRequest` call. Provide this to retrieve the * subsequent page. * * When paginating, all other parameters provided to * `SearchTargetPolicyBindingsRequest` must match the call that provided the * page token. * @param {string} request.parent * Required. The parent resource where this search will be performed. This * should be the nearest Resource Manager resource (project, folder, or * organization) to the target. * * Format: * * * `projects/{project_id}/locations/{location}` * * `projects/{project_number}/locations/{location}` * * `folders/{folder_id}/locations/{location}` * * `organizations/{organization_id}/locations/{location}` * @param {string} [request.filter] * Optional. Filtering currently only supports the kind of policies to return, * and must be in the format "policy_kind={policy_kind}". * * If String is empty, bindings bound to all kinds of policies would be * returned. * * The only supported values are the following: * * * "policy_kind=PRINCIPAL_ACCESS_BOUNDARY", * * "policy_kind=ACCESS" * @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.v3.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 include:samples/generated/v3/policy_bindings.search_target_policy_bindings.js * region_tag:iam_v3_generated_PolicyBindings_SearchTargetPolicyBindings_async */ searchTargetPolicyBindingsAsync(request?: protos.google.iam.v3.ISearchTargetPolicyBindingsRequest, options?: CallOptions): AsyncIterable; /** * 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 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_accessPolicies resource. * @returns {string} A string representing the organization. */ matchOrganizationFromOrganizationLocationAccessPoliciesName(organizationLocationAccessPoliciesName: string): string | number; /** * Parse the location from OrganizationLocationAccessPolicies resource. * * @param {string} organizationLocationAccessPoliciesName * A fully-qualified path representing organization_location_accessPolicies resource. * @returns {string} A string representing the location. */ matchLocationFromOrganizationLocationAccessPoliciesName(organizationLocationAccessPoliciesName: string): string | number; /** * Parse the access_policy from OrganizationLocationAccessPolicies resource. * * @param {string} organizationLocationAccessPoliciesName * A fully-qualified path representing organization_location_accessPolicies resource. * @returns {string} A string representing the access_policy. */ matchAccessPolicyFromOrganizationLocationAccessPoliciesName(organizationLocationAccessPoliciesName: string): string | number; /** * Return a fully-qualified organizationLocationPolicyBindings resource name string. * * @param {string} organization * @param {string} location * @param {string} policy_binding * @returns {string} Resource name string. */ organizationLocationPolicyBindingsPath(organization: string, location: string, policyBinding: string): string; /** * Parse the organization from OrganizationLocationPolicyBindings resource. * * @param {string} organizationLocationPolicyBindingsName * A fully-qualified path representing organization_location_policyBindings resource. * @returns {string} A string representing the organization. */ matchOrganizationFromOrganizationLocationPolicyBindingsName(organizationLocationPolicyBindingsName: string): string | number; /** * Parse the location from OrganizationLocationPolicyBindings resource. * * @param {string} organizationLocationPolicyBindingsName * A fully-qualified path representing organization_location_policyBindings resource. * @returns {string} A string representing the location. */ matchLocationFromOrganizationLocationPolicyBindingsName(organizationLocationPolicyBindingsName: string): string | number; /** * Parse the policy_binding from OrganizationLocationPolicyBindings resource. * * @param {string} organizationLocationPolicyBindingsName * A fully-qualified path representing organization_location_policyBindings resource. * @returns {string} A string representing the policy_binding. */ matchPolicyBindingFromOrganizationLocationPolicyBindingsName(organizationLocationPolicyBindingsName: string): string | number; /** * Return a fully-qualified principalAccessBoundaryPolicy resource name string. * * @param {string} organization * @param {string} location * @param {string} principal_access_boundary_policy * @returns {string} Resource name string. */ principalAccessBoundaryPolicyPath(organization: string, location: string, principalAccessBoundaryPolicy: string): string; /** * Parse the organization from PrincipalAccessBoundaryPolicy resource. * * @param {string} principalAccessBoundaryPolicyName * A fully-qualified path representing PrincipalAccessBoundaryPolicy resource. * @returns {string} A string representing the organization. */ matchOrganizationFromPrincipalAccessBoundaryPolicyName(principalAccessBoundaryPolicyName: string): string | number; /** * Parse the location from PrincipalAccessBoundaryPolicy resource. * * @param {string} principalAccessBoundaryPolicyName * A fully-qualified path representing PrincipalAccessBoundaryPolicy resource. * @returns {string} A string representing the location. */ matchLocationFromPrincipalAccessBoundaryPolicyName(principalAccessBoundaryPolicyName: string): string | number; /** * Parse the principal_access_boundary_policy from PrincipalAccessBoundaryPolicy resource. * * @param {string} principalAccessBoundaryPolicyName * A fully-qualified path representing PrincipalAccessBoundaryPolicy resource. * @returns {string} A string representing the principal_access_boundary_policy. */ matchPrincipalAccessBoundaryPolicyFromPrincipalAccessBoundaryPolicyName(principalAccessBoundaryPolicyName: string): string | number; /** * Return a fully-qualified projectLocationAccessPolicies resource name string. * * @param {string} project * @param {string} location * @param {string} access_policy * @returns {string} Resource name string. */ projectLocationAccessPoliciesPath(project: string, location: string, accessPolicy: string): string; /** * Parse the project from ProjectLocationAccessPolicies resource. * * @param {string} projectLocationAccessPoliciesName * A fully-qualified path representing project_location_accessPolicies resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationAccessPoliciesName(projectLocationAccessPoliciesName: string): string | number; /** * Parse the location from ProjectLocationAccessPolicies resource. * * @param {string} projectLocationAccessPoliciesName * A fully-qualified path representing project_location_accessPolicies resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationAccessPoliciesName(projectLocationAccessPoliciesName: string): string | number; /** * Parse the access_policy from ProjectLocationAccessPolicies resource. * * @param {string} projectLocationAccessPoliciesName * A fully-qualified path representing project_location_accessPolicies resource. * @returns {string} A string representing the access_policy. */ matchAccessPolicyFromProjectLocationAccessPoliciesName(projectLocationAccessPoliciesName: string): string | number; /** * Return a fully-qualified projectLocationPolicyBindings resource name string. * * @param {string} project * @param {string} location * @param {string} policy_binding * @returns {string} Resource name string. */ projectLocationPolicyBindingsPath(project: string, location: string, policyBinding: string): string; /** * Parse the project from ProjectLocationPolicyBindings resource. * * @param {string} projectLocationPolicyBindingsName * A fully-qualified path representing project_location_policyBindings resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationPolicyBindingsName(projectLocationPolicyBindingsName: string): string | number; /** * Parse the location from ProjectLocationPolicyBindings resource. * * @param {string} projectLocationPolicyBindingsName * A fully-qualified path representing project_location_policyBindings resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationPolicyBindingsName(projectLocationPolicyBindingsName: string): string | number; /** * Parse the policy_binding from ProjectLocationPolicyBindings resource. * * @param {string} projectLocationPolicyBindingsName * A fully-qualified path representing project_location_policyBindings resource. * @returns {string} A string representing the policy_binding. */ matchPolicyBindingFromProjectLocationPolicyBindingsName(projectLocationPolicyBindingsName: 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; }