Discovery Engine v1 API - Class IdentityMappingStoreServiceClient (1.8.0)

public abstract class IdentityMappingStoreServiceClient

Reference documentation and code samples for the Discovery Engine v1 API class IdentityMappingStoreServiceClient.

IdentityMappingStoreService client wrapper, for convenient use.

Inheritance

object > IdentityMappingStoreServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for managing Identity Mapping Stores.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the IdentityMappingStoreService service, which is a host of "discoveryengine.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default IdentityMappingStoreService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default IdentityMappingStoreService scopes are:

DeleteIdentityMappingStoreOperationsClient

public virtual OperationsClient DeleteIdentityMappingStoreOperationsClient { get; }

The long-running operations client for DeleteIdentityMappingStore.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual IdentityMappingStoreService.IdentityMappingStoreServiceClient GrpcClient { get; }

The underlying gRPC IdentityMappingStoreService client

Property Value
Type Description
IdentityMappingStoreServiceIdentityMappingStoreServiceClient

ImportIdentityMappingsOperationsClient

public virtual OperationsClient ImportIdentityMappingsOperationsClient { get; }

The long-running operations client for ImportIdentityMappings.

Property Value
Type Description
OperationsClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

PurgeIdentityMappingsOperationsClient

public virtual OperationsClient PurgeIdentityMappingsOperationsClient { get; }

The long-running operations client for PurgeIdentityMappings.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static IdentityMappingStoreServiceClient Create()

Synchronously creates a IdentityMappingStoreServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IdentityMappingStoreServiceClientBuilder.

Returns
Type Description
IdentityMappingStoreServiceClient

The created IdentityMappingStoreServiceClient.

CreateAsync(CancellationToken)

public static Task<IdentityMappingStoreServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a IdentityMappingStoreServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IdentityMappingStoreServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskIdentityMappingStoreServiceClient

The task representing the created IdentityMappingStoreServiceClient.

CreateIdentityMappingStore(CreateIdentityMappingStoreRequest, CallSettings)

public virtual IdentityMappingStore CreateIdentityMappingStore(CreateIdentityMappingStoreRequest request, CallSettings callSettings = null)

Creates a new Identity Mapping Store.

Parameters
Name Description
request CreateIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IdentityMappingStore

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
CreateIdentityMappingStoreRequest request = new CreateIdentityMappingStoreRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    IdentityMappingStoreId = "",
    IdentityMappingStore = new IdentityMappingStore(),
    CmekConfigNameAsCmekConfigName = CmekConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
IdentityMappingStore response = identityMappingStoreServiceClient.CreateIdentityMappingStore(request);

CreateIdentityMappingStore(LocationName, IdentityMappingStore, string, CallSettings)

public virtual IdentityMappingStore CreateIdentityMappingStore(LocationName parent, IdentityMappingStore identityMappingStore, string identityMappingStoreId, CallSettings callSettings = null)

Creates a new Identity Mapping Store.

Parameters
Name Description
parent LocationName

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

identityMappingStore IdentityMappingStore

Required. The Identity Mapping Store to create.

identityMappingStoreId string

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IdentityMappingStore

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IdentityMappingStore identityMappingStore = new IdentityMappingStore();
string identityMappingStoreId = "";
// Make the request
IdentityMappingStore response = identityMappingStoreServiceClient.CreateIdentityMappingStore(parent, identityMappingStore, identityMappingStoreId);

CreateIdentityMappingStore(string, IdentityMappingStore, string, CallSettings)

public virtual IdentityMappingStore CreateIdentityMappingStore(string parent, IdentityMappingStore identityMappingStore, string identityMappingStoreId, CallSettings callSettings = null)

Creates a new Identity Mapping Store.

Parameters
Name Description
parent string

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

identityMappingStore IdentityMappingStore

Required. The Identity Mapping Store to create.

