Google Cloud Ai Platform V1 Client - Class EndpointServiceClient (1.13.1)

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

Service Description: A service for managing Vertex AI's Endpoints.

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.
↳ logger false|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

createEndpoint

Creates an Endpoint.

The async variant is EndpointServiceClient::createEndpointAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\CreateEndpointRequest

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\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\CreateEndpointRequest;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Rpc\Status;

/**
 * @param string $formattedParent     The resource name of the Location to create the Endpoint in.
 *                                    Format: `projects/{project}/locations/{location}`
 *                                    Please see {@see EndpointServiceClient::locationName()} for help formatting this field.
 * @param string $endpointDisplayName The display name of the Endpoint.
 *                                    The name can be up to 128 characters long and can consist of any UTF-8
 *                                    characters.
 */
function create_endpoint_sample(string $formattedParent, string $endpointDisplayName): void
{
    // Create a client.
    $endpointServiceClient = new EndpointServiceClient();

    // Prepare the request message.
    $endpoint = (new Endpoint())
        ->setDisplayName($endpointDisplayName);
    $request = (new CreateEndpointRequest())
        ->setParent($formattedParent)
        ->setEndpoint($endpoint);

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

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

    create_endpoint_sample($formattedParent, $endpointDisplayName);
}

deleteEndpoint

Deletes an Endpoint.

The async variant is EndpointServiceClient::deleteEndpointAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\DeleteEndpointRequest

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\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteEndpointRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Endpoint resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/endpoints/{endpoint}`
 *                              Please see {@see EndpointServiceClient::endpointName()} for help formatting this field.
 */
function delete_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $endpointServiceClient = new EndpointServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $endpointServiceClient->deleteEndpoint($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 = EndpointServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

    delete_endpoint_sample($formattedName);
}

deployModel

Deploys a Model into this Endpoint, creating a DeployedModel within it.

The async variant is EndpointServiceClient::deployModelAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\DeployModelRequest

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\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\DeployModelRequest;
use Google\Cloud\AIPlatform\V1\DeployModelResponse;
use Google\Cloud\AIPlatform\V1\DeployedModel;
use Google\Rpc\Status;

/**
 * @param string $formattedEndpoint           The name of the Endpoint resource into which to deploy a Model.
 *                                            Format:
 *                                            `projects/{project}/locations/{location}/endpoints/{endpoint}`
 *                                            Please see {@see EndpointServiceClient::endpointName()} for help formatting this field.
 * @param string $formattedDeployedModelModel The resource name of the Model that this is the deployment of.
 *                                            Note that the Model may be in a different location than the DeployedModel's
 *                                            Endpoint.
 *
 *                                            The resource name may contain version id or version alias to specify the
 *                                            version.
 *                                            Example: `projects/{project}/locations/{location}/models/{model}@2`
 *                                            or
 *                                            `projects/{project}/locations/{location}/models/{model}@golden`
 *                                            if no version is specified, the default version will be deployed. Please see
 *                                            {@see EndpointServiceClient::modelName()} for help formatting this field.
 */
function deploy_model_sample(string $formattedEndpoint, string $formattedDeployedModelModel): void
{
    // Create a client.
    $endpointServiceClient = new EndpointServiceClient();

    // Prepare the request message.
    $deployedModel = (new DeployedModel())
        ->setModel($formattedDeployedModelModel);
    $request = (new DeployModelRequest())
        ->setEndpoint($formattedEndpoint)
        ->setDeployedModel($deployedModel);

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

        if ($response->operationSucceeded()) {
            /** @var DeployModelResponse $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
{
    $formattedEndpoint = EndpointServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');
    $formattedDeployedModelModel = EndpointServiceClient::modelName(
        '[PROJECT]',
        '[LOCATION]',
        '[MODEL]'
    );

    deploy_model_sample($formattedEndpoint, $formattedDeployedModelModel);
}

getEndpoint

Gets an Endpoint.

The async variant is EndpointServiceClient::getEndpointAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\GetEndpointRequest

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\Endpoint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Cloud\AIPlatform\V1\GetEndpointRequest;

/**
 * @param string $formattedName The name of the Endpoint resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/endpoints/{endpoint}`
 *                              Please see {@see EndpointServiceClient::endpointName()} for help formatting this field.
 */
