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. Sample code to get started:
$endpointServiceClient = new EndpointServiceClient();
try {
$formattedParent = $endpointServiceClient->locationName('[PROJECT]', '[LOCATION]');
$endpoint = new Endpoint();
$operationResponse = $endpointServiceClient->createEndpoint($formattedParent, $endpoint);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $endpointServiceClient->createEndpoint($formattedParent, $endpoint);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $endpointServiceClient->resumeOperation($operationName, 'createEndpoint');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$endpointServiceClient->close();
}
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.
Methods
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. |
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. |
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. |
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. |
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. |
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
- 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}
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. |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\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 |
__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 |
↳ 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 |
↳ 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. |
createEndpoint
Creates an Endpoint.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location to create the Endpoint in.
Format: |
endpoint |
Google\Cloud\AIPlatform\V1\Endpoint
Required. The Endpoint to create. |
optionalArgs |
array
Optional. |
↳ endpointId |
string
Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are /[0-9]/. When using HTTP/JSON, this field is populated based on a query string argument, such as |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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 any non-scalar elements to be passed along with the request.
$endpoint = (new Endpoint())
->setDisplayName($endpointDisplayName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $endpointServiceClient->createEndpoint($formattedParent, $endpoint);
$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());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Endpoint resource to be deleted.
Format:
|
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $endpointServiceClient->deleteEndpoint($formattedName);
$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());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
endpoint |
string
Required. The name of the Endpoint resource into which to deploy a Model.
Format:
|
deployedModel |
Google\Cloud\AIPlatform\V1\DeployedModel
Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint. |
optionalArgs |
array
Optional. |
↳ trafficSplit |
array
A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If this field is non-empty, then the Endpoint's traffic_split will be overwritten with it. To refer to the ID of the just being deployed Model, a "0" should be used, and the actual ID of the new DeployedModel will be filled in its place by this method. The traffic percentage values must add up to 100. If this field is empty, then the Endpoint's traffic_split is not updated. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\DeployModelResponse;
use Google\Cloud\AIPlatform\V1\DeployedModel;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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, 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 any non-scalar elements to be passed along with the request.
$deployedModel = (new DeployedModel())
->setModel($formattedDeployedModelModel);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $endpointServiceClient->deployModel($formattedEndpoint, $deployedModel);
$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());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Endpoint resource.
Format:
|
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var Endpoint $response */
$response = $endpointServiceClient->getEndpoint($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location from which to list the
Endpoints. Format: |
optionalArgs |
array
Optional. |
↳ filter |
string
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ readMask |
FieldMask
Optional. Mask specifying which fields to read. |
↳ orderBy |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $endpointServiceClient->listEndpoints($formattedParent);
/** @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());
}
}
/**
* 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);
}
undeployModel
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
Parameters | |
---|---|
Name | Description |
endpoint |
string
Required. The name of the Endpoint resource from which to undeploy a Model.
Format:
|
deployedModelId |
string
Required. The ID of the DeployedModel to be undeployed from the Endpoint. |
optionalArgs |
array
Optional. |
↳ trafficSplit |
array
If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $endpointServiceClient->undeployModel($formattedEndpoint, $deployedModelId);
$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());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
endpoint |
Google\Cloud\AIPlatform\V1\Endpoint
Required. The Endpoint which replaces the resource on the server. |
updateMask |
Google\Protobuf\FieldMask
Required. The update mask applies to the resource. See google.protobuf.FieldMask. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Endpoint;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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 any non-scalar elements to be passed along with the request.
$endpoint = (new Endpoint())
->setDisplayName($endpointDisplayName);
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var Endpoint $response */
$response = $endpointServiceClient->updateEndpoint($endpoint, $updateMask);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
getLocation
Gets information about a location.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $endpointServiceClient->getLocation();
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.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $endpointServiceClient->listLocations();
/** @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.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $endpointServiceClient->getIamPolicy($resource);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
use Google\Cloud\Iam\V1\Policy;
/**
* @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 any non-scalar elements to be passed along with the request.
$policy = new Policy();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $endpointServiceClient->setIamPolicy($resource, $policy);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
string[]
The set of permissions to check for the |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\EndpointServiceClient;
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 any non-scalar elements to be passed along with the request.
$permissions = [$permissionsElement,];
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $endpointServiceClient->testIamPermissions($resource, $permissions);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
Constants
SERVICE_NAME
Value: 'google.cloud.aiplatform.v1.EndpointService'
The name of the service.
SERVICE_ADDRESS
Value: 'aiplatform.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.