Google Cloud Api Keys V2 Client - Class ApiKeysClient (1.0.1)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\CreateKeyRequest;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The project in which the API key is created. Please see
 *                                {@see ApiKeysClient::locationName()} for help formatting this field.
 */
function create_key_sample(string $formattedParent): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

    // Prepare the request message.
    $key = new Key();
    $request = (new CreateKeyRequest())
        ->setParent($formattedParent)
        ->setKey($key);

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

        if ($response->operationSucceeded()) {
            /** @var Key $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
{
    $formattedParent = ApiKeysClient::locationName('[PROJECT]', '[LOCATION]');

    create_key_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\DeleteKeyRequest;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the API key to be deleted. Please see
 *                              {@see ApiKeysClient::keyName()} for help formatting this field.
 */
function delete_key_sample(string $formattedName): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var Key $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
{
    $formattedName = ApiKeysClient::keyName('[PROJECT]', '[LOCATION]', '[KEY]');

    delete_key_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\GetKeyRequest;
use Google\Cloud\ApiKeys\V2\Key;

/**
 * @param string $formattedName The resource name of the API key to get. Please see
 *                              {@see ApiKeysClient::keyName()} for help formatting this field.
 */
function get_key_sample(string $formattedName): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Key $response */
        $response = $apiKeysClient->getKey($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 = ApiKeysClient::keyName('[PROJECT]', '[LOCATION]', '[KEY]');

    get_key_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\GetKeyStringRequest;
use Google\Cloud\ApiKeys\V2\GetKeyStringResponse;

/**
 * @param string $formattedName The resource name of the API key to be retrieved. Please see
 *                              {@see ApiKeysClient::keyName()} for help formatting this field.
 */
function get_key_string_sample(string $formattedName): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var GetKeyStringResponse $response */
        $response = $apiKeysClient->getKeyString($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 = ApiKeysClient::keyName('[PROJECT]', '[LOCATION]', '[KEY]');

    get_key_string_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Cloud\ApiKeys\V2\ListKeysRequest;

/**
 * @param string $formattedParent Lists all API keys associated with this project. Please see
 *                                {@see ApiKeysClient::locationName()} for help formatting this field.
 */
function list_keys_sample(string $formattedParent): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

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

        /** @var Key $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 = ApiKeysClient::locationName('[PROJECT]', '[LOCATION]');

    list_keys_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\LookupKeyRequest;
use Google\Cloud\ApiKeys\V2\LookupKeyResponse;

/**
 * @param string $keyString Finds the project that owns the key string value.
 */
function lookup_key_sample(string $keyString): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

    // Prepare the request message.
    $request = (new LookupKeyRequest())
        ->setKeyString($keyString);

    // Call the API and handle any network failures.
    try {
        /** @var LookupKeyResponse $response */
        $response = $apiKeysClient->lookupKey($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
{
    $keyString = '[KEY_STRING]';

    lookup_key_sample($keyString);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Cloud\ApiKeys\V2\UndeleteKeyRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the API key to be undeleted. Please see
 *                              {@see ApiKeysClient::keyName()} for help formatting this field.
 */
function undelete_key_sample(string $formattedName): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var Key $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
{
    $formattedName = ApiKeysClient::keyName('[PROJECT]', '[LOCATION]', '[KEY]');

    undelete_key_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiKeys\V2\Client\ApiKeysClient;
use Google\Cloud\ApiKeys\V2\Key;
use Google\Cloud\ApiKeys\V2\UpdateKeyRequest;
use Google\Rpc\Status;

/**
 * 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 update_key_sample(): void
{
    // Create a client.
    $apiKeysClient = new ApiKeysClient();

    // Prepare the request message.
    $key = new Key();
    $request = (new UpdateKeyRequest())
        ->setKey($key);

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

        if ($response->operationSucceeded()) {
            /** @var Key $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());
    }
}