identityMappingStoreId string

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IdentityMappingStore

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IdentityMappingStore identityMappingStore = new IdentityMappingStore();
string identityMappingStoreId = "";
// Make the request
IdentityMappingStore response = identityMappingStoreServiceClient.CreateIdentityMappingStore(parent, identityMappingStore, identityMappingStoreId);

CreateIdentityMappingStoreAsync(CreateIdentityMappingStoreRequest, CallSettings)

public virtual Task<IdentityMappingStore> CreateIdentityMappingStoreAsync(CreateIdentityMappingStoreRequest request, CallSettings callSettings = null)

Creates a new Identity Mapping Store.

Parameters
Name Description
request CreateIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
CreateIdentityMappingStoreRequest request = new CreateIdentityMappingStoreRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    IdentityMappingStoreId = "",
    IdentityMappingStore = new IdentityMappingStore(),
    CmekConfigNameAsCmekConfigName = CmekConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.CreateIdentityMappingStoreAsync(request);

CreateIdentityMappingStoreAsync(CreateIdentityMappingStoreRequest, CancellationToken)

public virtual Task<IdentityMappingStore> CreateIdentityMappingStoreAsync(CreateIdentityMappingStoreRequest request, CancellationToken cancellationToken)

Creates a new Identity Mapping Store.

Parameters
Name Description
request CreateIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
CreateIdentityMappingStoreRequest request = new CreateIdentityMappingStoreRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    IdentityMappingStoreId = "",
    IdentityMappingStore = new IdentityMappingStore(),
    CmekConfigNameAsCmekConfigName = CmekConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.CreateIdentityMappingStoreAsync(request);

CreateIdentityMappingStoreAsync(LocationName, IdentityMappingStore, string, CallSettings)

public virtual Task<IdentityMappingStore> CreateIdentityMappingStoreAsync(LocationName parent, IdentityMappingStore identityMappingStore, string identityMappingStoreId, CallSettings callSettings = null)

Creates a new Identity Mapping Store.

Parameters
Name Description
parent LocationName

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

identityMappingStore IdentityMappingStore

Required. The Identity Mapping Store to create.

identityMappingStoreId string

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IdentityMappingStore identityMappingStore = new IdentityMappingStore();
string identityMappingStoreId = "";
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.CreateIdentityMappingStoreAsync(parent, identityMappingStore, identityMappingStoreId);

CreateIdentityMappingStoreAsync(LocationName, IdentityMappingStore, string, CancellationToken)

public virtual Task<IdentityMappingStore> CreateIdentityMappingStoreAsync(LocationName parent, IdentityMappingStore identityMappingStore, string identityMappingStoreId, CancellationToken cancellationToken)

Creates a new Identity Mapping Store.

Parameters
Name Description
parent LocationName

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

identityMappingStore IdentityMappingStore

Required. The Identity Mapping Store to create.

identityMappingStoreId string

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IdentityMappingStore identityMappingStore = new IdentityMappingStore();
string identityMappingStoreId = "";
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.CreateIdentityMappingStoreAsync(parent, identityMappingStore, identityMappingStoreId);

CreateIdentityMappingStoreAsync(string, IdentityMappingStore, string, CallSettings)

public virtual Task<IdentityMappingStore> CreateIdentityMappingStoreAsync(string parent, IdentityMappingStore identityMappingStore, string identityMappingStoreId, CallSettings callSettings = null)

Creates a new Identity Mapping Store.

Parameters
Name Description
parent string

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

identityMappingStore IdentityMappingStore

Required. The Identity Mapping Store to create.

identityMappingStoreId string

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IdentityMappingStore identityMappingStore = new IdentityMappingStore();
string identityMappingStoreId = "";
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.CreateIdentityMappingStoreAsync(parent, identityMappingStore, identityMappingStoreId);

CreateIdentityMappingStoreAsync(string, IdentityMappingStore, string, CancellationToken)

public virtual Task<IdentityMappingStore> CreateIdentityMappingStoreAsync(string parent, IdentityMappingStore identityMappingStore, string identityMappingStoreId, CancellationToken cancellationToken)

Creates a new Identity Mapping Store.

