Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ModelServiceClient.
Service Description: A service for managing Vertex AI's machine learning Models.
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:
$modelServiceClient = new ModelServiceClient();
try {
$formattedParent = $modelServiceClient->modelEvaluationName('[PROJECT]', '[LOCATION]', '[MODEL]', '[EVALUATION]');
$modelEvaluationSlices = [];
$response = $modelServiceClient->batchImportModelEvaluationSlices($formattedParent, $modelEvaluationSlices);
} finally {
$modelServiceClient->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
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. |
modelEvaluationName
Formats a string containing the fully-qualified path to represent a model_evaluation resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
model |
string
|
evaluation |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted model_evaluation resource. |
modelEvaluationSliceName
Formats a string containing the fully-qualified path to represent a model_evaluation_slice resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
model |
string
|
evaluation |
string
|
slice |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted model_evaluation_slice resource. |
trainingPipelineName
Formats a string containing the fully-qualified path to represent a training_pipeline resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
trainingPipeline |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted training_pipeline 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
- location: projects/{project}/locations/{location}
- model: projects/{project}/locations/{location}/models/{model}
- modelEvaluation: projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}
- modelEvaluationSlice: projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}
- trainingPipeline: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
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. |
batchImportModelEvaluationSlices
Imports a list of externally generated ModelEvaluationSlice.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The name of the parent ModelEvaluation resource.
Format:
|
modelEvaluationSlices |
array<Google\Cloud\AIPlatform\V1\ModelEvaluationSlice>
Required. Model evaluation slice resource to be imported. |
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\BatchImportModelEvaluationSlicesResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\BatchImportModelEvaluationSlicesResponse;
use Google\Cloud\AIPlatform\V1\ModelEvaluationSlice;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedParent The name of the parent ModelEvaluation resource.
* Format:
* `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
* Please see {@see ModelServiceClient::modelEvaluationName()} for help formatting this field.
*/
function batch_import_model_evaluation_slices_sample(string $formattedParent): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$modelEvaluationSlices = [new ModelEvaluationSlice()];
// Call the API and handle any network failures.
try {
/** @var BatchImportModelEvaluationSlicesResponse $response */
$response = $modelServiceClient->batchImportModelEvaluationSlices(
$formattedParent,
$modelEvaluationSlices
);
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
{
$formattedParent = ModelServiceClient::modelEvaluationName(
'[PROJECT]',
'[LOCATION]',
'[MODEL]',
'[EVALUATION]'
);
batch_import_model_evaluation_slices_sample($formattedParent);
}
copyModel
Copies an already existing Vertex AI Model into the specified Location.
The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location into which to copy the Model.
Format: |
sourceModel |
string
Required. The resource name of the Model to copy. That Model must be in the
same Project. Format:
|
optionalArgs |
array
Optional. |
↳ modelId |
string
Optional. Copy source_model into a new Model with this ID. The ID will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are |
↳ parentModel |
string
Optional. Specify this field to copy source_model into this existing Model as a new version. Format: |
↳ encryptionSpec |
EncryptionSpec
Customer-managed encryption key options. If this is set, then the Model copy will be encrypted with the provided encryption key. |
↳ 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\CopyModelResponse;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the Location into which to copy the Model.
* Format: `projects/{project}/locations/{location}`
* Please see {@see ModelServiceClient::locationName()} for help formatting this field.
* @param string $formattedSourceModel The resource name of the Model to copy. That Model must be in the
* same Project. Format:
* `projects/{project}/locations/{location}/models/{model}`
* Please see {@see ModelServiceClient::modelName()} for help formatting this field.
*/
function copy_model_sample(string $formattedParent, string $formattedSourceModel): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $modelServiceClient->copyModel($formattedParent, $formattedSourceModel);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var CopyModelResponse $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 = ModelServiceClient::locationName('[PROJECT]', '[LOCATION]');
$formattedSourceModel = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
copy_model_sample($formattedParent, $formattedSourceModel);
}
deleteModel
Deletes a Model.
A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Model 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\ModelServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the Model resource to be deleted.
* Format: `projects/{project}/locations/{location}/models/{model}`
* Please see {@see ModelServiceClient::modelName()} for help formatting this field.
*/
function delete_model_sample(string $formattedName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $modelServiceClient->deleteModel($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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
delete_model_sample($formattedName);
}
deleteModelVersion
Deletes a Model version.
Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the model version to be deleted, with a version ID explicitly included. Example: |
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\ModelServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the model version to be deleted, with a version ID
* explicitly included.
*
* Example: `projects/{project}/locations/{location}/models/{model}@1234`
* Please see {@see ModelServiceClient::modelName()} for help formatting this field.
*/
function delete_model_version_sample(string $formattedName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $modelServiceClient->deleteModelVersion($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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
delete_model_version_sample($formattedName);
}
exportModel
Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. |
outputConfig |
Google\Cloud\AIPlatform\V1\ExportModelRequest\OutputConfig
Required. The desired output location and configuration. |
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\ExportModelRequest\OutputConfig;
use Google\Cloud\AIPlatform\V1\ExportModelResponse;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedName The resource name of the Model to export.
* The resource name may contain version id or version alias to specify the
* version, if no version is specified, the default version will be exported. Please see
* {@see ModelServiceClient::modelName()} for help formatting this field.
*/
function export_model_sample(string $formattedName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$outputConfig = new OutputConfig();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $modelServiceClient->exportModel($formattedName, $outputConfig);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ExportModelResponse $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
{
$formattedName = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
export_model_sample($formattedName);
}
getModel
Gets a Model.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Model resource.
Format: In order to retrieve a specific version of the model, also provide
the version ID or version alias.
Example: |
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\Model |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Model;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedName The name of the Model resource.
* Format: `projects/{project}/locations/{location}/models/{model}`
*
* In order to retrieve a specific version of the model, also provide
* the version ID or version alias.
* Example: `projects/{project}/locations/{location}/models/{model}@2`
* or
* `projects/{project}/locations/{location}/models/{model}@golden`
* If no version ID or alias is specified, the "default" version will be
* returned. The "default" version alias is created for the first version of
* the model, and can be moved to other versions later on. There will be
* exactly one default version. Please see
* {@see ModelServiceClient::modelName()} for help formatting this field.
*/
function get_model_sample(string $formattedName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var Model $response */
$response = $modelServiceClient->getModel($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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
get_model_sample($formattedName);
}
getModelEvaluation
Gets a ModelEvaluation.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the ModelEvaluation 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\ModelEvaluation |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\ModelEvaluation;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedName The name of the ModelEvaluation resource.
* Format:
* `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
* Please see {@see ModelServiceClient::modelEvaluationName()} for help formatting this field.
*/
function get_model_evaluation_sample(string $formattedName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var ModelEvaluation $response */
$response = $modelServiceClient->getModelEvaluation($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 = ModelServiceClient::modelEvaluationName(
'[PROJECT]',
'[LOCATION]',
'[MODEL]',
'[EVALUATION]'
);
get_model_evaluation_sample($formattedName);
}
getModelEvaluationSlice
Gets a ModelEvaluationSlice.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the ModelEvaluationSlice 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\ModelEvaluationSlice |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\ModelEvaluationSlice;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedName The name of the ModelEvaluationSlice resource.
* Format:
* `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
* Please see {@see ModelServiceClient::modelEvaluationSliceName()} for help formatting this field.
*/
function get_model_evaluation_slice_sample(string $formattedName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var ModelEvaluationSlice $response */
$response = $modelServiceClient->getModelEvaluationSlice($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 = ModelServiceClient::modelEvaluationSliceName(
'[PROJECT]',
'[LOCATION]',
'[MODEL]',
'[EVALUATION]',
'[SLICE]'
);
get_model_evaluation_slice_sample($formattedName);
}
importModelEvaluation
Imports an externally generated ModelEvaluation.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The name of the parent model resource.
Format: |
modelEvaluation |
Google\Cloud\AIPlatform\V1\ModelEvaluation
Required. Model evaluation resource to be imported. |
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\ModelEvaluation |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\ModelEvaluation;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedParent The name of the parent model resource.
* Format: `projects/{project}/locations/{location}/models/{model}`
* Please see {@see ModelServiceClient::modelName()} for help formatting this field.
*/
function import_model_evaluation_sample(string $formattedParent): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$modelEvaluation = new ModelEvaluation();
// Call the API and handle any network failures.
try {
/** @var ModelEvaluation $response */
$response = $modelServiceClient->importModelEvaluation($formattedParent, $modelEvaluation);
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
{
$formattedParent = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
import_model_evaluation_sample($formattedParent);
}
listModelEvaluationSlices
Lists ModelEvaluationSlices in a ModelEvaluation.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the ModelEvaluation to list the
ModelEvaluationSlices from. Format:
|
optionalArgs |
array
Optional. |
↳ 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. |
↳ readMask |
FieldMask
Mask specifying which fields to read. |
↳ 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\ModelEvaluationSlice;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedParent The resource name of the ModelEvaluation to list the
* ModelEvaluationSlices from. Format:
* `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
* Please see {@see ModelServiceClient::modelEvaluationName()} for help formatting this field.
*/
function list_model_evaluation_slices_sample(string $formattedParent): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $modelServiceClient->listModelEvaluationSlices($formattedParent);
/** @var ModelEvaluationSlice $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 = ModelServiceClient::modelEvaluationName(
'[PROJECT]',
'[LOCATION]',
'[MODEL]',
'[EVALUATION]'
);
list_model_evaluation_slices_sample($formattedParent);
}
listModelEvaluations
Lists ModelEvaluations in a Model.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Model to list the ModelEvaluations from.
Format: |
optionalArgs |
array
Optional. |
↳ 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. |
↳ readMask |
FieldMask
Mask specifying which fields to read. |
↳ 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\ModelEvaluation;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedParent The resource name of the Model to list the ModelEvaluations from.
* Format: `projects/{project}/locations/{location}/models/{model}`
* Please see {@see ModelServiceClient::modelName()} for help formatting this field.
*/
function list_model_evaluations_sample(string $formattedParent): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $modelServiceClient->listModelEvaluations($formattedParent);
/** @var ModelEvaluation $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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
list_model_evaluations_sample($formattedParent);
}
listModelVersions
Lists versions of the specified model.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the model to list versions for. |
optionalArgs |
array
Optional. |
↳ 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. |
↳ filter |
string
An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * |
↳ readMask |
FieldMask
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\Model;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedName The name of the model to list versions for. Please see
* {@see ModelServiceClient::modelName()} for help formatting this field.
*/
function list_model_versions_sample(string $formattedName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $modelServiceClient->listModelVersions($formattedName);
/** @var Model $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
{
$formattedName = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
list_model_versions_sample($formattedName);
}
listModels
Lists Models in a Location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location to list the Models from.
Format: |
optionalArgs |
array
Optional. |
↳ filter |
string
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
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\Model;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedParent The resource name of the Location to list the Models from.
* Format: `projects/{project}/locations/{location}`
* Please see {@see ModelServiceClient::locationName()} for help formatting this field.
*/
function list_models_sample(string $formattedParent): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $modelServiceClient->listModels($formattedParent);
/** @var Model $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 = ModelServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_models_sample($formattedParent);
}
mergeVersionAliases
Merges a set of aliases for a Model version.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: |
versionAliases |
string[]
Required. The set of version aliases to merge.
The alias should be at most 128 characters, and match
There is NO ordering in aliases, which means 1) The aliases returned from GetModel API might not have the exactly same order from this MergeVersionAliases API. 2) Adding and deleting the same alias in the request is not recommended, and the 2 operations will be cancelled out. |
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\Model |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Model;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
/**
* @param string $formattedName The name of the model version to merge aliases, with a version ID
* explicitly included.
*
* Example: `projects/{project}/locations/{location}/models/{model}@1234`
* Please see {@see ModelServiceClient::modelName()} for help formatting this field.
* @param string $versionAliasesElement The set of version aliases to merge.
* The alias should be at most 128 characters, and match
* `[a-z][a-zA-Z0-9-]{0,126}[a-z-0-9]`.
* Add the `-` prefix to an alias means removing that alias from the version.
* `-` is NOT counted in the 128 characters. Example: `-golden` means removing
* the `golden` alias from the version.
*
* There is NO ordering in aliases, which means
* 1) The aliases returned from GetModel API might not have the exactly same
* order from this MergeVersionAliases API. 2) Adding and deleting the same
* alias in the request is not recommended, and the 2 operations will be
* cancelled out.
*/
function merge_version_aliases_sample(string $formattedName, string $versionAliasesElement): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$versionAliases = [$versionAliasesElement,];
// Call the API and handle any network failures.
try {
/** @var Model $response */
$response = $modelServiceClient->mergeVersionAliases($formattedName, $versionAliases);
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 = ModelServiceClient::modelName('[PROJECT]', '[LOCATION]', '[MODEL]');
$versionAliasesElement = '[VERSION_ALIASES]';
merge_version_aliases_sample($formattedName, $versionAliasesElement);
}
updateModel
Updates a Model.
Parameters | |
---|---|
Name | Description |
model |
Google\Cloud\AIPlatform\V1\Model
Required. The Model which replaces the resource on the server. When Model Versioning is enabled, the model.name will be used to determine whether to update the model or model version.
|
updateMask |
Google\Protobuf\FieldMask
Required. The update mask applies to the resource.
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\AIPlatform\V1\Model |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Model;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
use Google\Protobuf\FieldMask;
/**
* @param string $modelDisplayName The display name of the Model.
* The name can be up to 128 characters long and can consist of any UTF-8
* characters.
*/
function update_model_sample(string $modelDisplayName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$model = (new Model())
->setDisplayName($modelDisplayName);
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var Model $response */
$response = $modelServiceClient->updateModel($model, $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
{
$modelDisplayName = '[DISPLAY_NAME]';
update_model_sample($modelDisplayName);
}
uploadModel
Uploads a Model artifact into Vertex AI.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location into which to upload the Model.
Format: |
model |
Google\Cloud\AIPlatform\V1\Model
Required. The Model to create. |
optionalArgs |
array
Optional. |
↳ parentModel |
string
Optional. The resource name of the model into which to upload the version. Only specify this field when uploading a new version. |
↳ modelId |
string
Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are |
↳ serviceAccount |
string
Optional. The user-provided custom service account to use to do the model upload. If empty, Vertex AI Service Agent will be used. Users uploading the Model must have the |
↳ 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\Model;
use Google\Cloud\AIPlatform\V1\ModelServiceClient;
use Google\Cloud\AIPlatform\V1\UploadModelResponse;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the Location into which to upload the Model.
* Format: `projects/{project}/locations/{location}`
* Please see {@see ModelServiceClient::locationName()} for help formatting this field.
* @param string $modelDisplayName The display name of the Model.
* The name can be up to 128 characters long and can consist of any UTF-8
* characters.
*/
function upload_model_sample(string $formattedParent, string $modelDisplayName): void
{
// Create a client.
$modelServiceClient = new ModelServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$model = (new Model())
->setDisplayName($modelDisplayName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $modelServiceClient->uploadModel($formattedParent, $model);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var UploadModelResponse $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 = ModelServiceClient::locationName('[PROJECT]', '[LOCATION]');
$modelDisplayName = '[DISPLAY_NAME]';
upload_model_sample($formattedParent, $modelDisplayName);
}
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\ModelServiceClient;
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.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $modelServiceClient->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\ModelServiceClient;
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.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $modelServiceClient->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\ModelServiceClient;
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.
$modelServiceClient = new ModelServiceClient();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $modelServiceClient->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\ModelServiceClient;
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.
$modelServiceClient = new ModelServiceClient();
// 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 = $modelServiceClient->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\ModelServiceClient;
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.
$modelServiceClient = new ModelServiceClient();
// 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 = $modelServiceClient->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.ModelService'
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.