@google-cloud/iam
Version:
Identity and Access Management client for Node.js
691 lines • 55.8 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* Manages WorkloadIdentityPools.
* @class
* @memberof v1beta
*/
export declare class WorkloadIdentityPoolsClient {
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;
};
pathTemplates: {
[name: string]: gax.PathTemplate;
};
operationsClient: gax.OperationsClient;
workloadIdentityPoolsStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of WorkloadIdentityPoolsClient.
*
* @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 WorkloadIdentityPoolsClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Gets an individual
* {@link protos.google.iam.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the pool to retrieve.
* @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.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}.
* 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/v1beta/workload_identity_pools.get_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_GetWorkloadIdentityPool_async
*/
getWorkloadIdentityPool(request?: protos.google.iam.v1beta.IGetWorkloadIdentityPoolRequest, options?: CallOptions): Promise<[
protos.google.iam.v1beta.IWorkloadIdentityPool,
protos.google.iam.v1beta.IGetWorkloadIdentityPoolRequest | undefined,
{} | undefined
]>;
getWorkloadIdentityPool(request: protos.google.iam.v1beta.IGetWorkloadIdentityPoolRequest, options: CallOptions, callback: Callback<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IGetWorkloadIdentityPoolRequest | null | undefined, {} | null | undefined>): void;
getWorkloadIdentityPool(request: protos.google.iam.v1beta.IGetWorkloadIdentityPoolRequest, callback: Callback<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IGetWorkloadIdentityPoolRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets an individual
* {@link protos.google.iam.v1beta.WorkloadIdentityPoolProvider|WorkloadIdentityPoolProvider}.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the provider to retrieve.
* @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.v1beta.WorkloadIdentityPoolProvider|WorkloadIdentityPoolProvider}.
* 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/v1beta/workload_identity_pools.get_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_GetWorkloadIdentityPoolProvider_async
*/
getWorkloadIdentityPoolProvider(request?: protos.google.iam.v1beta.IGetWorkloadIdentityPoolProviderRequest, options?: CallOptions): Promise<[
protos.google.iam.v1beta.IWorkloadIdentityPoolProvider,
protos.google.iam.v1beta.IGetWorkloadIdentityPoolProviderRequest | undefined,
{} | undefined
]>;
getWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.IGetWorkloadIdentityPoolProviderRequest, options: CallOptions, callback: Callback<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IGetWorkloadIdentityPoolProviderRequest | null | undefined, {} | null | undefined>): void;
getWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.IGetWorkloadIdentityPoolProviderRequest, callback: Callback<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IGetWorkloadIdentityPoolProviderRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a new
* {@link protos.google.iam.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}.
*
* You cannot reuse the name of a deleted pool until 30 days after deletion.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource to create the pool in. The only supported
* location is `global`.
* @param {google.iam.v1beta.WorkloadIdentityPool} request.workloadIdentityPool
* Required. The pool to create.
* @param {string} request.workloadIdentityPoolId
* Required. The ID to use for the pool, which becomes the
* final component of the resource name. This value should be 4-32 characters,
* and may contain the characters [a-z0-9-]. The prefix `gcp-` is
* reserved for use by Google, and may not be specified.
* @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/v1beta/workload_identity_pools.create_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_CreateWorkloadIdentityPool_async
*/
createWorkloadIdentityPool(request?: protos.google.iam.v1beta.ICreateWorkloadIdentityPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
createWorkloadIdentityPool(request: protos.google.iam.v1beta.ICreateWorkloadIdentityPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
createWorkloadIdentityPool(request: protos.google.iam.v1beta.ICreateWorkloadIdentityPoolRequest, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `createWorkloadIdentityPool()`.
* @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/v1beta/workload_identity_pools.create_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_CreateWorkloadIdentityPool_async
*/
checkCreateWorkloadIdentityPoolProgress(name: string): Promise<LROperation<protos.google.iam.v1beta.WorkloadIdentityPool, protos.google.iam.v1beta.WorkloadIdentityPoolOperationMetadata>>;
/**
* Updates an existing
* {@link protos.google.iam.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.iam.v1beta.WorkloadIdentityPool} request.workloadIdentityPool
* Required. The pool to update. The `name` field is used to identify the pool.
* @param {google.protobuf.FieldMask} request.updateMask
* Required. The list of fields 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/v1beta/workload_identity_pools.update_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_UpdateWorkloadIdentityPool_async
*/
updateWorkloadIdentityPool(request?: protos.google.iam.v1beta.IUpdateWorkloadIdentityPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
updateWorkloadIdentityPool(request: protos.google.iam.v1beta.IUpdateWorkloadIdentityPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
updateWorkloadIdentityPool(request: protos.google.iam.v1beta.IUpdateWorkloadIdentityPoolRequest, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `updateWorkloadIdentityPool()`.
* @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/v1beta/workload_identity_pools.update_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_UpdateWorkloadIdentityPool_async
*/
checkUpdateWorkloadIdentityPoolProgress(name: string): Promise<LROperation<protos.google.iam.v1beta.WorkloadIdentityPool, protos.google.iam.v1beta.WorkloadIdentityPoolOperationMetadata>>;
/**
* Deletes a
* {@link protos.google.iam.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}.
*
* You cannot use a deleted pool to exchange external
* credentials for Google Cloud credentials. However, deletion does
* not revoke credentials that have already been issued.
* Credentials issued for a deleted pool do not grant access to resources.
* If the pool is undeleted, and the credentials are not expired, they
* grant access again.
* You can undelete a pool for 30 days. After 30 days, deletion is
* permanent.
* You cannot update deleted pools. However, you can view and list them.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the pool to delete.
* @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/v1beta/workload_identity_pools.delete_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_DeleteWorkloadIdentityPool_async
*/
deleteWorkloadIdentityPool(request?: protos.google.iam.v1beta.IDeleteWorkloadIdentityPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteWorkloadIdentityPool(request: protos.google.iam.v1beta.IDeleteWorkloadIdentityPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteWorkloadIdentityPool(request: protos.google.iam.v1beta.IDeleteWorkloadIdentityPoolRequest, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deleteWorkloadIdentityPool()`.
* @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/v1beta/workload_identity_pools.delete_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_DeleteWorkloadIdentityPool_async
*/
checkDeleteWorkloadIdentityPoolProgress(name: string): Promise<LROperation<protos.google.iam.v1beta.WorkloadIdentityPool, protos.google.iam.v1beta.WorkloadIdentityPoolOperationMetadata>>;
/**
* Undeletes a {@link protos.google.iam.v1beta.WorkloadIdentityPool|WorkloadIdentityPool},
* as long as it was deleted fewer than 30 days ago.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the pool to undelete.
* @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/v1beta/workload_identity_pools.undelete_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_UndeleteWorkloadIdentityPool_async
*/
undeleteWorkloadIdentityPool(request?: protos.google.iam.v1beta.IUndeleteWorkloadIdentityPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
undeleteWorkloadIdentityPool(request: protos.google.iam.v1beta.IUndeleteWorkloadIdentityPoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
undeleteWorkloadIdentityPool(request: protos.google.iam.v1beta.IUndeleteWorkloadIdentityPoolRequest, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPool, protos.google.iam.v1beta.IWorkloadIdentityPoolOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `undeleteWorkloadIdentityPool()`.
* @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/v1beta/workload_identity_pools.undelete_workload_identity_pool.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_UndeleteWorkloadIdentityPool_async
*/
checkUndeleteWorkloadIdentityPoolProgress(name: string): Promise<LROperation<protos.google.iam.v1beta.WorkloadIdentityPool, protos.google.iam.v1beta.WorkloadIdentityPoolOperationMetadata>>;
/**
* Creates a new
* {@link protos.google.iam.v1beta.WorkloadIdentityProvider|WorkloadIdentityPoolProvider}
* in a {@link protos.google.iam.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}.
*
* You cannot reuse the name of a deleted provider until 30 days after
* deletion.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The pool to create this provider in.
* @param {google.iam.v1beta.WorkloadIdentityPoolProvider} request.workloadIdentityPoolProvider
* Required. The provider to create.
* @param {string} request.workloadIdentityPoolProviderId
* Required. The ID for the provider, which becomes the
* final component of the resource name. This value must be 4-32 characters,
* and may contain the characters [a-z0-9-]. The prefix `gcp-` is
* reserved for use by Google, and may not be specified.
* @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/v1beta/workload_identity_pools.create_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_CreateWorkloadIdentityPoolProvider_async
*/
createWorkloadIdentityPoolProvider(request?: protos.google.iam.v1beta.ICreateWorkloadIdentityPoolProviderRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
createWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.ICreateWorkloadIdentityPoolProviderRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
createWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.ICreateWorkloadIdentityPoolProviderRequest, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `createWorkloadIdentityPoolProvider()`.
* @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/v1beta/workload_identity_pools.create_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_CreateWorkloadIdentityPoolProvider_async
*/
checkCreateWorkloadIdentityPoolProviderProgress(name: string): Promise<LROperation<protos.google.iam.v1beta.WorkloadIdentityPoolProvider, protos.google.iam.v1beta.WorkloadIdentityPoolProviderOperationMetadata>>;
/**
* Updates an existing
* {@link protos.google.iam.v1beta.WorkloadIdentityProvider|WorkloadIdentityPoolProvider}.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.iam.v1beta.WorkloadIdentityPoolProvider} request.workloadIdentityPoolProvider
* Required. The provider to update.
* @param {google.protobuf.FieldMask} request.updateMask
* Required. 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/v1beta/workload_identity_pools.update_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_UpdateWorkloadIdentityPoolProvider_async
*/
updateWorkloadIdentityPoolProvider(request?: protos.google.iam.v1beta.IUpdateWorkloadIdentityPoolProviderRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
updateWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.IUpdateWorkloadIdentityPoolProviderRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
updateWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.IUpdateWorkloadIdentityPoolProviderRequest, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `updateWorkloadIdentityPoolProvider()`.
* @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/v1beta/workload_identity_pools.update_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_UpdateWorkloadIdentityPoolProvider_async
*/
checkUpdateWorkloadIdentityPoolProviderProgress(name: string): Promise<LROperation<protos.google.iam.v1beta.WorkloadIdentityPoolProvider, protos.google.iam.v1beta.WorkloadIdentityPoolProviderOperationMetadata>>;
/**
* Deletes a
* {@link protos.google.iam.v1beta.WorkloadIdentityProvider|WorkloadIdentityPoolProvider}.
* Deleting a provider does not revoke credentials that have already been
* issued; they continue to grant access.
* You can undelete a provider for 30 days. After 30 days, deletion is
* permanent.
* You cannot update deleted providers. However, you can view and list them.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the provider to delete.
* @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/v1beta/workload_identity_pools.delete_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_DeleteWorkloadIdentityPoolProvider_async
*/
deleteWorkloadIdentityPoolProvider(request?: protos.google.iam.v1beta.IDeleteWorkloadIdentityPoolProviderRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.IDeleteWorkloadIdentityPoolProviderRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.IDeleteWorkloadIdentityPoolProviderRequest, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deleteWorkloadIdentityPoolProvider()`.
* @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/v1beta/workload_identity_pools.delete_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_DeleteWorkloadIdentityPoolProvider_async
*/
checkDeleteWorkloadIdentityPoolProviderProgress(name: string): Promise<LROperation<protos.google.iam.v1beta.WorkloadIdentityPoolProvider, protos.google.iam.v1beta.WorkloadIdentityPoolProviderOperationMetadata>>;
/**
* Undeletes a
* {@link protos.google.iam.v1beta.WorkloadIdentityProvider|WorkloadIdentityPoolProvider},
* as long as it was deleted fewer than 30 days ago.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the provider to undelete.
* @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/v1beta/workload_identity_pools.undelete_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_UndeleteWorkloadIdentityPoolProvider_async
*/
undeleteWorkloadIdentityPoolProvider(request?: protos.google.iam.v1beta.IUndeleteWorkloadIdentityPoolProviderRequest, options?: CallOptions): Promise<[
LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
undeleteWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.IUndeleteWorkloadIdentityPoolProviderRequest, options: CallOptions, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
undeleteWorkloadIdentityPoolProvider(request: protos.google.iam.v1beta.IUndeleteWorkloadIdentityPoolProviderRequest, callback: Callback<LROperation<protos.google.iam.v1beta.IWorkloadIdentityPoolProvider, protos.google.iam.v1beta.IWorkloadIdentityPoolProviderOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `undeleteWorkloadIdentityPoolProvider()`.
* @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/v1beta/workload_identity_pools.undelete_workload_identity_pool_provider.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_UndeleteWorkloadIdentityPoolProvider_async
*/
checkUndeleteWorkloadIdentityPoolProviderProgress(name: string): Promise<LROperation<protos.google.iam.v1beta.WorkloadIdentityPoolProvider, protos.google.iam.v1beta.WorkloadIdentityPoolProviderOperationMetadata>>;
/**
* Lists all non-deleted
* {@link protos.google.iam.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}s in a
* project. If `show_deleted` is set to `true`, then deleted pools are also
* listed.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource to list pools for.
* @param {number} request.pageSize
* The maximum number of pools to return.
* If unspecified, at most 50 pools are returned.
* The maximum value is 1000; values above are 1000 truncated to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListWorkloadIdentityPools`
* call. Provide this to retrieve the subsequent page.
* @param {boolean} request.showDeleted
* Whether to return soft-deleted pools.
* @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.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}.
* 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 `listWorkloadIdentityPoolsAsync()`
* 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.
*/
listWorkloadIdentityPools(request?: protos.google.iam.v1beta.IListWorkloadIdentityPoolsRequest, options?: CallOptions): Promise<[
protos.google.iam.v1beta.IWorkloadIdentityPool[],
protos.google.iam.v1beta.IListWorkloadIdentityPoolsRequest | null,
protos.google.iam.v1beta.IListWorkloadIdentityPoolsResponse
]>;
listWorkloadIdentityPools(request: protos.google.iam.v1beta.IListWorkloadIdentityPoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.iam.v1beta.IListWorkloadIdentityPoolsRequest, protos.google.iam.v1beta.IListWorkloadIdentityPoolsResponse | null | undefined, protos.google.iam.v1beta.IWorkloadIdentityPool>): void;
listWorkloadIdentityPools(request: protos.google.iam.v1beta.IListWorkloadIdentityPoolsRequest, callback: PaginationCallback<protos.google.iam.v1beta.IListWorkloadIdentityPoolsRequest, protos.google.iam.v1beta.IListWorkloadIdentityPoolsResponse | null | undefined, protos.google.iam.v1beta.IWorkloadIdentityPool>): void;
/**
* Equivalent to `listWorkloadIdentityPools`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource to list pools for.
* @param {number} request.pageSize
* The maximum number of pools to return.
* If unspecified, at most 50 pools are returned.
* The maximum value is 1000; values above are 1000 truncated to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListWorkloadIdentityPools`
* call. Provide this to retrieve the subsequent page.
* @param {boolean} request.showDeleted
* Whether to return soft-deleted pools.
* @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.v1beta.WorkloadIdentityPool|WorkloadIdentityPool} 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 `listWorkloadIdentityPoolsAsync()`
* 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.
*/
listWorkloadIdentityPoolsStream(request?: protos.google.iam.v1beta.IListWorkloadIdentityPoolsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listWorkloadIdentityPools`, 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 to list pools for.
* @param {number} request.pageSize
* The maximum number of pools to return.
* If unspecified, at most 50 pools are returned.
* The maximum value is 1000; values above are 1000 truncated to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListWorkloadIdentityPools`
* call. Provide this to retrieve the subsequent page.
* @param {boolean} request.showDeleted
* Whether to return soft-deleted pools.
* @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.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}. 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/v1beta/workload_identity_pools.list_workload_identity_pools.js</caption>
* region_tag:iam_v1beta_generated_WorkloadIdentityPools_ListWorkloadIdentityPools_async
*/
listWorkloadIdentityPoolsAsync(request?: protos.google.iam.v1beta.IListWorkloadIdentityPoolsRequest, options?: CallOptions): AsyncIterable<protos.google.iam.v1beta.IWorkloadIdentityPool>;
/**
* Lists all non-deleted
* {@link protos.google.iam.v1beta.WorkloadIdentityPoolProvider|WorkloadIdentityPoolProvider}s
* in a {@link protos.google.iam.v1beta.WorkloadIdentityPool|WorkloadIdentityPool}.
* If `show_deleted` is set to `true`, then deleted providers are also listed.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The pool to list providers for.
* @param {number} request.pageSize
* The maximum number of providers to return.
* If unspecified, at most 50 providers are returned.
* The maximum value is 100; values above 100 are truncated to 100.
* @param {string} request.pageToken
* A page token, received from a previous
* `ListWorkloadIdentityPoolProviders` call. Provide this to retrieve the
* subsequent page.
* @param {boolean} request.showDeleted
* Whether to return soft-deleted providers.
* @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.v1beta.WorkloadIdentityPoolProvider|WorkloadIdentityPoolProvider}.
* 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 `listWorkloadIdentityPoolProvidersAsync()`
* 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.
*/
listWorkloadIdentityPoolProviders(request?: protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersRequest, options?: CallOptions): Promise<[
protos.google.iam.v1beta.IWorkloadIdentityPoolProvider[],
protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersRequest | null,
protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersResponse
]>;
listWorkloadIdentityPoolProviders(request: protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersRequest, options: CallOptions, callback: PaginationCallback<protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersRequest, protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersResponse | null | undefined, protos.google.iam.v1beta.IWorkloadIdentityPoolProvider>): void;
listWorkloadIdentityPoolProviders(request: protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersRequest, callback: PaginationCallback<protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersRequest, protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersResponse | null | undefined, protos.google.iam.v1beta.IWorkloadIdentityPoolProvider>): void;
/**
* Equivalent to `listWorkloadIdentityPoolProviders`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The pool to list providers for.
* @param {number} request.pageSize
* The maximum number of providers to return.
* If unspecified, at most 50 providers are returned.
* The maximum value is 100; values above 100 are truncated to 100.
* @param {string} request.pageToken
* A page token, received from a previous
* `ListWorkloadIdentityPoolProviders` call. Provide this to retrieve the
* subsequent page.
* @param {boolean} request.showDeleted
* Whether to return soft-deleted providers.
* @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.v1beta.WorkloadIdentityPoolProvider|WorkloadIdentityPoolProvider} 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 `listWorkloadIdentityPoolProvidersAsync()`
* 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.
*/
listWorkloadIdentityPoolProvidersStream(request?: protos.google.iam.v1beta.IListWorkloadIdentityPoolProvidersRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listWorkloadIdentityPoolProviders`, 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 pool to list providers for.
* @param {number} request.pageSize
* The maximum number of providers to return.
* If unspecified, at most 50 providers are returned.
* The maximum value is 100; values above 100 are truncated to 100.
* @param {string} request.pageToken
* A page token, received from a previous
* `ListWorkloadIdentityPoolProviders` call. Provide this to retrieve the
* subsequent page.
* @param {boolean} request.showDeleted
* Whether to return soft-dele