Parameters
Name Description
parent string

Required. The parent collection resource name, such as projects/{project}/locations/{location}.

identityMappingStore IdentityMappingStore

Required. The Identity Mapping Store to create.

identityMappingStoreId string

Required. The ID of the Identity Mapping Store to create.

The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IdentityMappingStore identityMappingStore = new IdentityMappingStore();
string identityMappingStoreId = "";
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.CreateIdentityMappingStoreAsync(parent, identityMappingStore, identityMappingStoreId);

DeleteIdentityMappingStore(DeleteIdentityMappingStoreRequest, CallSettings)

public virtual Operation<Empty, DeleteIdentityMappingStoreMetadata> DeleteIdentityMappingStore(DeleteIdentityMappingStoreRequest request, CallSettings callSettings = null)

Deletes the Identity Mapping Store.

Parameters
Name Description
request DeleteIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteIdentityMappingStoreMetadata

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
DeleteIdentityMappingStoreRequest request = new DeleteIdentityMappingStoreRequest
{
    IdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
};
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = identityMappingStoreServiceClient.DeleteIdentityMappingStore(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStore(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIdentityMappingStore(IdentityMappingStoreName, CallSettings)

public virtual Operation<Empty, DeleteIdentityMappingStoreMetadata> DeleteIdentityMappingStore(IdentityMappingStoreName name, CallSettings callSettings = null)

Deletes the Identity Mapping Store.

Parameters
Name Description
name IdentityMappingStoreName

Required. The name of the Identity Mapping Store to delete. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteIdentityMappingStoreMetadata

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
IdentityMappingStoreName name = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]");
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = identityMappingStoreServiceClient.DeleteIdentityMappingStore(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStore(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIdentityMappingStore(string, CallSettings)

public virtual Operation<Empty, DeleteIdentityMappingStoreMetadata> DeleteIdentityMappingStore(string name, CallSettings callSettings = null)

Deletes the Identity Mapping Store.

Parameters
Name Description
name string

Required. The name of the Identity Mapping Store to delete. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteIdentityMappingStoreMetadata

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/identityMappingStores/[IDENTITY_MAPPING_STORE]";
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = identityMappingStoreServiceClient.DeleteIdentityMappingStore(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStore(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIdentityMappingStoreAsync(DeleteIdentityMappingStoreRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteIdentityMappingStoreMetadata>> DeleteIdentityMappingStoreAsync(DeleteIdentityMappingStoreRequest request, CallSettings callSettings = null)

Deletes the Identity Mapping Store.

Parameters
Name Description
request DeleteIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteIdentityMappingStoreMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteIdentityMappingStoreRequest request = new DeleteIdentityMappingStoreRequest
{
    IdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
};
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = await identityMappingStoreServiceClient.DeleteIdentityMappingStoreAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStoreAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIdentityMappingStoreAsync(DeleteIdentityMappingStoreRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteIdentityMappingStoreMetadata>> DeleteIdentityMappingStoreAsync(DeleteIdentityMappingStoreRequest request, CancellationToken cancellationToken)

Deletes the Identity Mapping Store.

Parameters
Name Description
request DeleteIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteIdentityMappingStoreMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteIdentityMappingStoreRequest request = new DeleteIdentityMappingStoreRequest
{
    IdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
};
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = await identityMappingStoreServiceClient.DeleteIdentityMappingStoreAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStoreAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIdentityMappingStoreAsync(IdentityMappingStoreName, CallSettings)

public virtual Task<Operation<Empty, DeleteIdentityMappingStoreMetadata>> DeleteIdentityMappingStoreAsync(IdentityMappingStoreName name, CallSettings callSettings = null)

Deletes the Identity Mapping Store.

Parameters
Name Description
name IdentityMappingStoreName

Required. The name of the Identity Mapping Store to delete. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteIdentityMappingStoreMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
IdentityMappingStoreName name = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]");
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = await identityMappingStoreServiceClient.DeleteIdentityMappingStoreAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStoreAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIdentityMappingStoreAsync(IdentityMappingStoreName, CancellationToken)

public virtual Task<Operation<Empty, DeleteIdentityMappingStoreMetadata>> DeleteIdentityMappingStoreAsync(IdentityMappingStoreName name, CancellationToken cancellationToken)

Deletes the Identity Mapping Store.

Parameters
Name Description
name IdentityMappingStoreName

Required. The name of the Identity Mapping Store to delete. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteIdentityMappingStoreMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
IdentityMappingStoreName name = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]");
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = await identityMappingStoreServiceClient.DeleteIdentityMappingStoreAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStoreAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIdentityMappingStoreAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteIdentityMappingStoreMetadata>> DeleteIdentityMappingStoreAsync(string name, CallSettings callSettings = null)

Deletes the Identity Mapping Store.

Parameters
Name Description
name string

Required. The name of the Identity Mapping Store to delete. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteIdentityMappingStoreMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/identityMappingStores/[IDENTITY_MAPPING_STORE]";
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = await identityMappingStoreServiceClient.DeleteIdentityMappingStoreAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStoreAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteIdentityMappingStoreAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteIdentityMappingStoreMetadata>> DeleteIdentityMappingStoreAsync(string name, CancellationToken cancellationToken)

Deletes the Identity Mapping Store.

Parameters
Name Description
name string

Required. The name of the Identity Mapping Store to delete. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyDeleteIdentityMappingStoreMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/identityMappingStores/[IDENTITY_MAPPING_STORE]";
// Make the request
Operation<Empty, DeleteIdentityMappingStoreMetadata> response = await identityMappingStoreServiceClient.DeleteIdentityMappingStoreAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteIdentityMappingStoreMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteIdentityMappingStoreMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOnceDeleteIdentityMappingStoreAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GetIdentityMappingStore(GetIdentityMappingStoreRequest, CallSettings)

public virtual IdentityMappingStore GetIdentityMappingStore(GetIdentityMappingStoreRequest request, CallSettings callSettings = null)

Gets the Identity Mapping Store.

Parameters
Name Description
request GetIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IdentityMappingStore

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
GetIdentityMappingStoreRequest request = new GetIdentityMappingStoreRequest
{
    IdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
};
// Make the request
IdentityMappingStore response = identityMappingStoreServiceClient.GetIdentityMappingStore(request);

GetIdentityMappingStore(IdentityMappingStoreName, CallSettings)

public virtual IdentityMappingStore GetIdentityMappingStore(IdentityMappingStoreName name, CallSettings callSettings = null)

Gets the Identity Mapping Store.

Parameters
Name Description
name IdentityMappingStoreName

Required. The name of the Identity Mapping Store to get. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IdentityMappingStore

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
IdentityMappingStoreName name = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]");
// Make the request
IdentityMappingStore response = identityMappingStoreServiceClient.GetIdentityMappingStore(name);

GetIdentityMappingStore(string, CallSettings)

public virtual IdentityMappingStore GetIdentityMappingStore(string name, CallSettings callSettings = null)

Gets the Identity Mapping Store.

Parameters
Name Description
name string

Required. The name of the Identity Mapping Store to get. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
IdentityMappingStore

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/identityMappingStores/[IDENTITY_MAPPING_STORE]";
// Make the request
IdentityMappingStore response = identityMappingStoreServiceClient.GetIdentityMappingStore(name);

GetIdentityMappingStoreAsync(GetIdentityMappingStoreRequest, CallSettings)

public virtual Task<IdentityMappingStore> GetIdentityMappingStoreAsync(GetIdentityMappingStoreRequest request, CallSettings callSettings = null)

Gets the Identity Mapping Store.

Parameters
Name Description
request GetIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
GetIdentityMappingStoreRequest request = new GetIdentityMappingStoreRequest
{
    IdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
};
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.GetIdentityMappingStoreAsync(request);

GetIdentityMappingStoreAsync(GetIdentityMappingStoreRequest, CancellationToken)

public virtual Task<IdentityMappingStore> GetIdentityMappingStoreAsync(GetIdentityMappingStoreRequest request, CancellationToken cancellationToken)

Gets the Identity Mapping Store.

Parameters
Name Description
request GetIdentityMappingStoreRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
GetIdentityMappingStoreRequest request = new GetIdentityMappingStoreRequest
{
    IdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
};
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.GetIdentityMappingStoreAsync(request);

GetIdentityMappingStoreAsync(IdentityMappingStoreName, CallSettings)

public virtual Task<IdentityMappingStore> GetIdentityMappingStoreAsync(IdentityMappingStoreName name, CallSettings callSettings = null)

Gets the Identity Mapping Store.

Parameters
Name Description
name IdentityMappingStoreName

Required. The name of the Identity Mapping Store to get. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
IdentityMappingStoreName name = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]");
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.GetIdentityMappingStoreAsync(name);

GetIdentityMappingStoreAsync(IdentityMappingStoreName, CancellationToken)

public virtual Task<IdentityMappingStore> GetIdentityMappingStoreAsync(IdentityMappingStoreName name, CancellationToken cancellationToken)

Gets the Identity Mapping Store.

Parameters
Name Description
name IdentityMappingStoreName

Required. The name of the Identity Mapping Store to get. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
IdentityMappingStoreName name = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]");
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.GetIdentityMappingStoreAsync(name);

GetIdentityMappingStoreAsync(string, CallSettings)

public virtual Task<IdentityMappingStore> GetIdentityMappingStoreAsync(string name, CallSettings callSettings = null)

Gets the Identity Mapping Store.

Parameters
Name Description
name string

Required. The name of the Identity Mapping Store to get. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/identityMappingStores/[IDENTITY_MAPPING_STORE]";
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.GetIdentityMappingStoreAsync(name);

GetIdentityMappingStoreAsync(string, CancellationToken)

public virtual Task<IdentityMappingStore> GetIdentityMappingStoreAsync(string name, CancellationToken cancellationToken)

Gets the Identity Mapping Store.

Parameters
Name Description
name string

Required. The name of the Identity Mapping Store to get. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskIdentityMappingStore

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/identityMappingStores/[IDENTITY_MAPPING_STORE]";
// Make the request
IdentityMappingStore response = await identityMappingStoreServiceClient.GetIdentityMappingStoreAsync(name);

ImportIdentityMappings(ImportIdentityMappingsRequest, CallSettings)

public virtual Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> ImportIdentityMappings(ImportIdentityMappingsRequest request, CallSettings callSettings = null)

Imports a list of Identity Mapping Entries to an Identity Mapping Store.

Parameters
Name Description
request ImportIdentityMappingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationImportIdentityMappingsResponseIdentityMappingEntryOperationMetadata

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
ImportIdentityMappingsRequest request = new ImportIdentityMappingsRequest
{
    IdentityMappingStoreAsIdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
    InlineSource = new ImportIdentityMappingsRequest.Types.InlineSource(),
};
// Make the request
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> response = identityMappingStoreServiceClient.ImportIdentityMappings(request);

// Poll until the returned long-running operation is complete
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportIdentityMappingsResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> retrievedResponse = identityMappingStoreServiceClient.PollOnceImportIdentityMappings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportIdentityMappingsResponse retrievedResult = retrievedResponse.Result;
}

ImportIdentityMappingsAsync(ImportIdentityMappingsRequest, CallSettings)

public virtual Task<Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata>> ImportIdentityMappingsAsync(ImportIdentityMappingsRequest request, CallSettings callSettings = null)

Imports a list of Identity Mapping Entries to an Identity Mapping Store.

Parameters
Name Description
request ImportIdentityMappingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationImportIdentityMappingsResponseIdentityMappingEntryOperationMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
ImportIdentityMappingsRequest request = new ImportIdentityMappingsRequest
{
    IdentityMappingStoreAsIdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
    InlineSource = new ImportIdentityMappingsRequest.Types.InlineSource(),
};
// Make the request
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> response = await identityMappingStoreServiceClient.ImportIdentityMappingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportIdentityMappingsResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOnceImportIdentityMappingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportIdentityMappingsResponse retrievedResult = retrievedResponse.Result;
}