function get_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $endpointServiceClient = new EndpointServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Endpoint $response */
        $response = $endpointServiceClient->getEndpoint($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 = EndpointServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

    get_endpoint_sample($formattedName);
}

listEndpoints

Lists Endpoints in a Location.

The async variant is EndpointServiceClient::listEndpointsAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\ListEndpointsRequest

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\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Cloud\AIPlatform\V1\ListEndpointsRequest;

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

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

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

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

    list_endpoints_sample($formattedParent);
}

mutateDeployedModel

Updates an existing deployed model. Updatable fields include min_replica_count, max_replica_count, autoscaling_metric_specs, disable_container_logging (v1 only), and enable_container_logging (v1beta1 only).

The async variant is EndpointServiceClient::mutateDeployedModelAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\MutateDeployedModelRequest

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\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\DeployedModel;
use Google\Cloud\AIPlatform\V1\MutateDeployedModelRequest;
use Google\Cloud\AIPlatform\V1\MutateDeployedModelResponse;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $formattedEndpoint           The name of the Endpoint resource into which to mutate a
 *                                            DeployedModel. Format:
 *                                            `projects/{project}/locations/{location}/endpoints/{endpoint}`
 *                                            Please see {@see EndpointServiceClient::endpointName()} for help formatting this field.
 * @param string $formattedDeployedModelModel The resource name of the Model that this is the deployment of.
 *                                            Note that the Model may be in a different location than the DeployedModel's
 *                                            Endpoint.
 *
 *                                            The resource name may contain version id or version alias to specify the
 *                                            version.
 *                                            Example: `projects/{project}/locations/{location}/models/{model}@2`
 *                                            or
 *                                            `projects/{project}/locations/{location}/models/{model}@golden`
 *                                            if no version is specified, the default version will be deployed. Please see
 *                                            {@see EndpointServiceClient::modelName()} for help formatting this field.
 */
