Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class VizierServiceClient.
Service Description: Vertex AI Vizier API.
Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.
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:
$vizierServiceClient = new VizierServiceClient();
try {
$formattedTrialName = $vizierServiceClient->trialName('[PROJECT]', '[LOCATION]', '[STUDY]', '[TRIAL]');
$measurement = new Measurement();
$response = $vizierServiceClient->addTrialMeasurement($formattedTrialName, $measurement);
} finally {
$vizierServiceClient->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.
This service has a new (beta) implementation. See Google\Cloud\AIPlatform\V1\Client\VizierServiceClient to use the new surface.
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__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. |
addTrialMeasurement
Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.
Parameters | |
---|---|
Name | Description |
trialName |
string
Required. The name of the trial to add measurement.
Format:
|
measurement |
Google\Cloud\AIPlatform\V1\Measurement
Required. The measurement to be added to a Trial. |
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\Trial |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\AddTrialMeasurementRequest;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\Measurement;
use Google\Cloud\AIPlatform\V1\Trial;
/**
* @param string $formattedTrialName The name of the trial to add measurement.
* Format:
* `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
* Please see {@see VizierServiceClient::trialName()} for help formatting this field.
*/
function add_trial_measurement_sample(string $formattedTrialName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$measurement = new Measurement();
$request = (new AddTrialMeasurementRequest())
->setTrialName($formattedTrialName)
->setMeasurement($measurement);
// Call the API and handle any network failures.
try {
/** @var Trial $response */
$response = $vizierServiceClient->addTrialMeasurement($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedTrialName = VizierServiceClient::trialName(
'[PROJECT]',
'[LOCATION]',
'[STUDY]',
'[TRIAL]'
);
add_trial_measurement_sample($formattedTrialName);
}
checkTrialEarlyStoppingState
Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
Parameters | |
---|---|
Name | Description |
trialName |
string
Required. The Trial's name.
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\CheckTrialEarlyStoppingStateRequest;
use Google\Cloud\AIPlatform\V1\CheckTrialEarlyStoppingStateResponse;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Rpc\Status;
/**
* @param string $formattedTrialName The Trial's name.
* Format:
* `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
* Please see {@see VizierServiceClient::trialName()} for help formatting this field.
*/
function check_trial_early_stopping_state_sample(string $formattedTrialName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new CheckTrialEarlyStoppingStateRequest())
->setTrialName($formattedTrialName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $vizierServiceClient->checkTrialEarlyStoppingState($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var CheckTrialEarlyStoppingStateResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedTrialName = VizierServiceClient::trialName(
'[PROJECT]',
'[LOCATION]',
'[STUDY]',
'[TRIAL]'
);
check_trial_early_stopping_state_sample($formattedTrialName);
}
completeTrial
Marks a Trial as complete.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The Trial's name.
Format:
|
optionalArgs |
array
Optional. |
↳ finalMeasurement |
Measurement
Optional. If provided, it will be used as the completed Trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement |
↳ trialInfeasible |
bool
Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored. |
↳ infeasibleReason |
string
Optional. A human readable reason why the trial was infeasible. This should only be provided if |
↳ 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\Trial |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\CompleteTrialRequest;
use Google\Cloud\AIPlatform\V1\Trial;
/**
* @param string $formattedName The Trial's name.
* Format:
* `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
* Please see {@see VizierServiceClient::trialName()} for help formatting this field.
*/
function complete_trial_sample(string $formattedName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new CompleteTrialRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Trial $response */
$response = $vizierServiceClient->completeTrial($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = VizierServiceClient::trialName('[PROJECT]', '[LOCATION]', '[STUDY]', '[TRIAL]');
complete_trial_sample($formattedName);
}
createStudy
Creates a Study. A resource name will be generated after creation of the Study.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location to create the CustomJob in.
Format: |
study |
Google\Cloud\AIPlatform\V1\Study
Required. The Study configuration used to create the Study. |
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\Study |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\CreateStudyRequest;
use Google\Cloud\AIPlatform\V1\Study;
use Google\Cloud\AIPlatform\V1\StudySpec;
use Google\Cloud\AIPlatform\V1\StudySpec\MetricSpec;
use Google\Cloud\AIPlatform\V1\StudySpec\MetricSpec\GoalType;
use Google\Cloud\AIPlatform\V1\StudySpec\ParameterSpec;
/**
* @param string $formattedParent The resource name of the Location to create the CustomJob in.
* Format: `projects/{project}/locations/{location}`
* Please see {@see VizierServiceClient::locationName()} for help formatting this field.
* @param string $studyDisplayName Describes the Study, default value is empty string.
* @param string $studyStudySpecMetricsMetricId The ID of the metric. Must not contain whitespaces and must be
* unique amongst all MetricSpecs.
* @param int $studyStudySpecMetricsGoal The optimization goal of the metric.
* @param string $studyStudySpecParametersParameterId The ID of the parameter. Must not contain whitespaces and must
* be unique amongst all ParameterSpecs.
*/
function create_study_sample(
string $formattedParent,
string $studyDisplayName,
string $studyStudySpecMetricsMetricId,
int $studyStudySpecMetricsGoal,
string $studyStudySpecParametersParameterId
): void {
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$metricSpec = (new MetricSpec())
->setMetricId($studyStudySpecMetricsMetricId)
->setGoal($studyStudySpecMetricsGoal);
$studyStudySpecMetrics = [$metricSpec,];
$parameterSpec = (new ParameterSpec())
->setParameterId($studyStudySpecParametersParameterId);
$studyStudySpecParameters = [$parameterSpec,];
$studyStudySpec = (new StudySpec())
->setMetrics($studyStudySpecMetrics)
->setParameters($studyStudySpecParameters);
$study = (new Study())
->setDisplayName($studyDisplayName)
->setStudySpec($studyStudySpec);
$request = (new CreateStudyRequest())
->setParent($formattedParent)
->setStudy($study);
// Call the API and handle any network failures.
try {
/** @var Study $response */
$response = $vizierServiceClient->createStudy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = VizierServiceClient::locationName('[PROJECT]', '[LOCATION]');
$studyDisplayName = '[DISPLAY_NAME]';
$studyStudySpecMetricsMetricId = '[METRIC_ID]';
$studyStudySpecMetricsGoal = GoalType::GOAL_TYPE_UNSPECIFIED;
$studyStudySpecParametersParameterId = '[PARAMETER_ID]';
create_study_sample(
$formattedParent,
$studyDisplayName,
$studyStudySpecMetricsMetricId,
$studyStudySpecMetricsGoal,
$studyStudySpecParametersParameterId
);
}
createTrial
Adds a user provided Trial to a Study.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Study to create the Trial in.
Format: |
trial |
Google\Cloud\AIPlatform\V1\Trial
Required. The Trial to create. |
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\Trial |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\CreateTrialRequest;
use Google\Cloud\AIPlatform\V1\Trial;
/**
* @param string $formattedParent The resource name of the Study to create the Trial in.
* Format: `projects/{project}/locations/{location}/studies/{study}`
* Please see {@see VizierServiceClient::studyName()} for help formatting this field.
*/
function create_trial_sample(string $formattedParent): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$trial = new Trial();
$request = (new CreateTrialRequest())
->setParent($formattedParent)
->setTrial($trial);
// Call the API and handle any network failures.
try {
/** @var Trial $response */
$response = $vizierServiceClient->createTrial($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = VizierServiceClient::studyName('[PROJECT]', '[LOCATION]', '[STUDY]');
create_trial_sample($formattedParent);
}
deleteStudy
Deletes a Study.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Study 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. |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteStudyRequest;
/**
* @param string $formattedName The name of the Study resource to be deleted.
* Format: `projects/{project}/locations/{location}/studies/{study}`
* Please see {@see VizierServiceClient::studyName()} for help formatting this field.
*/
function delete_study_sample(string $formattedName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new DeleteStudyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$vizierServiceClient->deleteStudy($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = VizierServiceClient::studyName('[PROJECT]', '[LOCATION]', '[STUDY]');
delete_study_sample($formattedName);
}
deleteTrial
Deletes a Trial.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The Trial's name.
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteTrialRequest;
/**
* @param string $formattedName The Trial's name.
* Format:
* `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
* Please see {@see VizierServiceClient::trialName()} for help formatting this field.
*/
function delete_trial_sample(string $formattedName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new DeleteTrialRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$vizierServiceClient->deleteTrial($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = VizierServiceClient::trialName('[PROJECT]', '[LOCATION]', '[STUDY]', '[TRIAL]');
delete_trial_sample($formattedName);
}
getStudy
Gets a Study by name.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Study 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\Study |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\GetStudyRequest;
use Google\Cloud\AIPlatform\V1\Study;
/**
* @param string $formattedName The name of the Study resource.
* Format: `projects/{project}/locations/{location}/studies/{study}`
* Please see {@see VizierServiceClient::studyName()} for help formatting this field.
*/
function get_study_sample(string $formattedName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new GetStudyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Study $response */
$response = $vizierServiceClient->getStudy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = VizierServiceClient::studyName('[PROJECT]', '[LOCATION]', '[STUDY]');
get_study_sample($formattedName);
}
getTrial
Gets a Trial.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Trial 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\Trial |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\GetTrialRequest;
use Google\Cloud\AIPlatform\V1\Trial;
/**
* @param string $formattedName The name of the Trial resource.
* Format:
* `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
* Please see {@see VizierServiceClient::trialName()} for help formatting this field.
*/
function get_trial_sample(string $formattedName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new GetTrialRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Trial $response */
$response = $vizierServiceClient->getTrial($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = VizierServiceClient::trialName('[PROJECT]', '[LOCATION]', '[STUDY]', '[TRIAL]');
get_trial_sample($formattedName);
}
listOptimalTrials
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The name of the Study that the optimal Trial belongs to. |
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\ListOptimalTrialsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\ListOptimalTrialsRequest;
use Google\Cloud\AIPlatform\V1\ListOptimalTrialsResponse;
/**
* @param string $formattedParent The name of the Study that the optimal Trial belongs to. Please see
* {@see VizierServiceClient::studyName()} for help formatting this field.
*/
function list_optimal_trials_sample(string $formattedParent): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new ListOptimalTrialsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var ListOptimalTrialsResponse $response */
$response = $vizierServiceClient->listOptimalTrials($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = VizierServiceClient::studyName('[PROJECT]', '[LOCATION]', '[STUDY]');
list_optimal_trials_sample($formattedParent);
}
listStudies
Lists all the studies in a region for an associated project.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location to list the Study from.
Format: |
optionalArgs |
array
Optional. |
↳ 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. |
↳ 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. |
↳ 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\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\ListStudiesRequest;
use Google\Cloud\AIPlatform\V1\Study;
/**
* @param string $formattedParent The resource name of the Location to list the Study from.
* Format: `projects/{project}/locations/{location}`
* Please see {@see VizierServiceClient::locationName()} for help formatting this field.
*/
function list_studies_sample(string $formattedParent): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new ListStudiesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $vizierServiceClient->listStudies($request);
/** @var Study $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = VizierServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_studies_sample($formattedParent);
}
listTrials
Lists the Trials associated with a Study.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Study to list the Trial from.
Format: |
optionalArgs |
array
Optional. |
↳ 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. |
↳ 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. |
↳ 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\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\ListTrialsRequest;
use Google\Cloud\AIPlatform\V1\Trial;
/**
* @param string $formattedParent The resource name of the Study to list the Trial from.
* Format: `projects/{project}/locations/{location}/studies/{study}`
* Please see {@see VizierServiceClient::studyName()} for help formatting this field.
*/
function list_trials_sample(string $formattedParent): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new ListTrialsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $vizierServiceClient->listTrials($request);
/** @var Trial $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = VizierServiceClient::studyName('[PROJECT]', '[LOCATION]', '[STUDY]');
list_trials_sample($formattedParent);
}
lookupStudy
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location to get the Study from.
Format: |
displayName |
string
Required. The user-defined display name of the Study |
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\Study |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\LookupStudyRequest;
use Google\Cloud\AIPlatform\V1\Study;
/**
* @param string $formattedParent The resource name of the Location to get the Study from.
* Format: `projects/{project}/locations/{location}`
* Please see {@see VizierServiceClient::locationName()} for help formatting this field.
* @param string $displayName The user-defined display name of the Study
*/
function lookup_study_sample(string $formattedParent, string $displayName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new LookupStudyRequest())
->setParent($formattedParent)
->setDisplayName($displayName);
// Call the API and handle any network failures.
try {
/** @var Study $response */
$response = $vizierServiceClient->lookupStudy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = VizierServiceClient::locationName('[PROJECT]', '[LOCATION]');
$displayName = '[DISPLAY_NAME]';
lookup_study_sample($formattedParent, $displayName);
}
stopTrial
Stops a Trial.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The Trial's name.
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\Trial |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\StopTrialRequest;
use Google\Cloud\AIPlatform\V1\Trial;
/**
* @param string $formattedName The Trial's name.
* Format:
* `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
* Please see {@see VizierServiceClient::trialName()} for help formatting this field.
*/
function stop_trial_sample(string $formattedName): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new StopTrialRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Trial $response */
$response = $vizierServiceClient->stopTrial($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = VizierServiceClient::trialName('[PROJECT]', '[LOCATION]', '[STUDY]', '[TRIAL]');
stop_trial_sample($formattedName);
}
suggestTrials
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions.
When this long-running operation succeeds, it will contain a SuggestTrialsResponse.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The project and location that the Study belongs to.
Format: |
suggestionCount |
int
Required. The number of suggestions requested. It must be positive. |
clientId |
string
Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same |
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\Client\VizierServiceClient;
use Google\Cloud\AIPlatform\V1\SuggestTrialsRequest;
use Google\Cloud\AIPlatform\V1\SuggestTrialsResponse;
use Google\Rpc\Status;
/**
* @param string $formattedParent The project and location that the Study belongs to.
* Format: `projects/{project}/locations/{location}/studies/{study}`
* Please see {@see VizierServiceClient::studyName()} for help formatting this field.
* @param int $suggestionCount The number of suggestions requested. It must be positive.
* @param string $clientId The identifier of the client that is requesting the suggestion.
*
* If multiple SuggestTrialsRequests have the same `client_id`,
* the service will return the identical suggested Trial if the Trial is
* pending, and provide a new Trial if the last suggested Trial was completed.
*/
function suggest_trials_sample(
string $formattedParent,
int $suggestionCount,
string $clientId
): void {
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new SuggestTrialsRequest())
->setParent($formattedParent)
->setSuggestionCount($suggestionCount)
->setClientId($clientId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $vizierServiceClient->suggestTrials($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var SuggestTrialsResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = VizierServiceClient::studyName('[PROJECT]', '[LOCATION]', '[STUDY]');
$suggestionCount = 0;
$clientId = '[CLIENT_ID]';
suggest_trials_sample($formattedParent, $suggestionCount, $clientId);
}
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\Client\VizierServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function get_location_sample(): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $vizierServiceClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
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\Client\VizierServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function list_locations_sample(): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $vizierServiceClient->listLocations($request);
/** @var Location $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
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\Client\VizierServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $vizierServiceClient->getIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
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\Client\VizierServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $vizierServiceClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
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\Client\VizierServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$vizierServiceClient = new VizierServiceClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $vizierServiceClient->testIamPermissions($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
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 |
static::customJobName
Formats a string containing the fully-qualified path to represent a custom_job resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
customJob |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted custom_job resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted location resource. |
static::studyName
Formats a string containing the fully-qualified path to represent a study resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
study |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted study resource. |
static::trialName
Formats a string containing the fully-qualified path to represent a trial resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
study |
string
|
trial |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted trial resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- customJob: projects/{project}/locations/{location}/customJobs/{custom_job}
- location: projects/{project}/locations/{location}
- study: projects/{project}/locations/{location}/studies/{study}
- trial: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
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. |
Constants
SERVICE_NAME
Value: 'google.cloud.aiplatform.v1.VizierService'
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.