@google-cloud/iam
Version:
Identity and Access Management client for Node.js
799 lines • 54.1 kB
TypeScript
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) principal access boundary
* policies.
* @class
* @memberof v3
*/
export declare class PrincipalAccessBoundaryPoliciesClient {
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;
principalAccessBoundaryPoliciesStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of PrincipalAccessBoundaryPoliciesClient.
*
* @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 PrincipalAccessBoundaryPoliciesClient({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 a principal access boundary policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the principal access boundary policy to retrieve.
*
* Format:
* `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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.v3.PrincipalAccessBoundaryPolicy|PrincipalAccessBoundaryPolicy}.
* 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/v3/principal_access_boundary_policies.get_principal_access_boundary_policy.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_GetPrincipalAccessBoundaryPolicy_async
*/
getPrincipalAccessBoundaryPolicy(request?: protos.google.iam.v3.IGetPrincipalAccessBoundaryPolicyRequest, options?: CallOptions): Promise<[
protos.google.iam.v3.IPrincipalAccessBoundaryPolicy,
protos.google.iam.v3.IGetPrincipalAccessBoundaryPolicyRequest | undefined,
{} | undefined
]>;
getPrincipalAccessBoundaryPolicy(request: protos.google.iam.v3.IGetPrincipalAccessBoundaryPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy, protos.google.iam.v3.IGetPrincipalAccessBoundaryPolicyRequest | null | undefined, {} | null | undefined>): void;
getPrincipalAccessBoundaryPolicy(request: protos.google.iam.v3.IGetPrincipalAccessBoundaryPolicyRequest, callback: Callback<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy, protos.google.iam.v3.IGetPrincipalAccessBoundaryPolicyRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a principal access boundary 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 principal access boundary policy
* will be created. Only organizations are supported.
*
* Format:
* `organizations/{organization_id}/locations/{location}`
* @param {string} request.principalAccessBoundaryPolicyId
* Required. The ID to use for the principal access boundary policy, which
* will become the final component of the principal access boundary 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}/.
* @param {google.iam.v3.PrincipalAccessBoundaryPolicy} request.principalAccessBoundaryPolicy
* Required. The principal access boundary 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/v3/principal_access_boundary_policies.create_principal_access_boundary_policy.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_CreatePrincipalAccessBoundaryPolicy_async
*/
createPrincipalAccessBoundaryPolicy(request?: protos.google.iam.v3.ICreatePrincipalAccessBoundaryPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy, protos.google.iam.v3.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
createPrincipalAccessBoundaryPolicy(request: protos.google.iam.v3.ICreatePrincipalAccessBoundaryPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy, protos.google.iam.v3.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
createPrincipalAccessBoundaryPolicy(request: protos.google.iam.v3.ICreatePrincipalAccessBoundaryPolicyRequest, callback: Callback<LROperation<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy, protos.google.iam.v3.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `createPrincipalAccessBoundaryPolicy()`.
* @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/v3/principal_access_boundary_policies.create_principal_access_boundary_policy.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_CreatePrincipalAccessBoundaryPolicy_async
*/
checkCreatePrincipalAccessBoundaryPolicyProgress(name: string): Promise<LROperation<protos.google.iam.v3.PrincipalAccessBoundaryPolicy, protos.google.iam.v3.OperationMetadata>>;
/**
* Updates a principal access boundary policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.iam.v3.PrincipalAccessBoundaryPolicy} request.principalAccessBoundaryPolicy
* Required. The principal access boundary policy to update.
*
* The principal access boundary 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 {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 <caption>include:samples/generated/v3/principal_access_boundary_policies.update_principal_access_boundary_policy.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_UpdatePrincipalAccessBoundaryPolicy_async
*/
updatePrincipalAccessBoundaryPolicy(request?: protos.google.iam.v3.IUpdatePrincipalAccessBoundaryPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy, protos.google.iam.v3.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
updatePrincipalAccessBoundaryPolicy(request: protos.google.iam.v3.IUpdatePrincipalAccessBoundaryPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy, protos.google.iam.v3.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
updatePrincipalAccessBoundaryPolicy(request: protos.google.iam.v3.IUpdatePrincipalAccessBoundaryPolicyRequest, callback: Callback<LROperation<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy, protos.google.iam.v3.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `updatePrincipalAccessBoundaryPolicy()`.
* @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/v3/principal_access_boundary_policies.update_principal_access_boundary_policy.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_UpdatePrincipalAccessBoundaryPolicy_async
*/
checkUpdatePrincipalAccessBoundaryPolicyProgress(name: string): Promise<LROperation<protos.google.iam.v3.PrincipalAccessBoundaryPolicy, protos.google.iam.v3.OperationMetadata>>;
/**
* Deletes a principal access boundary policy.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the principal access boundary policy to delete.
*
* Format:
* `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}`
* @param {string} [request.etag]
* Optional. The etag of the principal access boundary 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 is referenced in policy bindings.
* @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/v3/principal_access_boundary_policies.delete_principal_access_boundary_policy.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_DeletePrincipalAccessBoundaryPolicy_async
*/
deletePrincipalAccessBoundaryPolicy(request?: protos.google.iam.v3.IDeletePrincipalAccessBoundaryPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.iam.v3.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deletePrincipalAccessBoundaryPolicy(request: protos.google.iam.v3.IDeletePrincipalAccessBoundaryPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.iam.v3.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deletePrincipalAccessBoundaryPolicy(request: protos.google.iam.v3.IDeletePrincipalAccessBoundaryPolicyRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.iam.v3.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deletePrincipalAccessBoundaryPolicy()`.
* @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/v3/principal_access_boundary_policies.delete_principal_access_boundary_policy.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_DeletePrincipalAccessBoundaryPolicy_async
*/
checkDeletePrincipalAccessBoundaryPolicyProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.iam.v3.OperationMetadata>>;
/**
* Lists principal access boundary policies.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource, which owns the collection of principal
* access boundary policies.
*
* Format:
* `organizations/{organization_id}/locations/{location}`
* @param {number} [request.pageSize]
* Optional. The maximum number of principal access boundary policies to
* return. The service may return fewer than this value.
*
* If unspecified, at most 50 principal access boundary policies 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
* `ListPrincipalAccessBoundaryPolicies` call. Provide this to retrieve the
* subsequent page.
*
* When paginating, all other parameters provided to
* `ListPrincipalAccessBoundaryPolicies` 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.v3.PrincipalAccessBoundaryPolicy|PrincipalAccessBoundaryPolicy}.
* 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 `listPrincipalAccessBoundaryPoliciesAsync()`
* 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.
*/
listPrincipalAccessBoundaryPolicies(request?: protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesRequest, options?: CallOptions): Promise<[
protos.google.iam.v3.IPrincipalAccessBoundaryPolicy[],
protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesRequest | null,
protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesResponse
]>;
listPrincipalAccessBoundaryPolicies(request: protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesRequest, protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesResponse | null | undefined, protos.google.iam.v3.IPrincipalAccessBoundaryPolicy>): void;
listPrincipalAccessBoundaryPolicies(request: protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesRequest, callback: PaginationCallback<protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesRequest, protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesResponse | null | undefined, protos.google.iam.v3.IPrincipalAccessBoundaryPolicy>): void;
/**
* Equivalent to `listPrincipalAccessBoundaryPolicies`, 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 principal
* access boundary policies.
*
* Format:
* `organizations/{organization_id}/locations/{location}`
* @param {number} [request.pageSize]
* Optional. The maximum number of principal access boundary policies to
* return. The service may return fewer than this value.
*
* If unspecified, at most 50 principal access boundary policies 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
* `ListPrincipalAccessBoundaryPolicies` call. Provide this to retrieve the
* subsequent page.
*
* When paginating, all other parameters provided to
* `ListPrincipalAccessBoundaryPolicies` 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.v3.PrincipalAccessBoundaryPolicy|PrincipalAccessBoundaryPolicy} 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 `listPrincipalAccessBoundaryPoliciesAsync()`
* 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.
*/
listPrincipalAccessBoundaryPoliciesStream(request?: protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listPrincipalAccessBoundaryPolicies`, 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 principal
* access boundary policies.
*
* Format:
* `organizations/{organization_id}/locations/{location}`
* @param {number} [request.pageSize]
* Optional. The maximum number of principal access boundary policies to
* return. The service may return fewer than this value.
*
* If unspecified, at most 50 principal access boundary policies 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
* `ListPrincipalAccessBoundaryPolicies` call. Provide this to retrieve the
* subsequent page.
*
* When paginating, all other parameters provided to
* `ListPrincipalAccessBoundaryPolicies` 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.v3.PrincipalAccessBoundaryPolicy|PrincipalAccessBoundaryPolicy}. 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/v3/principal_access_boundary_policies.list_principal_access_boundary_policies.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_ListPrincipalAccessBoundaryPolicies_async
*/
listPrincipalAccessBoundaryPoliciesAsync(request?: protos.google.iam.v3.IListPrincipalAccessBoundaryPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.iam.v3.IPrincipalAccessBoundaryPolicy>;
/**
* 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 principal access boundary policy.
* Format:
* `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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
* `SearchPrincipalAccessBoundaryPolicyBindingsRequest` call. Provide this to
* retrieve the subsequent page.
*
* When paginating, all other parameters provided to
* `SearchPrincipalAccessBoundaryPolicyBindingsRequest` 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.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 `searchPrincipalAccessBoundaryPolicyBindingsAsync()`
* 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.
*/
searchPrincipalAccessBoundaryPolicyBindings(request?: protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsRequest, options?: CallOptions): Promise<[
protos.google.iam.v3.IPolicyBinding[],
protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsRequest | null,
protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsResponse
]>;
searchPrincipalAccessBoundaryPolicyBindings(request: protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsRequest, protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsResponse | null | undefined, protos.google.iam.v3.IPolicyBinding>): void;
searchPrincipalAccessBoundaryPolicyBindings(request: protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsRequest, callback: PaginationCallback<protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsRequest, protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsResponse | null | undefined, protos.google.iam.v3.IPolicyBinding>): void;
/**
* Equivalent to `searchPrincipalAccessBoundaryPolicyBindings`, 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 principal access boundary policy.
* Format:
* `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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
* `SearchPrincipalAccessBoundaryPolicyBindingsRequest` call. Provide this to
* retrieve the subsequent page.
*
* When paginating, all other parameters provided to
* `SearchPrincipalAccessBoundaryPolicyBindingsRequest` 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.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 `searchPrincipalAccessBoundaryPolicyBindingsAsync()`
* 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.
*/
searchPrincipalAccessBoundaryPolicyBindingsStream(request?: protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `searchPrincipalAccessBoundaryPolicyBindings`, 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 principal access boundary policy.
* Format:
* `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_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
* `SearchPrincipalAccessBoundaryPolicyBindingsRequest` call. Provide this to
* retrieve the subsequent page.
*
* When paginating, all other parameters provided to
* `SearchPrincipalAccessBoundaryPolicyBindingsRequest` 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.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 <caption>include:samples/generated/v3/principal_access_boundary_policies.search_principal_access_boundary_policy_bindings.js</caption>
* region_tag:iam_v3_generated_PrincipalAccessBoundaryPolicies_SearchPrincipalAccessBoundaryPolicyBindings_async
*/
searchPrincipalAccessBoundaryPolicyBindingsAsync(request?: protos.google.iam.v3.ISearchPrincipalAccessBoundaryPolicyBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.iam.v3.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 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 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(organizationLocationPol