# Google Cloud Discovery Engine V1 Client - Class IdentityMappingStoreServiceClient (1.11.1)

1.11.1 (latest) 1.11.0 1.10.1 1.9.1 1.8.0 1.7.0 1.6.1 1.5.1 1.4.0 1.3.3 1.2.0 1.1.0 1.0.0 0.11.3 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.1 Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class IdentityMappingStoreServiceClient.

Service Description: Service for managing Identity Mapping Stores.

This class provides the ability to make remote calls to the backing service through method
calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To
assist with these names, this class includes a format method for each type of
name, and additionally a parseName method to extract the individual identifiers
contained within formatted names that are returned by the API.

## Namespace

Google \\ Cloud \\ DiscoveryEngine \\ V1 \\ Client

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `options` | `array|https://docs.cloud.google.com/php/docs/reference/gax/latest/Options.ClientOptions.html` Optional. Options for configuring the service API wrapper. |
| `↳ apiEndpoint` | `string` The address of the API remote host. May optionally include the port, formatted as " |
| `↳ credentials` | `https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html|https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html` This option should only be used with a pre-constructed [Google\\Auth\\FetchAuthTokenInterface](https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html) or [Google\\ApiCore\\CredentialsWrapper](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html) object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important** : If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\DiscoveryEngine\V1\IdentityMappingStoreServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new IdentityMappingStoreServiceClient(['credentials' => $creds]);` <https://cloud.google.com/docs/authentication/external/externally-sourced-credentials> |
| `↳ credentialsConfig` | `array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see [Google\\ApiCore\\CredentialsWrapper::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html#_Google_ApiCore_CredentialsWrapper__build__) . |
| `↳ disableRetries` | `bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`. |
| `↳ clientConfig` | `string|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
| `↳ transport` | `string|https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage* : Additionally, it is possible to pass in an already instantiated [Google\\ApiCore\\Transport\\TransportInterface](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html) object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored. |
| `↳ transportConfig` | `array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = \[ 'grpc' =\> \[...\], 'rest' =\> \[...\], \]; See the [Google\\ApiCore\\Transport\\GrpcTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.GrpcTransport.html#_Google_ApiCore_Transport_GrpcTransport__build__) and [Google\\ApiCore\\Transport\\RestTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_Google_ApiCore_Transport_RestTransport__build__) methods for the supported options. |
| `↳ clientCertSource` | `callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
| `↳ logger` | `false|Psr\Log\LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
| `↳ universeDomain` | `string` The service domain for the client. Defaults to 'googleapis.com'. |

### createIdentityMappingStore

Creates a new Identity Mapping Store.

The async variant is
[IdentityMappingStoreServiceClient::createIdentityMappingStoreAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.IdentityMappingStoreServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_IdentityMappingStoreServiceClient__createIdentityMappingStoreAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.CreateIdentityMappingStoreRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.IdentityMappingStore` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\DiscoveryEngine\V1\Client\IdentityMappingStoreServiceClient;
    use Google\Cloud\DiscoveryEngine\V1\CreateIdentityMappingStoreRequest;
    use Google\Cloud\DiscoveryEngine\V1\IdentityMappingStore;

    /**
     * @param string $formattedParent        The parent collection resource name, such as
     *                                       `projects/{project}/locations/{location}`. Please see
     *                                       {@see IdentityMappingStoreServiceClient::locationName()} for help formatting this field.
     * @param string $identityMappingStoreId 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.
     */
    function create_identity_mapping_store_sample(
        string $formattedParent,
        string $identityMappingStoreId
    ): void {
        // Create a client.
        $identityMappingStoreServiceClient = new IdentityMappingStoreServiceClient();

        // Prepare the request message.
        $identityMappingStore = new IdentityMappingStore();
        $request = (new CreateIdentityMappingStoreRequest())
            ->setParent($formattedParent)
            ->setIdentityMappingStoreId($identityMappingStoreId)
            ->setIdentityMappingStore($identityMappingStore);

        // Call the API and handle any network failures.
        try {
            /** @var IdentityMappingStore $response */
            $response = $identityMappingStoreServiceClient->createIdentityMappingStore($request);
            printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedParent = IdentityMappingStoreServiceClient::locationName('[PROJECT]', '[LOCATION]');
        $identityMappingStoreId = '[IDENTITY_MAPPING_STORE_ID]';

        create_identity_mapping_store_sample($formattedParent, $identityMappingStoreId);
    }

### deleteIdentityMappingStore

Deletes the Identity Mapping Store.

The async variant is
[IdentityMappingStoreServiceClient::deleteIdentityMappingStoreAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.IdentityMappingStoreServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_IdentityMappingStoreServiceClient__deleteIdentityMappingStoreAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.DeleteIdentityMappingStoreRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<null>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\DiscoveryEngine\V1\Client\IdentityMappingStoreServiceClient;
    use Google\Cloud\DiscoveryEngine\V1\DeleteIdentityMappingStoreRequest;
    use Google\Rpc\Status;

    /**
     * @param string $formattedName The name of the Identity Mapping Store to delete.
     *                              Format:
     *                              `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
     *                              Please see {@see IdentityMappingStoreServiceClient::identityMappingStoreName()} for help formatting this field.
     */
    function delete_identity_mapping_store_sample(string $formattedName): void
    {
        // Create a client.
        $identityMappingStoreServiceClient = new IdentityMappingStoreServiceClient();

        // Prepare the request message.
        $request = (new DeleteIdentityMappingStoreRequest())
            ->setName($formattedName);

        // Call the API and handle any network failures.
        try {
            /** @var OperationResponse $response */
            $response = $identityMappingStoreServiceClient->deleteIdentityMappingStore($request);
            $response->pollUntilComplete();

            if ($response->operationSucceeded()) {
                printf('Operation completed successfully.' . PHP_EOL);
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedName = IdentityMappingStoreServiceClient::identityMappingStoreName(
            '[PROJECT]',
            '[LOCATION]',
            '[IDENTITY_MAPPING_STORE]'
        );

        delete_identity_mapping_store_sample($formattedName);
    }

### getIdentityMappingStore

Gets the Identity Mapping Store.

The async variant is
[IdentityMappingStoreServiceClient::getIdentityMappingStoreAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.IdentityMappingStoreServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_IdentityMappingStoreServiceClient__getIdentityMappingStoreAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.GetIdentityMappingStoreRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.IdentityMappingStore` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\DiscoveryEngine\V1\Client\IdentityMappingStoreServiceClient;
    use Google\Cloud\DiscoveryEngine\V1\GetIdentityMappingStoreRequest;
    use Google\Cloud\DiscoveryEngine\V1\IdentityMappingStore;

    /**
     * @param string $formattedName The name of the Identity Mapping Store to get.
     *                              Format:
     *                              `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
     *                              Please see {@see IdentityMappingStoreServiceClient::identityMappingStoreName()} for help formatting this field.
     */
    function get_identity_mapping_store_sample(string $formattedName): void
    {
        // Create a client.
        $identityMappingStoreServiceClient = new IdentityMappingStoreServiceClient();

        // Prepare the request message.
        $request = (new GetIdentityMappingStoreRequest())
            ->setName($formattedName);

        // Call the API and handle any network failures.
        try {
            /** @var IdentityMappingStore $response */
            $response = $identityMappingStoreServiceClient->getIdentityMappingStore($request);
            printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedName = IdentityMappingStoreServiceClient::identityMappingStoreName(
            '[PROJECT]',
            '[LOCATION]',
            '[IDENTITY_MAPPING_STORE]'
        );

        get_identity_mapping_store_sample($formattedName);
    }

### importIdentityMappings

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

The async variant is
[IdentityMappingStoreServiceClient::importIdentityMappingsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.IdentityMappingStoreServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_IdentityMappingStoreServiceClient__importIdentityMappingsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.ImportIdentityMappingsRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.ImportIdentityMappingsResponse>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\DiscoveryEngine\V1\Client\IdentityMappingStoreServiceClient;
    use Google\Cloud\DiscoveryEngine\V1\ImportIdentityMappingsRequest;
    use Google\Cloud\DiscoveryEngine\V1\ImportIdentityMappingsResponse;
    use Google\Rpc\Status;

    /**
     * @param string $formattedIdentityMappingStore The name of the Identity Mapping Store to import Identity Mapping
     *                                              Entries to. Format:
     *                                              `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
     *                                              Please see {@see IdentityMappingStoreServiceClient::identityMappingStoreName()} for help formatting this field.
     */
    function import_identity_mappings_sample(string $formattedIdentityMappingStore): void
    {
        // Create a client.
        $identityMappingStoreServiceClient = new IdentityMappingStoreServiceClient();

        // Prepare the request message.
        $request = (new ImportIdentityMappingsRequest())
            ->setIdentityMappingStore($formattedIdentityMappingStore);

        // Call the API and handle any network failures.
        try {
            /** @var OperationResponse $response */
            $response = $identityMappingStoreServiceClient->importIdentityMappings($request);
            $response->pollUntilComplete();

            if ($response->operationSucceeded()) {
                /** @var ImportIdentityMappingsResponse $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedIdentityMappingStore = IdentityMappingStoreServiceClient::identityMappingStoreName(
            '[PROJECT]',
            '[LOCATION]',
            '[IDENTITY_MAPPING_STORE]'
        );

        import_identity_mappings_sample($formattedIdentityMappingStore);
    }

### listIdentityMappingStores

Lists all Identity Mapping Stores.

The async variant is
[IdentityMappingStoreServiceClient::listIdentityMappingStoresAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.IdentityMappingStoreServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_IdentityMappingStoreServiceClient__listIdentityMappingStoresAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.ListIdentityMappingStoresRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\DiscoveryEngine\V1\Client\IdentityMappingStoreServiceClient;
    use Google\Cloud\DiscoveryEngine\V1\IdentityMappingStore;
    use Google\Cloud\DiscoveryEngine\V1\ListIdentityMappingStoresRequest;

    /**
     * @param string $formattedParent The parent of the Identity Mapping Stores to list.
     *                                Format:
     *                                `projects/{project}/locations/{location}`. Please see
     *                                {@see IdentityMappingStoreServiceClient::locationName()} for help formatting this field.
     */
    function list_identity_mapping_stores_sample(string $formattedParent): void
    {
        // Create a client.
        $identityMappingStoreServiceClient = new IdentityMappingStoreServiceClient();

        // Prepare the request message.
        $request = (new ListIdentityMappingStoresRequest())
            ->setParent($formattedParent);

        // Call the API and handle any network failures.
        try {
            /** @var PagedListResponse $response */
            $response = $identityMappingStoreServiceClient->listIdentityMappingStores($request);

            /** @var IdentityMappingStore $element */
            foreach ($response as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedParent = IdentityMappingStoreServiceClient::locationName('[PROJECT]', '[LOCATION]');

        list_identity_mapping_stores_sample($formattedParent);
    }

### listIdentityMappings

Lists Identity Mappings in an Identity Mapping Store.

The async variant is
[IdentityMappingStoreServiceClient::listIdentityMappingsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.IdentityMappingStoreServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_IdentityMappingStoreServiceClient__listIdentityMappingsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.ListIdentityMappingsRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\DiscoveryEngine\V1\Client\IdentityMappingStoreServiceClient;
    use Google\Cloud\DiscoveryEngine\V1\IdentityMappingEntry;
    use Google\Cloud\DiscoveryEngine\V1\ListIdentityMappingsRequest;

    /**
     * @param string $formattedIdentityMappingStore The name of the Identity Mapping Store to list Identity Mapping
     *                                              Entries in. Format:
     *                                              `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
     *                                              Please see {@see IdentityMappingStoreServiceClient::identityMappingStoreName()} for help formatting this field.
     */
    function list_identity_mappings_sample(string $formattedIdentityMappingStore): void
    {
        // Create a client.
        $identityMappingStoreServiceClient = new IdentityMappingStoreServiceClient();

        // Prepare the request message.
        $request = (new ListIdentityMappingsRequest())
            ->setIdentityMappingStore($formattedIdentityMappingStore);

        // Call the API and handle any network failures.
        try {
            /** @var PagedListResponse $response */
            $response = $identityMappingStoreServiceClient->listIdentityMappings($request);

            /** @var IdentityMappingEntry $element */
            foreach ($response as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedIdentityMappingStore = IdentityMappingStoreServiceClient::identityMappingStoreName(
            '[PROJECT]',
            '[LOCATION]',
            '[IDENTITY_MAPPING_STORE]'
        );

        list_identity_mappings_sample($formattedIdentityMappingStore);
    }

### purgeIdentityMappings

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

The async variant is
[IdentityMappingStoreServiceClient::purgeIdentityMappingsAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.IdentityMappingStoreServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_IdentityMappingStoreServiceClient__purgeIdentityMappingsAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.PurgeIdentityMappingsRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<null>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\DiscoveryEngine\V1\Client\IdentityMappingStoreServiceClient;
    use Google\Cloud\DiscoveryEngine\V1\PurgeIdentityMappingsRequest;
    use Google\Rpc\Status;

    /**
     * @param string $formattedIdentityMappingStore The name of the Identity Mapping Store to purge Identity Mapping
     *                                              Entries from. Format:
     *                                              `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
     *                                              Please see {@see IdentityMappingStoreServiceClient::identityMappingStoreName()} for help formatting this field.
     */
    function purge_identity_mappings_sample(string $formattedIdentityMappingStore): void
    {
        // Create a client.
        $identityMappingStoreServiceClient = new IdentityMappingStoreServiceClient();

        // Prepare the request message.
        $request = (new PurgeIdentityMappingsRequest())
            ->setIdentityMappingStore($formattedIdentityMappingStore);

        // Call the API and handle any network failures.
        try {
            /** @var OperationResponse $response */
            $response = $identityMappingStoreServiceClient->purgeIdentityMappings($request);
            $response->pollUntilComplete();

            if ($response->operationSucceeded()) {
                printf('Operation completed successfully.' . PHP_EOL);
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedIdentityMappingStore = IdentityMappingStoreServiceClient::identityMappingStoreName(
            '[PROJECT]',
            '[LOCATION]',
            '[IDENTITY_MAPPING_STORE]'
        );

        purge_identity_mappings_sample($formattedIdentityMappingStore);
    }

### createIdentityMappingStoreAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.CreateIdentityMappingStoreRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.IdentityMappingStore>` |   |

### deleteIdentityMappingStoreAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.DeleteIdentityMappingStoreRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### getIdentityMappingStoreAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.GetIdentityMappingStoreRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.IdentityMappingStore>` |   |

### importIdentityMappingsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.ImportIdentityMappingsRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### listIdentityMappingStoresAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.ListIdentityMappingStoresRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### listIdentityMappingsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.ListIdentityMappingsRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### purgeIdentityMappingsAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.PurgeIdentityMappingsRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\LongRunning\Client\OperationsClient` |   |

### resumeOperation

Resume an existing long running operation that was previously started by a long
running API method. If $methodName is not provided, or does not match a long
running API method, then the operation can still be resumed, but the
OperationResponse object will not deserialize the final response.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `operationName` | `string` The name of the long running operation |
| `methodName` | `string` The name of the method used to start the operation |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html` |   |

### static::cmekConfigName

Formats a string containing the fully-qualified path to represent a cmek_config
resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted cmek_config resource. |

### static::cryptoKeyVersionsName

Formats a string containing the fully-qualified path to represent a
crypto_key_versions resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `keyRing` | `string` |
| `cryptoKey` | `string` |
| `cryptoKeyVersion` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted crypto_key_versions resource. |

### static::cryptoKeysName

Formats a string containing the fully-qualified path to represent a crypto_keys
resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `keyRing` | `string` |
| `cryptoKey` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted crypto_keys resource. |

### static::identityMappingStoreName

Formats a string containing the fully-qualified path to represent a
identity_mapping_store resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |
| `identityMappingStore` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted identity_mapping_store resource. |

### static::locationName

Formats a string containing the fully-qualified path to represent a location
resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted location resource. |

### static::projectLocationCmekConfigName

Formats a string containing the fully-qualified path to represent a
project_location_cmekConfig resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `project` | `string` |
| `location` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted project_location_cmekConfig resource. |

### static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported:
Template: Pattern

- cmekConfig: projects/{project}/locations/{location}/cmekConfig
- cryptoKeyVersions: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
- cryptoKeys: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- identityMappingStore: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}
- location: projects/{project}/locations/{location}
- projectLocationCmekConfig: projects/{project}/locations/{location}/cmekConfig

The optional $template argument can be supplied to specify a particular pattern,
and must match one of the templates listed above. If no $template argument is
provided, or if the $template argument does not match one of the templates
listed, then parseName will check each of the supported templates, and return
the first match.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `formattedName` | `string` The formatted name string |
| `template` | `?string` Optional name of template to match |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `array` | An associative array from name component IDs to component values. |