ImportIdentityMappingsAsync(ImportIdentityMappingsRequest, CancellationToken)

public virtual Task<Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata>> ImportIdentityMappingsAsync(ImportIdentityMappingsRequest request, CancellationToken cancellationToken)

Imports a list of Identity Mapping Entries to an Identity Mapping Store.

Parameters
Name Description
request ImportIdentityMappingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationImportIdentityMappingsResponseIdentityMappingEntryOperationMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
ImportIdentityMappingsRequest request = new ImportIdentityMappingsRequest
{
    IdentityMappingStoreAsIdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
    InlineSource = new ImportIdentityMappingsRequest.Types.InlineSource(),
};
// Make the request
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> response = await identityMappingStoreServiceClient.ImportIdentityMappingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportIdentityMappingsResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOnceImportIdentityMappingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportIdentityMappingsResponse retrievedResult = retrievedResponse.Result;
}

ListIdentityMappingStores(ListIdentityMappingStoresRequest, CallSettings)

public virtual PagedEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> ListIdentityMappingStores(ListIdentityMappingStoresRequest request, CallSettings callSettings = null)

Lists all Identity Mapping Stores.

Parameters
Name Description
request ListIdentityMappingStoresRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListIdentityMappingStoresResponseIdentityMappingStore

A pageable sequence of IdentityMappingStore resources.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
ListIdentityMappingStoresRequest request = new ListIdentityMappingStoresRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> response = identityMappingStoreServiceClient.ListIdentityMappingStores(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (IdentityMappingStore item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListIdentityMappingStoresResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityMappingStore item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityMappingStore> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityMappingStore item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIdentityMappingStores(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> ListIdentityMappingStores(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Identity Mapping Stores.

Parameters
Name Description
parent LocationName

Required. The parent of the Identity Mapping Stores to list. Format: projects/{project}/locations/{location}.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListIdentityMappingStoresResponseIdentityMappingStore

A pageable sequence of IdentityMappingStore resources.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> response = identityMappingStoreServiceClient.ListIdentityMappingStores(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (IdentityMappingStore item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListIdentityMappingStoresResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityMappingStore item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityMappingStore> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityMappingStore item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIdentityMappingStores(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> ListIdentityMappingStores(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Identity Mapping Stores.

Parameters
Name Description
parent string

Required. The parent of the Identity Mapping Stores to list. Format: projects/{project}/locations/{location}.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListIdentityMappingStoresResponseIdentityMappingStore

A pageable sequence of IdentityMappingStore resources.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> response = identityMappingStoreServiceClient.ListIdentityMappingStores(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (IdentityMappingStore item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListIdentityMappingStoresResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityMappingStore item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityMappingStore> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityMappingStore item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIdentityMappingStoresAsync(ListIdentityMappingStoresRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> ListIdentityMappingStoresAsync(ListIdentityMappingStoresRequest request, CallSettings callSettings = null)

Lists all Identity Mapping Stores.

Parameters
Name Description
request ListIdentityMappingStoresRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListIdentityMappingStoresResponseIdentityMappingStore

A pageable asynchronous sequence of IdentityMappingStore resources.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
ListIdentityMappingStoresRequest request = new ListIdentityMappingStoresRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> response = identityMappingStoreServiceClient.ListIdentityMappingStoresAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((IdentityMappingStore item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListIdentityMappingStoresResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityMappingStore item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityMappingStore> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityMappingStore item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIdentityMappingStoresAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> ListIdentityMappingStoresAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Identity Mapping Stores.

Parameters
Name Description
parent LocationName

Required. The parent of the Identity Mapping Stores to list. Format: projects/{project}/locations/{location}.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListIdentityMappingStoresResponseIdentityMappingStore

A pageable asynchronous sequence of IdentityMappingStore resources.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> response = identityMappingStoreServiceClient.ListIdentityMappingStoresAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((IdentityMappingStore item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListIdentityMappingStoresResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityMappingStore item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityMappingStore> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityMappingStore item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIdentityMappingStoresAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> ListIdentityMappingStoresAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Identity Mapping Stores.

Parameters
Name Description
parent string

Required. The parent of the Identity Mapping Stores to list. Format: projects/{project}/locations/{location}.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListIdentityMappingStoresResponseIdentityMappingStore

A pageable asynchronous sequence of IdentityMappingStore resources.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListIdentityMappingStoresResponse, IdentityMappingStore> response = identityMappingStoreServiceClient.ListIdentityMappingStoresAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((IdentityMappingStore item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListIdentityMappingStoresResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityMappingStore item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityMappingStore> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityMappingStore item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIdentityMappings(ListIdentityMappingsRequest, CallSettings)

public virtual PagedEnumerable<ListIdentityMappingsResponse, IdentityMappingEntry> ListIdentityMappings(ListIdentityMappingsRequest request, CallSettings callSettings = null)

Lists Identity Mappings in an Identity Mapping Store.

Parameters
Name Description
request ListIdentityMappingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListIdentityMappingsResponseIdentityMappingEntry

A pageable sequence of IdentityMappingEntry resources.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
ListIdentityMappingsRequest request = new ListIdentityMappingsRequest
{
    IdentityMappingStoreAsIdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
};
// Make the request
PagedEnumerable<ListIdentityMappingsResponse, IdentityMappingEntry> response = identityMappingStoreServiceClient.ListIdentityMappings(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (IdentityMappingEntry item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListIdentityMappingsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityMappingEntry item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityMappingEntry> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityMappingEntry item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIdentityMappingsAsync(ListIdentityMappingsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListIdentityMappingsResponse, IdentityMappingEntry> ListIdentityMappingsAsync(ListIdentityMappingsRequest request, CallSettings callSettings = null)

Lists Identity Mappings in an Identity Mapping Store.

Parameters
Name Description
request ListIdentityMappingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListIdentityMappingsResponseIdentityMappingEntry

A pageable asynchronous sequence of IdentityMappingEntry resources.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
ListIdentityMappingsRequest request = new ListIdentityMappingsRequest
{
    IdentityMappingStoreAsIdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
};
// Make the request
PagedAsyncEnumerable<ListIdentityMappingsResponse, IdentityMappingEntry> response = identityMappingStoreServiceClient.ListIdentityMappingsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((IdentityMappingEntry item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListIdentityMappingsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityMappingEntry item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityMappingEntry> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityMappingEntry item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceDeleteIdentityMappingStore(string, CallSettings)

public virtual Operation<Empty, DeleteIdentityMappingStoreMetadata> PollOnceDeleteIdentityMappingStore(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteIdentityMappingStore.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyDeleteIdentityMappingStoreMetadata

The result of polling the operation.

PollOnceDeleteIdentityMappingStoreAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteIdentityMappingStoreMetadata>> PollOnceDeleteIdentityMappingStoreAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteIdentityMappingStore.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyDeleteIdentityMappingStoreMetadata

A task representing the result of polling the operation.

PollOnceImportIdentityMappings(string, CallSettings)

public virtual Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata> PollOnceImportIdentityMappings(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ImportIdentityMappings.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationImportIdentityMappingsResponseIdentityMappingEntryOperationMetadata

The result of polling the operation.

PollOnceImportIdentityMappingsAsync(string, CallSettings)

public virtual Task<Operation<ImportIdentityMappingsResponse, IdentityMappingEntryOperationMetadata>> PollOnceImportIdentityMappingsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ImportIdentityMappings.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationImportIdentityMappingsResponseIdentityMappingEntryOperationMetadata

A task representing the result of polling the operation.

PollOncePurgeIdentityMappings(string, CallSettings)

public virtual Operation<Empty, IdentityMappingEntryOperationMetadata> PollOncePurgeIdentityMappings(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of PurgeIdentityMappings .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyIdentityMappingEntryOperationMetadata

The result of polling the operation.

PollOncePurgeIdentityMappingsAsync(string, CallSettings)

public virtual Task<Operation<Empty, IdentityMappingEntryOperationMetadata>> PollOncePurgeIdentityMappingsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of PurgeIdentityMappings.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyIdentityMappingEntryOperationMetadata

A task representing the result of polling the operation.

PurgeIdentityMappings(PurgeIdentityMappingsRequest, CallSettings)

public virtual Operation<Empty, IdentityMappingEntryOperationMetadata> PurgeIdentityMappings(PurgeIdentityMappingsRequest request, CallSettings callSettings = null)

Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

Parameters
Name Description
request PurgeIdentityMappingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyIdentityMappingEntryOperationMetadata

The RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = IdentityMappingStoreServiceClient.Create();
// Initialize request argument(s)
PurgeIdentityMappingsRequest request = new PurgeIdentityMappingsRequest
{
    IdentityMappingStoreAsIdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
    InlineSource = new PurgeIdentityMappingsRequest.Types.InlineSource(),
    Filter = "",
    Force = false,
};
// Make the request
Operation<Empty, IdentityMappingEntryOperationMetadata> response = identityMappingStoreServiceClient.PurgeIdentityMappings(request);

// Poll until the returned long-running operation is complete
Operation<Empty, IdentityMappingEntryOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, IdentityMappingEntryOperationMetadata> retrievedResponse = identityMappingStoreServiceClient.PollOncePurgeIdentityMappings(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

PurgeIdentityMappingsAsync(PurgeIdentityMappingsRequest, CallSettings)

public virtual Task<Operation<Empty, IdentityMappingEntryOperationMetadata>> PurgeIdentityMappingsAsync(PurgeIdentityMappingsRequest request, CallSettings callSettings = null)

Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

Parameters
Name Description
request PurgeIdentityMappingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyIdentityMappingEntryOperationMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
PurgeIdentityMappingsRequest request = new PurgeIdentityMappingsRequest
{
    IdentityMappingStoreAsIdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
    InlineSource = new PurgeIdentityMappingsRequest.Types.InlineSource(),
    Filter = "",
    Force = false,
};
// Make the request
Operation<Empty, IdentityMappingEntryOperationMetadata> response = await identityMappingStoreServiceClient.PurgeIdentityMappingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, IdentityMappingEntryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, IdentityMappingEntryOperationMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOncePurgeIdentityMappingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

PurgeIdentityMappingsAsync(PurgeIdentityMappingsRequest, CancellationToken)

public virtual Task<Operation<Empty, IdentityMappingEntryOperationMetadata>> PurgeIdentityMappingsAsync(PurgeIdentityMappingsRequest request, CancellationToken cancellationToken)

Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

Parameters
Name Description
request PurgeIdentityMappingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyIdentityMappingEntryOperationMetadata

A Task containing the RPC response.

Example
// Create client
IdentityMappingStoreServiceClient identityMappingStoreServiceClient = await IdentityMappingStoreServiceClient.CreateAsync();
// Initialize request argument(s)
PurgeIdentityMappingsRequest request = new PurgeIdentityMappingsRequest
{
    IdentityMappingStoreAsIdentityMappingStoreName = IdentityMappingStoreName.FromProjectLocationIdentityMappingStore("[PROJECT]", "[LOCATION]", "[IDENTITY_MAPPING_STORE]"),
    InlineSource = new PurgeIdentityMappingsRequest.Types.InlineSource(),
    Filter = "",
    Force = false,
};
// Make the request
Operation<Empty, IdentityMappingEntryOperationMetadata> response = await identityMappingStoreServiceClient.PurgeIdentityMappingsAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, IdentityMappingEntryOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, IdentityMappingEntryOperationMetadata> retrievedResponse = await identityMappingStoreServiceClient.PollOncePurgeIdentityMappingsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.