Google Cloud Ai Platform V1 Client - Class PersistentResourceServiceClient (1.12.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PersistentResourceServiceClient.

Service Description: A service for managing Vertex AI's machine learning PersistentResource.

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 \ AIPlatform \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` 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`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ 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() .
`↳ 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\|TransportInterface` 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 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() and 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.

createPersistentResource

Creates a PersistentResource.

The async variant is PersistentResourceServiceClient::createPersistentResourceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreatePersistentResourceRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\AIPlatform\V1\CreatePersistentResourceRequest;
use Google\Cloud\AIPlatform\V1\MachineSpec;
use Google\Cloud\AIPlatform\V1\PersistentResource;
use Google\Cloud\AIPlatform\V1\ResourcePool;
use Google\Rpc\Status;

/**
 * @param string $formattedParent      The resource name of the Location to create the
 *                                     PersistentResource in. Format: `projects/{project}/locations/{location}`
 *                                     Please see {@see PersistentResourceServiceClient::locationName()} for help formatting this field.
 * @param string $persistentResourceId The ID to use for the PersistentResource, which become the final
 *                                     component of the PersistentResource's resource name.
 *
 *                                     The maximum length is 63 characters, and valid characters
 *                                     are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
 */
function create_persistent_resource_sample(
    string $formattedParent,
    string $persistentResourceId
): void {
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

    // Prepare the request message.
    $persistentResourceResourcePoolsMachineSpec = new MachineSpec();
    $resourcePool = (new ResourcePool())
        ->setMachineSpec($persistentResourceResourcePoolsMachineSpec);
    $persistentResourceResourcePools = [$resourcePool,];
    $persistentResource = (new PersistentResource())
        ->setResourcePools($persistentResourceResourcePools);
    $request = (new CreatePersistentResourceRequest())
        ->setParent($formattedParent)
        ->setPersistentResource($persistentResource)
        ->setPersistentResourceId($persistentResourceId);

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

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

    create_persistent_resource_sample($formattedParent, $persistentResourceId);
}

deletePersistentResource

Deletes a PersistentResource.

The async variant is PersistentResourceServiceClient::deletePersistentResourceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeletePersistentResourceRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\AIPlatform\V1\DeletePersistentResourceRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the PersistentResource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
 *                              Please see {@see PersistentResourceServiceClient::persistentResourceName()} for help formatting this field.
 */
function delete_persistent_resource_sample(string $formattedName): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $persistentResourceServiceClient->deletePersistentResource($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 = PersistentResourceServiceClient::persistentResourceName(
        '[PROJECT]',
        '[LOCATION]',
        '[PERSISTENT_RESOURCE]'
    );

    delete_persistent_resource_sample($formattedName);
}

getPersistentResource

Gets a PersistentResource.

The async variant is PersistentResourceServiceClient::getPersistentResourceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetPersistentResourceRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\PersistentResource`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\AIPlatform\V1\GetPersistentResourceRequest;
use Google\Cloud\AIPlatform\V1\PersistentResource;

/**
 * @param string $formattedName The name of the PersistentResource resource.
 *                              Format:
 *                              `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
 *                              Please see {@see PersistentResourceServiceClient::persistentResourceName()} for help formatting this field.
 */
function get_persistent_resource_sample(string $formattedName): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PersistentResource $response */
        $response = $persistentResourceServiceClient->getPersistentResource($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 = PersistentResourceServiceClient::persistentResourceName(
        '[PROJECT]',
        '[LOCATION]',
        '[PERSISTENT_RESOURCE]'
    );

    get_persistent_resource_sample($formattedName);
}

listPersistentResources

Lists PersistentResources in a Location.

The async variant is PersistentResourceServiceClient::listPersistentResourcesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListPersistentResourcesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\AIPlatform\V1\ListPersistentResourcesRequest;
use Google\Cloud\AIPlatform\V1\PersistentResource;

/**
 * @param string $formattedParent The resource name of the Location to list the PersistentResources
 *                                from. Format: `projects/{project}/locations/{location}`
 *                                Please see {@see PersistentResourceServiceClient::locationName()} for help formatting this field.
 */
function list_persistent_resources_sample(string $formattedParent): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

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

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

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

    list_persistent_resources_sample($formattedParent);
}