function mutate_deployed_model_sample(
    string $formattedEndpoint,
    string $formattedDeployedModelModel
): void {
    // Create a client.
    $endpointServiceClient = new EndpointServiceClient();

    // Prepare the request message.
    $deployedModel = (new DeployedModel())
        ->setModel($formattedDeployedModelModel);
    $updateMask = new FieldMask();
    $request = (new MutateDeployedModelRequest())
        ->setEndpoint($formattedEndpoint)
        ->setDeployedModel($deployedModel)
        ->setUpdateMask($updateMask);

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

        if ($response->operationSucceeded()) {
            /** @var MutateDeployedModelResponse $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
{
    $formattedEndpoint = EndpointServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');
    $formattedDeployedModelModel = EndpointServiceClient::modelName(
        '[PROJECT]',
        '[LOCATION]',
        '[MODEL]'
    );

    mutate_deployed_model_sample($formattedEndpoint, $formattedDeployedModelModel);
}

undeployModel

Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.

The async variant is EndpointServiceClient::undeployModelAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UndeployModelRequest

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\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\UndeployModelRequest;
use Google\Cloud\AIPlatform\V1\UndeployModelResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedEndpoint The name of the Endpoint resource from which to undeploy a Model.
 *                                  Format:
 *                                  `projects/{project}/locations/{location}/endpoints/{endpoint}`
 *                                  Please see {@see EndpointServiceClient::endpointName()} for help formatting this field.
 * @param string $deployedModelId   The ID of the DeployedModel to be undeployed from the Endpoint.
 */
function undeploy_model_sample(string $formattedEndpoint, string $deployedModelId): void
{
    // Create a client.
    $endpointServiceClient = new EndpointServiceClient();

    // Prepare the request message.
    $request = (new UndeployModelRequest())
        ->setEndpoint($formattedEndpoint)
        ->setDeployedModelId($deployedModelId);

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

        if ($response->operationSucceeded()) {
            /** @var UndeployModelResponse $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
{
    $formattedEndpoint = EndpointServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');
    $deployedModelId = '[DEPLOYED_MODEL_ID]';

    undeploy_model_sample($formattedEndpoint, $deployedModelId);
}

updateEndpoint

Updates an Endpoint.

The async variant is EndpointServiceClient::updateEndpointAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UpdateEndpointRequest

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\Endpoint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Cloud\AIPlatform\V1\UpdateEndpointRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $endpointDisplayName The display name of the Endpoint.
 *                                    The name can be up to 128 characters long and can consist of any UTF-8
 *                                    characters.
 */
function update_endpoint_sample(string $endpointDisplayName): void
{
    // Create a client.
    $endpointServiceClient = new EndpointServiceClient();

    // Prepare the request message.
    $endpoint = (new Endpoint())
        ->setDisplayName($endpointDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateEndpointRequest())
        ->setEndpoint($endpoint)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Endpoint $response */
        $response = $endpointServiceClient->updateEndpoint($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
{
    $endpointDisplayName = '[DISPLAY_NAME]';

    update_endpoint_sample($endpointDisplayName);
}

updateEndpointLongRunning

Updates an Endpoint with a long running operation.

The async variant is EndpointServiceClient::updateEndpointLongRunningAsync() .

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UpdateEndpointLongRunningRequest

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\EndpointServiceClient;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Cloud\AIPlatform\V1\UpdateEndpointLongRunningRequest;
use Google\Rpc\Status;

/**
 * @param string $endpointDisplayName The display name of the Endpoint.
 *                                    The name can be up to 128 characters long and can consist of any UTF-8
 *                                    characters.
 */
function update_endpoint_long_running_sample(string $endpointDisplayName): void
{
    // Create a client.
    $endpointServiceClient = new EndpointServiceClient();

    // Prepare the request message.
    $endpoint = (new Endpoint())
        ->setDisplayName($endpointDisplayName);
    $request = (new UpdateEndpointLongRunningRequest())
        ->setEndpoint($endpoint);

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

        if ($response->operationSucceeded()) {
            /** @var Endpoint $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
{
    $endpointDisplayName = '[DISPLAY_NAME]';

    update_endpoint_long_running_sample($endpointDisplayName);
}

getLocation

Gets information about a location.

The async variant is EndpointServiceClient::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\EndpointServiceClient;
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.
    $endpointServiceClient = new EndpointServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $endpointServiceClient->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 EndpointServiceClient::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\EndpointServiceClient;
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.
    $endpointServiceClient = new EndpointServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $endpointServiceClient->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 EndpointServiceClient::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\EndpointServiceClient;
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.
    $endpointServiceClient = new EndpointServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $endpointServiceClient->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 EndpointServiceClient::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\EndpointServiceClient;
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.
    $endpointServiceClient = new EndpointServiceClient();

    // 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 = $endpointServiceClient->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 EndpointServiceClient::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\EndpointServiceClient;
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.
    $endpointServiceClient = new EndpointServiceClient();

    // 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 = $endpointServiceClient->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);
}

createEndpointAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\CreateEndpointRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteEndpointAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\DeleteEndpointRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deployModelAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\DeployModelRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getEndpointAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\GetEndpointRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\Endpoint>

listEndpointsAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\ListEndpointsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

mutateDeployedModelAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\MutateDeployedModelRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

undeployModelAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UndeployModelRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

updateEndpointAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UpdateEndpointRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\AIPlatform\V1\Endpoint>

updateEndpointLongRunningAsync

Parameters
Name Description
request Google\Cloud\AIPlatform\V1\UpdateEndpointLongRunningRequest
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::deploymentResourcePoolName

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

Parameters
Name Description
project string
location string
deploymentResourcePool string
Returns
Type Description
string The formatted deployment_resource_pool resource.

static::endpointName

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

Parameters
Name Description
project string
location string
endpoint string
Returns
Type Description
string The formatted endpoint 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::modelName

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

Parameters
Name Description
project string
location string
model string
Returns
Type Description
string The formatted model resource.

static::modelDeploymentMonitoringJobName

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

Parameters
Name Description
project string
location string
modelDeploymentMonitoringJob string
Returns
Type Description
string The formatted model_deployment_monitoring_job 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::projectLocationEndpointName

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

Parameters
Name Description
project string
location string
endpoint string
Returns
Type Description
string The formatted project_location_endpoint resource.

static::projectLocationPublisherModelName

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

Parameters
Name Description
project string
location string
publisher string
model string
Returns
Type Description
string The formatted project_location_publisher_model 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

  • deploymentResourcePool: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
  • endpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
  • location: projects/{project}/locations/{location}
  • model: projects/{project}/locations/{location}/models/{model}
  • modelDeploymentMonitoringJob: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}
  • network: projects/{project}/global/networks/{network}
  • projectLocationEndpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
  • projectLocationPublisherModel: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}
  • 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.