Google Cloud Discovery Engine V1 Client - Class IdentityMappingStoreServiceClient (1.6.0)

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}