rebootPersistentResource

Reboots a PersistentResource.

The async variant is PersistentResourceServiceClient::rebootPersistentResourceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\RebootPersistentResourceRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\AIPlatform\V1\PersistentResource;
use Google\Cloud\AIPlatform\V1\RebootPersistentResourceRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the PersistentResource resource.
 *                              Format:
 *                              `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
 *                              Please see {@see PersistentResourceServiceClient::persistentResourceName()} for help formatting this field.
 */
function reboot_persistent_resource_sample(string $formattedName): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var PersistentResource $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 = PersistentResourceServiceClient::persistentResourceName(
        '[PROJECT]',
        '[LOCATION]',
        '[PERSISTENT_RESOURCE]'
    );

    reboot_persistent_resource_sample($formattedName);
}

updatePersistentResource

Updates a PersistentResource.

The async variant is PersistentResourceServiceClient::updatePersistentResourceAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\UpdatePersistentResourceRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\AIPlatform\V1\MachineSpec;
use Google\Cloud\AIPlatform\V1\PersistentResource;
use Google\Cloud\AIPlatform\V1\ResourcePool;
use Google\Cloud\AIPlatform\V1\UpdatePersistentResourceRequest;
use Google\Protobuf\FieldMask;
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_persistent_resource_sample(): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

    // Prepare the request message.
    $persistentResourceResourcePoolsMachineSpec = new MachineSpec();
    $resourcePool = (new ResourcePool())
        ->setMachineSpec($persistentResourceResourcePoolsMachineSpec);
    $persistentResourceResourcePools = [$resourcePool,];
    $persistentResource = (new PersistentResource())
        ->setResourcePools($persistentResourceResourcePools);
    $updateMask = new FieldMask();
    $request = (new UpdatePersistentResourceRequest())
        ->setPersistentResource($persistentResource)
        ->setUpdateMask($updateMask);

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

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

getLocation

Gets information about a location.

The async variant is PersistentResourceServiceClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

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

listLocations

Lists information about the supported locations for this service.

The async variant is PersistentResourceServiceClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

        /** @var Location $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());
    }
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is PersistentResourceServiceClient::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $persistentResourceServiceClient->getIamPolicy($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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is PersistentResourceServiceClient::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $persistentResourceServiceClient->setIamPolicy($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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is PersistentResourceServiceClient::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\TestIamPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PersistentResourceServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $persistentResourceServiceClient = new PersistentResourceServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $persistentResourceServiceClient->testIamPermissions($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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

createPersistentResourceAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreatePersistentResourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

deletePersistentResourceAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeletePersistentResourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getPersistentResourceAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetPersistentResourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\PersistentResource>`

listPersistentResourcesAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListPersistentResourcesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

rebootPersistentResourceAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\RebootPersistentResourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

updatePersistentResourceAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\UpdatePersistentResourceRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

getIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy>`

setIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy>`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse>`

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
`Google\ApiCore\OperationResponse`

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::networkName

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

Parameters
Name	Description
`project`	`string`
`network`	`string`

Returns
Type	Description
`string`	The formatted network resource.

static::persistentResourceName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`persistentResource`	`string`

Returns
Type	Description
`string`	The formatted persistent_resource resource.

static::reservationName

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

Parameters
Name	Description
`projectIdOrNumber`	`string`
`zone`	`string`
`reservationName`	`string`

Returns
Type	Description
`string`	The formatted reservation 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

location: projects/{project}/locations/{location}
network: projects/{project}/global/networks/{network}
persistentResource: projects/{project}/locations/{location}/persistentResources/{persistent_resource}
reservation: projects/{project_id_or_number}/zones/{zone}/reservations/{reservation_name}

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.