diff --git a/AiPlatform/metadata/V1/AcceleratorType.php b/AiPlatform/metadata/V1/AcceleratorType.php index 6e95f49265a9..a7c181467cf5 100644 Binary files a/AiPlatform/metadata/V1/AcceleratorType.php and b/AiPlatform/metadata/V1/AcceleratorType.php differ diff --git a/AiPlatform/metadata/V1/Content.php b/AiPlatform/metadata/V1/Content.php index 73666b7c7fc3..0895d8e755cb 100644 Binary files a/AiPlatform/metadata/V1/Content.php and b/AiPlatform/metadata/V1/Content.php differ diff --git a/AiPlatform/metadata/V1/CustomJob.php b/AiPlatform/metadata/V1/CustomJob.php index 6ff7d2b5562e..31bf916260e9 100644 Binary files a/AiPlatform/metadata/V1/CustomJob.php and b/AiPlatform/metadata/V1/CustomJob.php differ diff --git a/AiPlatform/metadata/V1/Dataset.php b/AiPlatform/metadata/V1/Dataset.php index c1be592bb697..2c00a2d8bbfc 100644 Binary files a/AiPlatform/metadata/V1/Dataset.php and b/AiPlatform/metadata/V1/Dataset.php differ diff --git a/AiPlatform/metadata/V1/DatasetVersion.php b/AiPlatform/metadata/V1/DatasetVersion.php index 97db6c03605b..5d38514f3d7b 100644 --- a/AiPlatform/metadata/V1/DatasetVersion.php +++ b/AiPlatform/metadata/V1/DatasetVersion.php @@ -20,10 +20,10 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -¾ -0google/cloud/aiplatform/v1/dataset_version.protogoogle.cloud.aiplatform.v1google/api/resource.protogoogle/protobuf/struct.protogoogle/protobuf/timestamp.proto"· -DatasetVersion -name ( BàA4 +Á +0google/cloud/aiplatform/v1/dataset_version.protogoogle.cloud.aiplatform.v1google/api/resource.protogoogle/protobuf/struct.protogoogle/protobuf/timestamp.proto"º +DatasetVersion +name ( BàAàA4 create_time ( 2.google.protobuf.TimestampBàA4 update_time ( 2.google.protobuf.TimestampBàA etag ( # diff --git a/AiPlatform/metadata/V1/Endpoint.php b/AiPlatform/metadata/V1/Endpoint.php index 087c1ed2e178..be17963e74f7 100644 Binary files a/AiPlatform/metadata/V1/Endpoint.php and b/AiPlatform/metadata/V1/Endpoint.php differ diff --git a/AiPlatform/metadata/V1/FeatureOnlineStoreService.php b/AiPlatform/metadata/V1/FeatureOnlineStoreService.php index 5fd9ec59038e..06b606662ea1 100644 Binary files a/AiPlatform/metadata/V1/FeatureOnlineStoreService.php and b/AiPlatform/metadata/V1/FeatureOnlineStoreService.php differ diff --git a/AiPlatform/metadata/V1/ModelGardenService.php b/AiPlatform/metadata/V1/ModelGardenService.php index d7a2134c984a..b0f090b78a32 100644 Binary files a/AiPlatform/metadata/V1/ModelGardenService.php and b/AiPlatform/metadata/V1/ModelGardenService.php differ diff --git a/AiPlatform/metadata/V1/NotebookExecutionJob.php b/AiPlatform/metadata/V1/NotebookExecutionJob.php new file mode 100644 index 000000000000..e4ec1b9713de Binary files /dev/null and b/AiPlatform/metadata/V1/NotebookExecutionJob.php differ diff --git a/AiPlatform/metadata/V1/NotebookService.php b/AiPlatform/metadata/V1/NotebookService.php index 047f3cc8275a..2eebcbd6383a 100644 Binary files a/AiPlatform/metadata/V1/NotebookService.php and b/AiPlatform/metadata/V1/NotebookService.php differ diff --git a/AiPlatform/metadata/V1/PersistentResource.php b/AiPlatform/metadata/V1/PersistentResource.php index bdc1ad7f63e7..870851844f44 100644 Binary files a/AiPlatform/metadata/V1/PersistentResource.php and b/AiPlatform/metadata/V1/PersistentResource.php differ diff --git a/AiPlatform/metadata/V1/PredictionService.php b/AiPlatform/metadata/V1/PredictionService.php index 876836b0e63c..31efe26992a1 100644 Binary files a/AiPlatform/metadata/V1/PredictionService.php and b/AiPlatform/metadata/V1/PredictionService.php differ diff --git a/AiPlatform/metadata/V1/Tool.php b/AiPlatform/metadata/V1/Tool.php index 67bc3c3363d2..bd6a39c0b483 100644 Binary files a/AiPlatform/metadata/V1/Tool.php and b/AiPlatform/metadata/V1/Tool.php differ diff --git a/AiPlatform/metadata/V1/TuningJob.php b/AiPlatform/metadata/V1/TuningJob.php index b4dca9d8fce9..0e09d7bebf6b 100644 Binary files a/AiPlatform/metadata/V1/TuningJob.php and b/AiPlatform/metadata/V1/TuningJob.php differ diff --git a/AiPlatform/samples/V1/LlmUtilityServiceClient/count_tokens.php b/AiPlatform/samples/V1/LlmUtilityServiceClient/count_tokens.php index 284c668df052..ec5ac541f189 100644 --- a/AiPlatform/samples/V1/LlmUtilityServiceClient/count_tokens.php +++ b/AiPlatform/samples/V1/LlmUtilityServiceClient/count_tokens.php @@ -25,11 +25,8 @@ // [START aiplatform_v1_generated_LlmUtilityService_CountTokens_sync] use Google\ApiCore\ApiException; use Google\Cloud\AIPlatform\V1\Client\LlmUtilityServiceClient; -use Google\Cloud\AIPlatform\V1\Content; use Google\Cloud\AIPlatform\V1\CountTokensRequest; use Google\Cloud\AIPlatform\V1\CountTokensResponse; -use Google\Cloud\AIPlatform\V1\Part; -use Google\Protobuf\Value; /** * Perform a token counting. @@ -38,26 +35,15 @@ * Format: * `projects/{project}/locations/{location}/endpoints/{endpoint}` * Please see {@see LlmUtilityServiceClient::endpointName()} for help formatting this field. - * @param string $model The name of the publisher model requested to serve the - * prediction. Format: - * `projects/{project}/locations/{location}/publishers/*/models/*` */ -function count_tokens_sample(string $formattedEndpoint, string $model): void +function count_tokens_sample(string $formattedEndpoint): void { // Create a client. $llmUtilityServiceClient = new LlmUtilityServiceClient(); // Prepare the request message. - $instances = [new Value()]; - $contentsParts = [new Part()]; - $content = (new Content()) - ->setParts($contentsParts); - $contents = [$content,]; $request = (new CountTokensRequest()) - ->setEndpoint($formattedEndpoint) - ->setModel($model) - ->setInstances($instances) - ->setContents($contents); + ->setEndpoint($formattedEndpoint); // Call the API and handle any network failures. try { @@ -81,8 +67,7 @@ function count_tokens_sample(string $formattedEndpoint, string $model): void function callSample(): void { $formattedEndpoint = LlmUtilityServiceClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]'); - $model = '[MODEL]'; - count_tokens_sample($formattedEndpoint, $model); + count_tokens_sample($formattedEndpoint); } // [END aiplatform_v1_generated_LlmUtilityService_CountTokens_sync] diff --git a/AiPlatform/samples/V1/NotebookServiceClient/create_notebook_execution_job.php b/AiPlatform/samples/V1/NotebookServiceClient/create_notebook_execution_job.php new file mode 100644 index 000000000000..d8e80b43a5b3 --- /dev/null +++ b/AiPlatform/samples/V1/NotebookServiceClient/create_notebook_execution_job.php @@ -0,0 +1,86 @@ +setParent($formattedParent) + ->setNotebookExecutionJob($notebookExecutionJob); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $notebookServiceClient->createNotebookExecutionJob($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var NotebookExecutionJob $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 = NotebookServiceClient::locationName('[PROJECT]', '[LOCATION]'); + + create_notebook_execution_job_sample($formattedParent); +} +// [END aiplatform_v1_generated_NotebookService_CreateNotebookExecutionJob_sync] diff --git a/AiPlatform/samples/V1/NotebookServiceClient/delete_notebook_execution_job.php b/AiPlatform/samples/V1/NotebookServiceClient/delete_notebook_execution_job.php new file mode 100644 index 000000000000..70db6e704b12 --- /dev/null +++ b/AiPlatform/samples/V1/NotebookServiceClient/delete_notebook_execution_job.php @@ -0,0 +1,84 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $notebookServiceClient->deleteNotebookExecutionJob($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + printf('Operation completed successfully.' . PHP_EOL); + } else { + /** @var Status $error */ + $error = $response->getError(); + printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); + } + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} + +/** + * Helper to execute the sample. + * + * This sample has been automatically generated and should be regarded as a code + * template only. It will require modifications to work: + * - It may require correct/in-range values for request initialization. + * - It may require specifying regional endpoints when creating the service client, + * please see the apiEndpoint client configuration option for more details. + */ +function callSample(): void +{ + $formattedName = NotebookServiceClient::notebookExecutionJobName( + '[PROJECT]', + '[LOCATION]', + '[NOTEBOOK_EXECUTION_JOB]' + ); + + delete_notebook_execution_job_sample($formattedName); +} +// [END aiplatform_v1_generated_NotebookService_DeleteNotebookExecutionJob_sync] diff --git a/AiPlatform/samples/V1/NotebookServiceClient/get_notebook_execution_job.php b/AiPlatform/samples/V1/NotebookServiceClient/get_notebook_execution_job.php new file mode 100644 index 000000000000..ba09880d60cb --- /dev/null +++ b/AiPlatform/samples/V1/NotebookServiceClient/get_notebook_execution_job.php @@ -0,0 +1,75 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var NotebookExecutionJob $response */ + $response = $notebookServiceClient->getNotebookExecutionJob($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 = NotebookServiceClient::notebookExecutionJobName( + '[PROJECT]', + '[LOCATION]', + '[NOTEBOOK_EXECUTION_JOB]' + ); + + get_notebook_execution_job_sample($formattedName); +} +// [END aiplatform_v1_generated_NotebookService_GetNotebookExecutionJob_sync] diff --git a/AiPlatform/samples/V1/NotebookServiceClient/list_notebook_execution_jobs.php b/AiPlatform/samples/V1/NotebookServiceClient/list_notebook_execution_jobs.php new file mode 100644 index 000000000000..ca993b682d5b --- /dev/null +++ b/AiPlatform/samples/V1/NotebookServiceClient/list_notebook_execution_jobs.php @@ -0,0 +1,78 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $notebookServiceClient->listNotebookExecutionJobs($request); + + /** @var NotebookExecutionJob $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 = NotebookServiceClient::locationName('[PROJECT]', '[LOCATION]'); + + list_notebook_execution_jobs_sample($formattedParent); +} +// [END aiplatform_v1_generated_NotebookService_ListNotebookExecutionJobs_sync] diff --git a/AiPlatform/src/V1/AcceleratorType.php b/AiPlatform/src/V1/AcceleratorType.php index f5472bd1f42b..bd9880da7d47 100644 --- a/AiPlatform/src/V1/AcceleratorType.php +++ b/AiPlatform/src/V1/AcceleratorType.php @@ -22,7 +22,7 @@ class AcceleratorType /** * Nvidia Tesla K80 GPU. * - * Generated from protobuf enum NVIDIA_TESLA_K80 = 1; + * Generated from protobuf enum NVIDIA_TESLA_K80 = 1 [deprecated = true]; */ const NVIDIA_TESLA_K80 = 1; /** diff --git a/AiPlatform/src/V1/Candidate.php b/AiPlatform/src/V1/Candidate.php index 65c4e00b517a..26f50955e2e5 100644 --- a/AiPlatform/src/V1/Candidate.php +++ b/AiPlatform/src/V1/Candidate.php @@ -27,6 +27,12 @@ class Candidate extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $content = null; + /** + * Output only. Confidence score of the candidate. + * + * Generated from protobuf field double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $score = 0.0; /** * Output only. The reason why the model stopped generating tokens. * If empty, the model has not stopped generating the tokens. @@ -71,6 +77,8 @@ class Candidate extends \Google\Protobuf\Internal\Message * Output only. Index of the candidate. * @type \Google\Cloud\AIPlatform\V1\Content $content * Output only. Content parts of the candidate. + * @type float $score + * Output only. Confidence score of the candidate. * @type int $finish_reason * Output only. The reason why the model stopped generating tokens. * If empty, the model has not stopped generating the tokens. @@ -153,6 +161,32 @@ public function setContent($var) return $this; } + /** + * Output only. Confidence score of the candidate. + * + * Generated from protobuf field double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return float + */ + public function getScore() + { + return $this->score; + } + + /** + * Output only. Confidence score of the candidate. + * + * Generated from protobuf field double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param float $var + * @return $this + */ + public function setScore($var) + { + GPBUtil::checkDouble($var); + $this->score = $var; + + return $this; + } + /** * Output only. The reason why the model stopped generating tokens. * If empty, the model has not stopped generating the tokens. diff --git a/AiPlatform/src/V1/Client/NotebookServiceClient.php b/AiPlatform/src/V1/Client/NotebookServiceClient.php index 910b3fd32c68..bffd1f350aef 100644 --- a/AiPlatform/src/V1/Client/NotebookServiceClient.php +++ b/AiPlatform/src/V1/Client/NotebookServiceClient.php @@ -35,13 +35,18 @@ use Google\ApiCore\ValidationException; use Google\Auth\FetchAuthTokenInterface; use Google\Cloud\AIPlatform\V1\AssignNotebookRuntimeRequest; +use Google\Cloud\AIPlatform\V1\CreateNotebookExecutionJobRequest; use Google\Cloud\AIPlatform\V1\CreateNotebookRuntimeTemplateRequest; +use Google\Cloud\AIPlatform\V1\DeleteNotebookExecutionJobRequest; use Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeRequest; use Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeTemplateRequest; +use Google\Cloud\AIPlatform\V1\GetNotebookExecutionJobRequest; use Google\Cloud\AIPlatform\V1\GetNotebookRuntimeRequest; use Google\Cloud\AIPlatform\V1\GetNotebookRuntimeTemplateRequest; +use Google\Cloud\AIPlatform\V1\ListNotebookExecutionJobsRequest; use Google\Cloud\AIPlatform\V1\ListNotebookRuntimeTemplatesRequest; use Google\Cloud\AIPlatform\V1\ListNotebookRuntimesRequest; +use Google\Cloud\AIPlatform\V1\NotebookExecutionJob; use Google\Cloud\AIPlatform\V1\NotebookRuntime; use Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate; use Google\Cloud\AIPlatform\V1\StartNotebookRuntimeRequest; @@ -71,11 +76,15 @@ * contained within formatted names that are returned by the API. * * @method PromiseInterface assignNotebookRuntimeAsync(AssignNotebookRuntimeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createNotebookExecutionJobAsync(CreateNotebookExecutionJobRequest $request, array $optionalArgs = []) * @method PromiseInterface createNotebookRuntimeTemplateAsync(CreateNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface deleteNotebookExecutionJobAsync(DeleteNotebookExecutionJobRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteNotebookRuntimeAsync(DeleteNotebookRuntimeRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteNotebookRuntimeTemplateAsync(DeleteNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface getNotebookExecutionJobAsync(GetNotebookExecutionJobRequest $request, array $optionalArgs = []) * @method PromiseInterface getNotebookRuntimeAsync(GetNotebookRuntimeRequest $request, array $optionalArgs = []) * @method PromiseInterface getNotebookRuntimeTemplateAsync(GetNotebookRuntimeTemplateRequest $request, array $optionalArgs = []) + * @method PromiseInterface listNotebookExecutionJobsAsync(ListNotebookExecutionJobsRequest $request, array $optionalArgs = []) * @method PromiseInterface listNotebookRuntimeTemplatesAsync(ListNotebookRuntimeTemplatesRequest $request, array $optionalArgs = []) * @method PromiseInterface listNotebookRuntimesAsync(ListNotebookRuntimesRequest $request, array $optionalArgs = []) * @method PromiseInterface startNotebookRuntimeAsync(StartNotebookRuntimeRequest $request, array $optionalArgs = []) @@ -219,6 +228,28 @@ public static function networkName(string $project, string $network): string ]); } + /** + * Formats a string containing the fully-qualified path to represent a + * notebook_execution_job resource. + * + * @param string $project + * @param string $location + * @param string $notebookExecutionJob + * + * @return string The formatted notebook_execution_job resource. + */ + public static function notebookExecutionJobName( + string $project, + string $location, + string $notebookExecutionJob + ): string { + return self::getPathTemplate('notebookExecutionJob')->render([ + 'project' => $project, + 'location' => $location, + 'notebook_execution_job' => $notebookExecutionJob, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a * notebook_runtime resource. @@ -260,6 +291,25 @@ public static function notebookRuntimeTemplateName( ]); } + /** + * Formats a string containing the fully-qualified path to represent a schedule + * resource. + * + * @param string $project + * @param string $location + * @param string $schedule + * + * @return string The formatted schedule resource. + */ + public static function scheduleName(string $project, string $location, string $schedule): string + { + return self::getPathTemplate('schedule')->render([ + 'project' => $project, + 'location' => $location, + 'schedule' => $schedule, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a subnetwork * resource. @@ -285,8 +335,10 @@ public static function subnetworkName(string $project, string $region, string $s * Template: Pattern * - location: projects/{project}/locations/{location} * - network: projects/{project}/global/networks/{network} + * - notebookExecutionJob: projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job} * - notebookRuntime: projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime} * - notebookRuntimeTemplate: projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template} + * - schedule: projects/{project}/locations/{location}/schedules/{schedule} * - subnetwork: projects/{project}/regions/{region}/subnetworks/{subnetwork} * * The optional $template argument can be supplied to specify a particular pattern, @@ -409,6 +461,35 @@ public function assignNotebookRuntime( return $this->startApiCall('AssignNotebookRuntime', $request, $callOptions)->wait(); } + /** + * Creates a NotebookExecutionJob. + * + * The async variant is + * {@see NotebookServiceClient::createNotebookExecutionJobAsync()} . + * + * @example samples/V1/NotebookServiceClient/create_notebook_execution_job.php + * + * @param CreateNotebookExecutionJobRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createNotebookExecutionJob( + CreateNotebookExecutionJobRequest $request, + array $callOptions = [] + ): OperationResponse { + return $this->startApiCall('CreateNotebookExecutionJob', $request, $callOptions)->wait(); + } + /** * Creates a NotebookRuntimeTemplate. * @@ -438,6 +519,35 @@ public function createNotebookRuntimeTemplate( return $this->startApiCall('CreateNotebookRuntimeTemplate', $request, $callOptions)->wait(); } + /** + * Deletes a NotebookExecutionJob. + * + * The async variant is + * {@see NotebookServiceClient::deleteNotebookExecutionJobAsync()} . + * + * @example samples/V1/NotebookServiceClient/delete_notebook_execution_job.php + * + * @param DeleteNotebookExecutionJobRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function deleteNotebookExecutionJob( + DeleteNotebookExecutionJobRequest $request, + array $callOptions = [] + ): OperationResponse { + return $this->startApiCall('DeleteNotebookExecutionJob', $request, $callOptions)->wait(); + } + /** * Deletes a NotebookRuntime. * @@ -496,6 +606,35 @@ public function deleteNotebookRuntimeTemplate( return $this->startApiCall('DeleteNotebookRuntimeTemplate', $request, $callOptions)->wait(); } + /** + * Gets a NotebookExecutionJob. + * + * The async variant is + * {@see NotebookServiceClient::getNotebookExecutionJobAsync()} . + * + * @example samples/V1/NotebookServiceClient/get_notebook_execution_job.php + * + * @param GetNotebookExecutionJobRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return NotebookExecutionJob + * + * @throws ApiException Thrown if the API call fails. + */ + public function getNotebookExecutionJob( + GetNotebookExecutionJobRequest $request, + array $callOptions = [] + ): NotebookExecutionJob { + return $this->startApiCall('GetNotebookExecutionJob', $request, $callOptions)->wait(); + } + /** * Gets a NotebookRuntime. * @@ -551,6 +690,35 @@ public function getNotebookRuntimeTemplate( return $this->startApiCall('GetNotebookRuntimeTemplate', $request, $callOptions)->wait(); } + /** + * Lists NotebookExecutionJobs in a Location. + * + * The async variant is + * {@see NotebookServiceClient::listNotebookExecutionJobsAsync()} . + * + * @example samples/V1/NotebookServiceClient/list_notebook_execution_jobs.php + * + * @param ListNotebookExecutionJobsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listNotebookExecutionJobs( + ListNotebookExecutionJobsRequest $request, + array $callOptions = [] + ): PagedListResponse { + return $this->startApiCall('ListNotebookExecutionJobs', $request, $callOptions); + } + /** * Lists NotebookRuntimeTemplates in a Location. * diff --git a/AiPlatform/src/V1/CountTokensRequest.php b/AiPlatform/src/V1/CountTokensRequest.php index 6a602f612b16..799caf4c9d72 100644 --- a/AiPlatform/src/V1/CountTokensRequest.php +++ b/AiPlatform/src/V1/CountTokensRequest.php @@ -24,33 +24,51 @@ class CountTokensRequest extends \Google\Protobuf\Internal\Message */ protected $endpoint = ''; /** - * Required. The name of the publisher model requested to serve the + * Optional. The name of the publisher model requested to serve the * prediction. Format: * `projects/{project}/locations/{location}/publishers/*/models/*` * - * Generated from protobuf field string model = 3 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string model = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $model = ''; /** - * Required. The instances that are the input to token counting call. + * Optional. The instances that are the input to token counting call. * Schema is identical to the prediction schema of the underlying model. * - * Generated from protobuf field repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $instances; /** - * Required. Input content. + * Optional. Input content. * - * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Content contents = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $contents; + /** + * Optional. The user provided system instructions for the model. + * Note: only text should be used in parts and content in each part will be in + * a separate paragraph. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.Content system_instruction = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $system_instruction = null; + /** + * Optional. A list of `Tools` the model may use to generate the next + * response. + * A `Tool` is a piece of code that enables the system to interact with + * external systems to perform an action, or set of actions, outside of + * knowledge and scope of the model. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $tools; /** * @param string $endpoint Required. The name of the Endpoint requested to perform token counting. * Format: * `projects/{project}/locations/{location}/endpoints/{endpoint}` * Please see {@see LlmUtilityServiceClient::endpointName()} for help formatting this field. - * @param \Google\Protobuf\Value[] $instances Required. The instances that are the input to token counting call. + * @param \Google\Protobuf\Value[] $instances Optional. The instances that are the input to token counting call. * Schema is identical to the prediction schema of the underlying model. * * @return \Google\Cloud\AIPlatform\V1\CountTokensRequest @@ -75,14 +93,24 @@ public static function build(string $endpoint, array $instances): self * Format: * `projects/{project}/locations/{location}/endpoints/{endpoint}` * @type string $model - * Required. The name of the publisher model requested to serve the + * Optional. The name of the publisher model requested to serve the * prediction. Format: * `projects/{project}/locations/{location}/publishers/*/models/*` * @type array<\Google\Protobuf\Value>|\Google\Protobuf\Internal\RepeatedField $instances - * Required. The instances that are the input to token counting call. + * Optional. The instances that are the input to token counting call. * Schema is identical to the prediction schema of the underlying model. * @type array<\Google\Cloud\AIPlatform\V1\Content>|\Google\Protobuf\Internal\RepeatedField $contents - * Required. Input content. + * Optional. Input content. + * @type \Google\Cloud\AIPlatform\V1\Content $system_instruction + * Optional. The user provided system instructions for the model. + * Note: only text should be used in parts and content in each part will be in + * a separate paragraph. + * @type array<\Google\Cloud\AIPlatform\V1\Tool>|\Google\Protobuf\Internal\RepeatedField $tools + * Optional. A list of `Tools` the model may use to generate the next + * response. + * A `Tool` is a piece of code that enables the system to interact with + * external systems to perform an action, or set of actions, outside of + * knowledge and scope of the model. * } */ public function __construct($data = NULL) { @@ -121,11 +149,11 @@ public function setEndpoint($var) } /** - * Required. The name of the publisher model requested to serve the + * Optional. The name of the publisher model requested to serve the * prediction. Format: * `projects/{project}/locations/{location}/publishers/*/models/*` * - * Generated from protobuf field string model = 3 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string model = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getModel() @@ -134,11 +162,11 @@ public function getModel() } /** - * Required. The name of the publisher model requested to serve the + * Optional. The name of the publisher model requested to serve the * prediction. Format: * `projects/{project}/locations/{location}/publishers/*/models/*` * - * Generated from protobuf field string model = 3 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string model = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ @@ -151,10 +179,10 @@ public function setModel($var) } /** - * Required. The instances that are the input to token counting call. + * Optional. The instances that are the input to token counting call. * Schema is identical to the prediction schema of the underlying model. * - * Generated from protobuf field repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getInstances() @@ -163,10 +191,10 @@ public function getInstances() } /** - * Required. The instances that are the input to token counting call. + * Optional. The instances that are the input to token counting call. * Schema is identical to the prediction schema of the underlying model. * - * Generated from protobuf field repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Protobuf\Value>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -179,9 +207,9 @@ public function setInstances($var) } /** - * Required. Input content. + * Optional. Input content. * - * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Content contents = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getContents() @@ -190,9 +218,9 @@ public function getContents() } /** - * Required. Input content. + * Optional. Input content. * - * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Content contents = 4 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\AIPlatform\V1\Content>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ @@ -204,5 +232,79 @@ public function setContents($var) return $this; } + /** + * Optional. The user provided system instructions for the model. + * Note: only text should be used in parts and content in each part will be in + * a separate paragraph. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.Content system_instruction = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\AIPlatform\V1\Content|null + */ + public function getSystemInstruction() + { + return $this->system_instruction; + } + + public function hasSystemInstruction() + { + return isset($this->system_instruction); + } + + public function clearSystemInstruction() + { + unset($this->system_instruction); + } + + /** + * Optional. The user provided system instructions for the model. + * Note: only text should be used in parts and content in each part will be in + * a separate paragraph. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.Content system_instruction = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\AIPlatform\V1\Content $var + * @return $this + */ + public function setSystemInstruction($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\Content::class); + $this->system_instruction = $var; + + return $this; + } + + /** + * Optional. A list of `Tools` the model may use to generate the next + * response. + * A `Tool` is a piece of code that enables the system to interact with + * external systems to perform an action, or set of actions, outside of + * knowledge and scope of the model. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getTools() + { + return $this->tools; + } + + /** + * Optional. A list of `Tools` the model may use to generate the next + * response. + * A `Tool` is a piece of code that enables the system to interact with + * external systems to perform an action, or set of actions, outside of + * knowledge and scope of the model. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\AIPlatform\V1\Tool>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setTools($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AIPlatform\V1\Tool::class); + $this->tools = $arr; + + return $this; + } + } diff --git a/AiPlatform/src/V1/CreateNotebookExecutionJobOperationMetadata.php b/AiPlatform/src/V1/CreateNotebookExecutionJobOperationMetadata.php new file mode 100644 index 000000000000..0b71e5286960 --- /dev/null +++ b/AiPlatform/src/V1/CreateNotebookExecutionJobOperationMetadata.php @@ -0,0 +1,116 @@ +google.cloud.aiplatform.v1.CreateNotebookExecutionJobOperationMetadata + */ +class CreateNotebookExecutionJobOperationMetadata extends \Google\Protobuf\Internal\Message +{ + /** + * The operation generic information. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GenericOperationMetadata generic_metadata = 1; + */ + protected $generic_metadata = null; + /** + * A human-readable message that shows the intermediate progress details of + * NotebookRuntime. + * + * Generated from protobuf field string progress_message = 2; + */ + protected $progress_message = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\AIPlatform\V1\GenericOperationMetadata $generic_metadata + * The operation generic information. + * @type string $progress_message + * A human-readable message that shows the intermediate progress details of + * NotebookRuntime. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + + /** + * The operation generic information. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GenericOperationMetadata generic_metadata = 1; + * @return \Google\Cloud\AIPlatform\V1\GenericOperationMetadata|null + */ + public function getGenericMetadata() + { + return $this->generic_metadata; + } + + public function hasGenericMetadata() + { + return isset($this->generic_metadata); + } + + public function clearGenericMetadata() + { + unset($this->generic_metadata); + } + + /** + * The operation generic information. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GenericOperationMetadata generic_metadata = 1; + * @param \Google\Cloud\AIPlatform\V1\GenericOperationMetadata $var + * @return $this + */ + public function setGenericMetadata($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\GenericOperationMetadata::class); + $this->generic_metadata = $var; + + return $this; + } + + /** + * A human-readable message that shows the intermediate progress details of + * NotebookRuntime. + * + * Generated from protobuf field string progress_message = 2; + * @return string + */ + public function getProgressMessage() + { + return $this->progress_message; + } + + /** + * A human-readable message that shows the intermediate progress details of + * NotebookRuntime. + * + * Generated from protobuf field string progress_message = 2; + * @param string $var + * @return $this + */ + public function setProgressMessage($var) + { + GPBUtil::checkString($var, True); + $this->progress_message = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/CreateNotebookExecutionJobRequest.php b/AiPlatform/src/V1/CreateNotebookExecutionJobRequest.php new file mode 100644 index 000000000000..99b6895f59ce --- /dev/null +++ b/AiPlatform/src/V1/CreateNotebookExecutionJobRequest.php @@ -0,0 +1,168 @@ +google.cloud.aiplatform.v1.CreateNotebookExecutionJobRequest + */ +class CreateNotebookExecutionJobRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the Location to create the + * NotebookExecutionJob. Format: `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The NotebookExecutionJob to create. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob notebook_execution_job = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $notebook_execution_job = null; + /** + * Optional. User specified ID for the NotebookExecutionJob. + * + * Generated from protobuf field string notebook_execution_job_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $notebook_execution_job_id = ''; + + /** + * @param string $parent Required. The resource name of the Location to create the + * NotebookExecutionJob. Format: `projects/{project}/locations/{location}` + * Please see {@see NotebookServiceClient::locationName()} for help formatting this field. + * @param \Google\Cloud\AIPlatform\V1\NotebookExecutionJob $notebookExecutionJob Required. The NotebookExecutionJob to create. + * @param string $notebookExecutionJobId Optional. User specified ID for the NotebookExecutionJob. + * + * @return \Google\Cloud\AIPlatform\V1\CreateNotebookExecutionJobRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\AIPlatform\V1\NotebookExecutionJob $notebookExecutionJob, string $notebookExecutionJobId): self + { + return (new self()) + ->setParent($parent) + ->setNotebookExecutionJob($notebookExecutionJob) + ->setNotebookExecutionJobId($notebookExecutionJobId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The resource name of the Location to create the + * NotebookExecutionJob. Format: `projects/{project}/locations/{location}` + * @type \Google\Cloud\AIPlatform\V1\NotebookExecutionJob $notebook_execution_job + * Required. The NotebookExecutionJob to create. + * @type string $notebook_execution_job_id + * Optional. User specified ID for the NotebookExecutionJob. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the Location to create the + * NotebookExecutionJob. Format: `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The resource name of the Location to create the + * NotebookExecutionJob. Format: `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The NotebookExecutionJob to create. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob notebook_execution_job = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\AIPlatform\V1\NotebookExecutionJob|null + */ + public function getNotebookExecutionJob() + { + return $this->notebook_execution_job; + } + + public function hasNotebookExecutionJob() + { + return isset($this->notebook_execution_job); + } + + public function clearNotebookExecutionJob() + { + unset($this->notebook_execution_job); + } + + /** + * Required. The NotebookExecutionJob to create. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob notebook_execution_job = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\AIPlatform\V1\NotebookExecutionJob $var + * @return $this + */ + public function setNotebookExecutionJob($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\NotebookExecutionJob::class); + $this->notebook_execution_job = $var; + + return $this; + } + + /** + * Optional. User specified ID for the NotebookExecutionJob. + * + * Generated from protobuf field string notebook_execution_job_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getNotebookExecutionJobId() + { + return $this->notebook_execution_job_id; + } + + /** + * Optional. User specified ID for the NotebookExecutionJob. + * + * Generated from protobuf field string notebook_execution_job_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setNotebookExecutionJobId($var) + { + GPBUtil::checkString($var, True); + $this->notebook_execution_job_id = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/Dataset.php b/AiPlatform/src/V1/Dataset.php index 2167b87a67bd..610462e755ad 100644 --- a/AiPlatform/src/V1/Dataset.php +++ b/AiPlatform/src/V1/Dataset.php @@ -16,9 +16,9 @@ class Dataset extends \Google\Protobuf\Internal\Message { /** - * Output only. The resource name of the Dataset. + * Output only. Identifier. The resource name of the Dataset. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** @@ -137,7 +137,7 @@ class Dataset extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Output only. The resource name of the Dataset. + * Output only. Identifier. The resource name of the Dataset. * @type string $display_name * Required. The user-defined name of the Dataset. * The name can be up to 128 characters long and can consist of any UTF-8 @@ -202,9 +202,9 @@ public function __construct($data = NULL) { } /** - * Output only. The resource name of the Dataset. + * Output only. Identifier. The resource name of the Dataset. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; * @return string */ public function getName() @@ -213,9 +213,9 @@ public function getName() } /** - * Output only. The resource name of the Dataset. + * Output only. Identifier. The resource name of the Dataset. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; * @param string $var * @return $this */ diff --git a/AiPlatform/src/V1/DatasetVersion.php b/AiPlatform/src/V1/DatasetVersion.php index ef3f8046726b..763d95afe916 100644 --- a/AiPlatform/src/V1/DatasetVersion.php +++ b/AiPlatform/src/V1/DatasetVersion.php @@ -16,9 +16,9 @@ class DatasetVersion extends \Google\Protobuf\Internal\Message { /** - * Output only. The resource name of the DatasetVersion. + * Output only. Identifier. The resource name of the DatasetVersion. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** @@ -75,7 +75,7 @@ class DatasetVersion extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Output only. The resource name of the DatasetVersion. + * Output only. Identifier. The resource name of the DatasetVersion. * @type \Google\Protobuf\Timestamp $create_time * Output only. Timestamp when this DatasetVersion was created. * @type \Google\Protobuf\Timestamp $update_time @@ -102,9 +102,9 @@ public function __construct($data = NULL) { } /** - * Output only. The resource name of the DatasetVersion. + * Output only. Identifier. The resource name of the DatasetVersion. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; * @return string */ public function getName() @@ -113,9 +113,9 @@ public function getName() } /** - * Output only. The resource name of the DatasetVersion. + * Output only. Identifier. The resource name of the DatasetVersion. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; * @param string $var * @return $this */ diff --git a/AiPlatform/src/V1/DeleteNotebookExecutionJobRequest.php b/AiPlatform/src/V1/DeleteNotebookExecutionJobRequest.php new file mode 100644 index 000000000000..aaacf8aaff4d --- /dev/null +++ b/AiPlatform/src/V1/DeleteNotebookExecutionJobRequest.php @@ -0,0 +1,81 @@ +google.cloud.aiplatform.v1.DeleteNotebookExecutionJobRequest + */ +class DeleteNotebookExecutionJobRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the NotebookExecutionJob resource to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The name of the NotebookExecutionJob resource to be deleted. Please see + * {@see NotebookServiceClient::notebookExecutionJobName()} for help formatting this field. + * + * @return \Google\Cloud\AIPlatform\V1\DeleteNotebookExecutionJobRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the NotebookExecutionJob resource to be deleted. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the NotebookExecutionJob resource to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the NotebookExecutionJob resource to be deleted. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/Endpoint.php b/AiPlatform/src/V1/Endpoint.php index a56e116cba33..a332b1774f4c 100644 --- a/AiPlatform/src/V1/Endpoint.php +++ b/AiPlatform/src/V1/Endpoint.php @@ -149,6 +149,39 @@ class Endpoint extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.aiplatform.v1.PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18; */ protected $predict_request_response_logging_config = null; + /** + * If true, the endpoint will be exposed through a dedicated + * DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + * will be isolated from other users' traffic and will have better performance + * and reliability. + * Note: Once you enabled dedicated endpoint, you won't be able to send + * request to the shared DNS {region}-aiplatform.googleapis.com. The + * limitation will be removed soon. + * + * Generated from protobuf field bool dedicated_endpoint_enabled = 24; + */ + protected $dedicated_endpoint_enabled = false; + /** + * Output only. DNS of the dedicated endpoint. Will only be populated if + * dedicated_endpoint_enabled is true. + * Format: + * `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + * + * Generated from protobuf field string dedicated_endpoint_dns = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $dedicated_endpoint_dns = ''; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $satisfies_pzs = false; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $satisfies_pzi = false; /** * Constructor. @@ -228,6 +261,23 @@ class Endpoint extends \Google\Protobuf\Internal\Message * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` * @type \Google\Cloud\AIPlatform\V1\PredictRequestResponseLoggingConfig $predict_request_response_logging_config * Configures the request-response logging for online prediction. + * @type bool $dedicated_endpoint_enabled + * If true, the endpoint will be exposed through a dedicated + * DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + * will be isolated from other users' traffic and will have better performance + * and reliability. + * Note: Once you enabled dedicated endpoint, you won't be able to send + * request to the shared DNS {region}-aiplatform.googleapis.com. The + * limitation will be removed soon. + * @type string $dedicated_endpoint_dns + * Output only. DNS of the dedicated endpoint. Will only be populated if + * dedicated_endpoint_enabled is true. + * Format: + * `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + * @type bool $satisfies_pzs + * Output only. Reserved for future use. + * @type bool $satisfies_pzi + * Output only. Reserved for future use. * } */ public function __construct($data = NULL) { @@ -763,5 +813,127 @@ public function setPredictRequestResponseLoggingConfig($var) return $this; } + /** + * If true, the endpoint will be exposed through a dedicated + * DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + * will be isolated from other users' traffic and will have better performance + * and reliability. + * Note: Once you enabled dedicated endpoint, you won't be able to send + * request to the shared DNS {region}-aiplatform.googleapis.com. The + * limitation will be removed soon. + * + * Generated from protobuf field bool dedicated_endpoint_enabled = 24; + * @return bool + */ + public function getDedicatedEndpointEnabled() + { + return $this->dedicated_endpoint_enabled; + } + + /** + * If true, the endpoint will be exposed through a dedicated + * DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + * will be isolated from other users' traffic and will have better performance + * and reliability. + * Note: Once you enabled dedicated endpoint, you won't be able to send + * request to the shared DNS {region}-aiplatform.googleapis.com. The + * limitation will be removed soon. + * + * Generated from protobuf field bool dedicated_endpoint_enabled = 24; + * @param bool $var + * @return $this + */ + public function setDedicatedEndpointEnabled($var) + { + GPBUtil::checkBool($var); + $this->dedicated_endpoint_enabled = $var; + + return $this; + } + + /** + * Output only. DNS of the dedicated endpoint. Will only be populated if + * dedicated_endpoint_enabled is true. + * Format: + * `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + * + * Generated from protobuf field string dedicated_endpoint_dns = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getDedicatedEndpointDns() + { + return $this->dedicated_endpoint_dns; + } + + /** + * Output only. DNS of the dedicated endpoint. Will only be populated if + * dedicated_endpoint_enabled is true. + * Format: + * `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + * + * Generated from protobuf field string dedicated_endpoint_dns = 25 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setDedicatedEndpointDns($var) + { + GPBUtil::checkString($var, True); + $this->dedicated_endpoint_dns = $var; + + return $this; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzs() + { + return $this->satisfies_pzs; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzi() + { + return $this->satisfies_pzi; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 28 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzi($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzi = $var; + + return $this; + } + } diff --git a/AiPlatform/src/V1/GetNotebookExecutionJobRequest.php b/AiPlatform/src/V1/GetNotebookExecutionJobRequest.php new file mode 100644 index 000000000000..67183519e565 --- /dev/null +++ b/AiPlatform/src/V1/GetNotebookExecutionJobRequest.php @@ -0,0 +1,115 @@ +google.cloud.aiplatform.v1.GetNotebookExecutionJobRequest + */ +class GetNotebookExecutionJobRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The name of the NotebookExecutionJob resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $view = 0; + + /** + * @param string $name Required. The name of the NotebookExecutionJob resource. Please see + * {@see NotebookServiceClient::notebookExecutionJobName()} for help formatting this field. + * + * @return \Google\Cloud\AIPlatform\V1\GetNotebookExecutionJobRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The name of the NotebookExecutionJob resource. + * @type int $view + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The name of the NotebookExecutionJob resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The name of the NotebookExecutionJob resource. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getView() + { + return $this->view; + } + + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setView($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\NotebookExecutionJobView::class); + $this->view = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/GetPublisherModelRequest.php b/AiPlatform/src/V1/GetPublisherModelRequest.php index 8ad78476d64d..80ef5a08b744 100644 --- a/AiPlatform/src/V1/GetPublisherModelRequest.php +++ b/AiPlatform/src/V1/GetPublisherModelRequest.php @@ -26,7 +26,7 @@ class GetPublisherModelRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. The IETF BCP-47 language code representing the language in which - * the publisher model's text information should be written in (see go/bcp47). + * the publisher model's text information should be written in. * * Generated from protobuf field string language_code = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -37,6 +37,13 @@ class GetPublisherModelRequest extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.aiplatform.v1.PublisherModelView view = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $view = 0; + /** + * Optional. Boolean indicates whether the requested model is a Hugging Face + * model. + * + * Generated from protobuf field bool is_hugging_face_model = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $is_hugging_face_model = false; /** * @param string $name Required. The name of the PublisherModel resource. @@ -66,9 +73,12 @@ public static function build(string $name): self * `publishers/{publisher}/models/{publisher_model}` * @type string $language_code * Optional. The IETF BCP-47 language code representing the language in which - * the publisher model's text information should be written in (see go/bcp47). + * the publisher model's text information should be written in. * @type int $view * Optional. PublisherModel view specifying which fields to read. + * @type bool $is_hugging_face_model + * Optional. Boolean indicates whether the requested model is a Hugging Face + * model. * } */ public function __construct($data = NULL) { @@ -108,7 +118,7 @@ public function setName($var) /** * Optional. The IETF BCP-47 language code representing the language in which - * the publisher model's text information should be written in (see go/bcp47). + * the publisher model's text information should be written in. * * Generated from protobuf field string language_code = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -120,7 +130,7 @@ public function getLanguageCode() /** * Optional. The IETF BCP-47 language code representing the language in which - * the publisher model's text information should be written in (see go/bcp47). + * the publisher model's text information should be written in. * * Generated from protobuf field string language_code = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -160,5 +170,33 @@ public function setView($var) return $this; } + /** + * Optional. Boolean indicates whether the requested model is a Hugging Face + * model. + * + * Generated from protobuf field bool is_hugging_face_model = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getIsHuggingFaceModel() + { + return $this->is_hugging_face_model; + } + + /** + * Optional. Boolean indicates whether the requested model is a Hugging Face + * model. + * + * Generated from protobuf field bool is_hugging_face_model = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setIsHuggingFaceModel($var) + { + GPBUtil::checkBool($var); + $this->is_hugging_face_model = $var; + + return $this; + } + } diff --git a/AiPlatform/src/V1/GroundingChunk.php b/AiPlatform/src/V1/GroundingChunk.php new file mode 100644 index 000000000000..7949df2c35b3 --- /dev/null +++ b/AiPlatform/src/V1/GroundingChunk.php @@ -0,0 +1,108 @@ +google.cloud.aiplatform.v1.GroundingChunk + */ +class GroundingChunk extends \Google\Protobuf\Internal\Message +{ + protected $chunk_type; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\AIPlatform\V1\GroundingChunk\Web $web + * Grounding chunk from the web. + * @type \Google\Cloud\AIPlatform\V1\GroundingChunk\RetrievedContext $retrieved_context + * Grounding chunk from context retrieved by the retrieval tools. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\Content::initOnce(); + parent::__construct($data); + } + + /** + * Grounding chunk from the web. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GroundingChunk.Web web = 1; + * @return \Google\Cloud\AIPlatform\V1\GroundingChunk\Web|null + */ + public function getWeb() + { + return $this->readOneof(1); + } + + public function hasWeb() + { + return $this->hasOneof(1); + } + + /** + * Grounding chunk from the web. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GroundingChunk.Web web = 1; + * @param \Google\Cloud\AIPlatform\V1\GroundingChunk\Web $var + * @return $this + */ + public function setWeb($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\GroundingChunk\Web::class); + $this->writeOneof(1, $var); + + return $this; + } + + /** + * Grounding chunk from context retrieved by the retrieval tools. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GroundingChunk.RetrievedContext retrieved_context = 2; + * @return \Google\Cloud\AIPlatform\V1\GroundingChunk\RetrievedContext|null + */ + public function getRetrievedContext() + { + return $this->readOneof(2); + } + + public function hasRetrievedContext() + { + return $this->hasOneof(2); + } + + /** + * Grounding chunk from context retrieved by the retrieval tools. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.GroundingChunk.RetrievedContext retrieved_context = 2; + * @param \Google\Cloud\AIPlatform\V1\GroundingChunk\RetrievedContext $var + * @return $this + */ + public function setRetrievedContext($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\GroundingChunk\RetrievedContext::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * @return string + */ + public function getChunkType() + { + return $this->whichOneof("chunk_type"); + } + +} + diff --git a/AiPlatform/src/V1/GroundingChunk/RetrievedContext.php b/AiPlatform/src/V1/GroundingChunk/RetrievedContext.php new file mode 100644 index 000000000000..add14f056d98 --- /dev/null +++ b/AiPlatform/src/V1/GroundingChunk/RetrievedContext.php @@ -0,0 +1,122 @@ +google.cloud.aiplatform.v1.GroundingChunk.RetrievedContext + */ +class RetrievedContext extends \Google\Protobuf\Internal\Message +{ + /** + * URI reference of the attribution. + * + * Generated from protobuf field optional string uri = 1; + */ + protected $uri = null; + /** + * Title of the attribution. + * + * Generated from protobuf field optional string title = 2; + */ + protected $title = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * URI reference of the attribution. + * @type string $title + * Title of the attribution. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\Content::initOnce(); + parent::__construct($data); + } + + /** + * URI reference of the attribution. + * + * Generated from protobuf field optional string uri = 1; + * @return string + */ + public function getUri() + { + return isset($this->uri) ? $this->uri : ''; + } + + public function hasUri() + { + return isset($this->uri); + } + + public function clearUri() + { + unset($this->uri); + } + + /** + * URI reference of the attribution. + * + * Generated from protobuf field optional string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + + /** + * Title of the attribution. + * + * Generated from protobuf field optional string title = 2; + * @return string + */ + public function getTitle() + { + return isset($this->title) ? $this->title : ''; + } + + public function hasTitle() + { + return isset($this->title); + } + + public function clearTitle() + { + unset($this->title); + } + + /** + * Title of the attribution. + * + * Generated from protobuf field optional string title = 2; + * @param string $var + * @return $this + */ + public function setTitle($var) + { + GPBUtil::checkString($var, True); + $this->title = $var; + + return $this; + } + +} + + diff --git a/AiPlatform/src/V1/GroundingChunk/Web.php b/AiPlatform/src/V1/GroundingChunk/Web.php new file mode 100644 index 000000000000..9762feee5faa --- /dev/null +++ b/AiPlatform/src/V1/GroundingChunk/Web.php @@ -0,0 +1,122 @@ +google.cloud.aiplatform.v1.GroundingChunk.Web + */ +class Web extends \Google\Protobuf\Internal\Message +{ + /** + * URI reference of the chunk. + * + * Generated from protobuf field optional string uri = 1; + */ + protected $uri = null; + /** + * Title of the chunk. + * + * Generated from protobuf field optional string title = 2; + */ + protected $title = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * URI reference of the chunk. + * @type string $title + * Title of the chunk. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\Content::initOnce(); + parent::__construct($data); + } + + /** + * URI reference of the chunk. + * + * Generated from protobuf field optional string uri = 1; + * @return string + */ + public function getUri() + { + return isset($this->uri) ? $this->uri : ''; + } + + public function hasUri() + { + return isset($this->uri); + } + + public function clearUri() + { + unset($this->uri); + } + + /** + * URI reference of the chunk. + * + * Generated from protobuf field optional string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + + /** + * Title of the chunk. + * + * Generated from protobuf field optional string title = 2; + * @return string + */ + public function getTitle() + { + return isset($this->title) ? $this->title : ''; + } + + public function hasTitle() + { + return isset($this->title); + } + + public function clearTitle() + { + unset($this->title); + } + + /** + * Title of the chunk. + * + * Generated from protobuf field optional string title = 2; + * @param string $var + * @return $this + */ + public function setTitle($var) + { + GPBUtil::checkString($var, True); + $this->title = $var; + + return $this; + } + +} + + diff --git a/AiPlatform/src/V1/GroundingMetadata.php b/AiPlatform/src/V1/GroundingMetadata.php index 55381cf6539d..3fa308284dd7 100644 --- a/AiPlatform/src/V1/GroundingMetadata.php +++ b/AiPlatform/src/V1/GroundingMetadata.php @@ -27,6 +27,18 @@ class GroundingMetadata extends \Google\Protobuf\Internal\Message * Generated from protobuf field optional .google.cloud.aiplatform.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $search_entry_point = null; + /** + * List of supporting references retrieved from specified grounding source. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5; + */ + private $grounding_chunks; + /** + * Optional. List of grounding support. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $grounding_supports; /** * Constructor. @@ -38,6 +50,10 @@ class GroundingMetadata extends \Google\Protobuf\Internal\Message * Optional. Web search queries for the following-up web search. * @type \Google\Cloud\AIPlatform\V1\SearchEntryPoint $search_entry_point * Optional. Google search entry for the following-up web searches. + * @type array<\Google\Cloud\AIPlatform\V1\GroundingChunk>|\Google\Protobuf\Internal\RepeatedField $grounding_chunks + * List of supporting references retrieved from specified grounding source. + * @type array<\Google\Cloud\AIPlatform\V1\GroundingSupport>|\Google\Protobuf\Internal\RepeatedField $grounding_supports + * Optional. List of grounding support. * } */ public function __construct($data = NULL) { @@ -107,5 +123,57 @@ public function setSearchEntryPoint($var) return $this; } + /** + * List of supporting references retrieved from specified grounding source. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGroundingChunks() + { + return $this->grounding_chunks; + } + + /** + * List of supporting references retrieved from specified grounding source. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5; + * @param array<\Google\Cloud\AIPlatform\V1\GroundingChunk>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGroundingChunks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AIPlatform\V1\GroundingChunk::class); + $this->grounding_chunks = $arr; + + return $this; + } + + /** + * Optional. List of grounding support. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGroundingSupports() + { + return $this->grounding_supports; + } + + /** + * Optional. List of grounding support. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\AIPlatform\V1\GroundingSupport>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGroundingSupports($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AIPlatform\V1\GroundingSupport::class); + $this->grounding_supports = $arr; + + return $this; + } + } diff --git a/AiPlatform/src/V1/GroundingSupport.php b/AiPlatform/src/V1/GroundingSupport.php new file mode 100644 index 000000000000..aca65f189457 --- /dev/null +++ b/AiPlatform/src/V1/GroundingSupport.php @@ -0,0 +1,165 @@ +google.cloud.aiplatform.v1.GroundingSupport + */ +class GroundingSupport extends \Google\Protobuf\Internal\Message +{ + /** + * Segment of the content this support belongs to. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.Segment segment = 1; + */ + protected $segment = null; + /** + * A list of indices (into 'grounding_chunk') specifying the + * citations associated with the claim. For instance [1,3,4] means + * that grounding_chunk[1], grounding_chunk[3], + * grounding_chunk[4] are the retrieved content attributed to the claim. + * + * Generated from protobuf field repeated int32 grounding_chunk_indices = 2; + */ + private $grounding_chunk_indices; + /** + * Confidence score of the support references. Ranges from 0 to 1. 1 is the + * most confident. This list must have the same size as the + * grounding_chunk_indices. + * + * Generated from protobuf field repeated float confidence_scores = 3; + */ + private $confidence_scores; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\AIPlatform\V1\Segment $segment + * Segment of the content this support belongs to. + * @type array|\Google\Protobuf\Internal\RepeatedField $grounding_chunk_indices + * A list of indices (into 'grounding_chunk') specifying the + * citations associated with the claim. For instance [1,3,4] means + * that grounding_chunk[1], grounding_chunk[3], + * grounding_chunk[4] are the retrieved content attributed to the claim. + * @type array|\Google\Protobuf\Internal\RepeatedField $confidence_scores + * Confidence score of the support references. Ranges from 0 to 1. 1 is the + * most confident. This list must have the same size as the + * grounding_chunk_indices. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\Content::initOnce(); + parent::__construct($data); + } + + /** + * Segment of the content this support belongs to. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.Segment segment = 1; + * @return \Google\Cloud\AIPlatform\V1\Segment|null + */ + public function getSegment() + { + return $this->segment; + } + + public function hasSegment() + { + return isset($this->segment); + } + + public function clearSegment() + { + unset($this->segment); + } + + /** + * Segment of the content this support belongs to. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.Segment segment = 1; + * @param \Google\Cloud\AIPlatform\V1\Segment $var + * @return $this + */ + public function setSegment($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\Segment::class); + $this->segment = $var; + + return $this; + } + + /** + * A list of indices (into 'grounding_chunk') specifying the + * citations associated with the claim. For instance [1,3,4] means + * that grounding_chunk[1], grounding_chunk[3], + * grounding_chunk[4] are the retrieved content attributed to the claim. + * + * Generated from protobuf field repeated int32 grounding_chunk_indices = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getGroundingChunkIndices() + { + return $this->grounding_chunk_indices; + } + + /** + * A list of indices (into 'grounding_chunk') specifying the + * citations associated with the claim. For instance [1,3,4] means + * that grounding_chunk[1], grounding_chunk[3], + * grounding_chunk[4] are the retrieved content attributed to the claim. + * + * Generated from protobuf field repeated int32 grounding_chunk_indices = 2; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setGroundingChunkIndices($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::INT32); + $this->grounding_chunk_indices = $arr; + + return $this; + } + + /** + * Confidence score of the support references. Ranges from 0 to 1. 1 is the + * most confident. This list must have the same size as the + * grounding_chunk_indices. + * + * Generated from protobuf field repeated float confidence_scores = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getConfidenceScores() + { + return $this->confidence_scores; + } + + /** + * Confidence score of the support references. Ranges from 0 to 1. 1 is the + * most confident. This list must have the same size as the + * grounding_chunk_indices. + * + * Generated from protobuf field repeated float confidence_scores = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setConfidenceScores($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::FLOAT); + $this->confidence_scores = $arr; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/ListNotebookExecutionJobsRequest.php b/AiPlatform/src/V1/ListNotebookExecutionJobsRequest.php new file mode 100644 index 000000000000..37d0f27ffb0d --- /dev/null +++ b/AiPlatform/src/V1/ListNotebookExecutionJobsRequest.php @@ -0,0 +1,333 @@ +google.cloud.aiplatform.v1.ListNotebookExecutionJobsRequest + */ +class ListNotebookExecutionJobsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the Location from which to list the + * NotebookExecutionJobs. + * Format: `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. + * * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` + * represents the NotebookExecutionJob ID. + * * `displayName` supports = and != and regex. + * * `schedule` supports = and != and regex. + * Some examples: + * * `notebookExecutionJob="123"` + * * `notebookExecutionJob="my-execution-job"` + * * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + * + * Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. The standard list page size. + * + * Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. The standard list page token. + * Typically obtained via + * [ListNotebookExecutionJobs.next_page_token][] of the previous + * [NotebookService.ListNotebookExecutionJobs][google.cloud.aiplatform.v1.NotebookService.ListNotebookExecutionJobs] + * call. + * + * Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending + * order. Use "desc" after a field name for descending. Supported fields: + * * `display_name` + * * `create_time` + * * `update_time` + * Example: `display_name, create_time desc`. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $view = 0; + + /** + * @param string $parent Required. The resource name of the Location from which to list the + * NotebookExecutionJobs. + * Format: `projects/{project}/locations/{location}` + * Please see {@see NotebookServiceClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\AIPlatform\V1\ListNotebookExecutionJobsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The resource name of the Location from which to list the + * NotebookExecutionJobs. + * Format: `projects/{project}/locations/{location}` + * @type string $filter + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. + * * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` + * represents the NotebookExecutionJob ID. + * * `displayName` supports = and != and regex. + * * `schedule` supports = and != and regex. + * Some examples: + * * `notebookExecutionJob="123"` + * * `notebookExecutionJob="my-execution-job"` + * * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + * @type int $page_size + * Optional. The standard list page size. + * @type string $page_token + * Optional. The standard list page token. + * Typically obtained via + * [ListNotebookExecutionJobs.next_page_token][] of the previous + * [NotebookService.ListNotebookExecutionJobs][google.cloud.aiplatform.v1.NotebookService.ListNotebookExecutionJobs] + * call. + * @type string $order_by + * Optional. A comma-separated list of fields to order by, sorted in ascending + * order. Use "desc" after a field name for descending. Supported fields: + * * `display_name` + * * `create_time` + * * `update_time` + * Example: `display_name, create_time desc`. + * @type int $view + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the Location from which to list the + * NotebookExecutionJobs. + * Format: `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The resource name of the Location from which to list the + * NotebookExecutionJobs. + * Format: `projects/{project}/locations/{location}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. + * * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` + * represents the NotebookExecutionJob ID. + * * `displayName` supports = and != and regex. + * * `schedule` supports = and != and regex. + * Some examples: + * * `notebookExecutionJob="123"` + * * `notebookExecutionJob="my-execution-job"` + * * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + * + * Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. + * * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` + * represents the NotebookExecutionJob ID. + * * `displayName` supports = and != and regex. + * * `schedule` supports = and != and regex. + * Some examples: + * * `notebookExecutionJob="123"` + * * `notebookExecutionJob="my-execution-job"` + * * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + * + * Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. The standard list page size. + * + * Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The standard list page size. + * + * Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The standard list page token. + * Typically obtained via + * [ListNotebookExecutionJobs.next_page_token][] of the previous + * [NotebookService.ListNotebookExecutionJobs][google.cloud.aiplatform.v1.NotebookService.ListNotebookExecutionJobs] + * call. + * + * Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The standard list page token. + * Typically obtained via + * [ListNotebookExecutionJobs.next_page_token][] of the previous + * [NotebookService.ListNotebookExecutionJobs][google.cloud.aiplatform.v1.NotebookService.ListNotebookExecutionJobs] + * call. + * + * Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending + * order. Use "desc" after a field name for descending. Supported fields: + * * `display_name` + * * `create_time` + * * `update_time` + * Example: `display_name, create_time desc`. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending + * order. Use "desc" after a field name for descending. Supported fields: + * * `display_name` + * * `create_time` + * * `update_time` + * Example: `display_name, create_time desc`. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getView() + { + return $this->view; + } + + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setView($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\NotebookExecutionJobView::class); + $this->view = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/ListNotebookExecutionJobsResponse.php b/AiPlatform/src/V1/ListNotebookExecutionJobsResponse.php new file mode 100644 index 000000000000..a10e712c3175 --- /dev/null +++ b/AiPlatform/src/V1/ListNotebookExecutionJobsResponse.php @@ -0,0 +1,109 @@ +google.cloud.aiplatform.v1.ListNotebookExecutionJobsResponse + */ +class ListNotebookExecutionJobsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * List of NotebookExecutionJobs in the requested page. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.NotebookExecutionJob notebook_execution_jobs = 1; + */ + private $notebook_execution_jobs; + /** + * A token to retrieve next page of results. + * Pass to [ListNotebookExecutionJobs.page_token][] to obtain that + * page. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\AIPlatform\V1\NotebookExecutionJob>|\Google\Protobuf\Internal\RepeatedField $notebook_execution_jobs + * List of NotebookExecutionJobs in the requested page. + * @type string $next_page_token + * A token to retrieve next page of results. + * Pass to [ListNotebookExecutionJobs.page_token][] to obtain that + * page. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce(); + parent::__construct($data); + } + + /** + * List of NotebookExecutionJobs in the requested page. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.NotebookExecutionJob notebook_execution_jobs = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getNotebookExecutionJobs() + { + return $this->notebook_execution_jobs; + } + + /** + * List of NotebookExecutionJobs in the requested page. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.NotebookExecutionJob notebook_execution_jobs = 1; + * @param array<\Google\Cloud\AIPlatform\V1\NotebookExecutionJob>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setNotebookExecutionJobs($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AIPlatform\V1\NotebookExecutionJob::class); + $this->notebook_execution_jobs = $arr; + + return $this; + } + + /** + * A token to retrieve next page of results. + * Pass to [ListNotebookExecutionJobs.page_token][] to obtain that + * page. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token to retrieve next page of results. + * Pass to [ListNotebookExecutionJobs.page_token][] to obtain that + * page. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/NearestNeighborQuery.php b/AiPlatform/src/V1/NearestNeighborQuery.php index 6e527c3f9dec..9d8dfb3f6429 100644 --- a/AiPlatform/src/V1/NearestNeighborQuery.php +++ b/AiPlatform/src/V1/NearestNeighborQuery.php @@ -28,6 +28,12 @@ class NearestNeighborQuery extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $string_filters; + /** + * Optional. The list of numeric filters. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $numeric_filters; /** * Optional. Crowding is a constraint on a neighbor list produced by nearest * neighbor search requiring that no more than @@ -62,6 +68,8 @@ class NearestNeighborQuery extends \Google\Protobuf\Internal\Message * for each query. * @type array<\Google\Cloud\AIPlatform\V1\NearestNeighborQuery\StringFilter>|\Google\Protobuf\Internal\RepeatedField $string_filters * Optional. The list of string filters. + * @type array<\Google\Cloud\AIPlatform\V1\NearestNeighborQuery\NumericFilter>|\Google\Protobuf\Internal\RepeatedField $numeric_filters + * Optional. The list of numeric filters. * @type int $per_crowding_attribute_neighbor_count * Optional. Crowding is a constraint on a neighbor list produced by nearest * neighbor search requiring that no more than @@ -196,6 +204,32 @@ public function setStringFilters($var) return $this; } + /** + * Optional. The list of numeric filters. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getNumericFilters() + { + return $this->numeric_filters; + } + + /** + * Optional. The list of numeric filters. + * + * Generated from protobuf field repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL]; + * @param array<\Google\Cloud\AIPlatform\V1\NearestNeighborQuery\NumericFilter>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setNumericFilters($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\AIPlatform\V1\NearestNeighborQuery\NumericFilter::class); + $this->numeric_filters = $arr; + + return $this; + } + /** * Optional. Crowding is a constraint on a neighbor list produced by nearest * neighbor search requiring that no more than diff --git a/AiPlatform/src/V1/NearestNeighborQuery/NumericFilter.php b/AiPlatform/src/V1/NearestNeighborQuery/NumericFilter.php new file mode 100644 index 000000000000..e66434d5e4a5 --- /dev/null +++ b/AiPlatform/src/V1/NearestNeighborQuery/NumericFilter.php @@ -0,0 +1,231 @@ +google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter + */ +class NumericFilter extends \Google\Protobuf\Internal\Message +{ + /** + * Required. Column name in BigQuery that used as filters. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $name = ''; + /** + * Optional. This MUST be specified for queries and must NOT be specified + * for database points. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter.Operator op = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $op = null; + protected $Value; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $value_int + * int value type. + * @type float $value_float + * float value type. + * @type float $value_double + * double value type. + * @type string $name + * Required. Column name in BigQuery that used as filters. + * @type int $op + * Optional. This MUST be specified for queries and must NOT be specified + * for database points. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\FeatureOnlineStoreService::initOnce(); + parent::__construct($data); + } + + /** + * int value type. + * + * Generated from protobuf field int64 value_int = 2; + * @return int|string + */ + public function getValueInt() + { + return $this->readOneof(2); + } + + public function hasValueInt() + { + return $this->hasOneof(2); + } + + /** + * int value type. + * + * Generated from protobuf field int64 value_int = 2; + * @param int|string $var + * @return $this + */ + public function setValueInt($var) + { + GPBUtil::checkInt64($var); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * float value type. + * + * Generated from protobuf field float value_float = 3; + * @return float + */ + public function getValueFloat() + { + return $this->readOneof(3); + } + + public function hasValueFloat() + { + return $this->hasOneof(3); + } + + /** + * float value type. + * + * Generated from protobuf field float value_float = 3; + * @param float $var + * @return $this + */ + public function setValueFloat($var) + { + GPBUtil::checkFloat($var); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * double value type. + * + * Generated from protobuf field double value_double = 4; + * @return float + */ + public function getValueDouble() + { + return $this->readOneof(4); + } + + public function hasValueDouble() + { + return $this->hasOneof(4); + } + + /** + * double value type. + * + * Generated from protobuf field double value_double = 4; + * @param float $var + * @return $this + */ + public function setValueDouble($var) + { + GPBUtil::checkDouble($var); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * Required. Column name in BigQuery that used as filters. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. Column name in BigQuery that used as filters. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Optional. This MUST be specified for queries and must NOT be specified + * for database points. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter.Operator op = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getOp() + { + return isset($this->op) ? $this->op : 0; + } + + public function hasOp() + { + return isset($this->op); + } + + public function clearOp() + { + unset($this->op); + } + + /** + * Optional. This MUST be specified for queries and must NOT be specified + * for database points. + * + * Generated from protobuf field optional .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter.Operator op = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setOp($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\NearestNeighborQuery\NumericFilter\Operator::class); + $this->op = $var; + + return $this; + } + + /** + * @return string + */ + public function getValue() + { + return $this->whichOneof("Value"); + } + +} + + diff --git a/AiPlatform/src/V1/NearestNeighborQuery/NumericFilter/Operator.php b/AiPlatform/src/V1/NearestNeighborQuery/NumericFilter/Operator.php new file mode 100644 index 000000000000..0a781bb4c983 --- /dev/null +++ b/AiPlatform/src/V1/NearestNeighborQuery/NumericFilter/Operator.php @@ -0,0 +1,91 @@ +google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter.Operator + */ +class Operator +{ + /** + * Unspecified operator. + * + * Generated from protobuf enum OPERATOR_UNSPECIFIED = 0; + */ + const OPERATOR_UNSPECIFIED = 0; + /** + * Entities are eligible if their value is < the query's. + * + * Generated from protobuf enum LESS = 1; + */ + const LESS = 1; + /** + * Entities are eligible if their value is <= the query's. + * + * Generated from protobuf enum LESS_EQUAL = 2; + */ + const LESS_EQUAL = 2; + /** + * Entities are eligible if their value is == the query's. + * + * Generated from protobuf enum EQUAL = 3; + */ + const EQUAL = 3; + /** + * Entities are eligible if their value is >= the query's. + * + * Generated from protobuf enum GREATER_EQUAL = 4; + */ + const GREATER_EQUAL = 4; + /** + * Entities are eligible if their value is > the query's. + * + * Generated from protobuf enum GREATER = 5; + */ + const GREATER = 5; + /** + * Entities are eligible if their value is != the query's. + * + * Generated from protobuf enum NOT_EQUAL = 6; + */ + const NOT_EQUAL = 6; + + private static $valueToName = [ + self::OPERATOR_UNSPECIFIED => 'OPERATOR_UNSPECIFIED', + self::LESS => 'LESS', + self::LESS_EQUAL => 'LESS_EQUAL', + self::EQUAL => 'EQUAL', + self::GREATER_EQUAL => 'GREATER_EQUAL', + self::GREATER => 'GREATER', + self::NOT_EQUAL => 'NOT_EQUAL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AiPlatform/src/V1/NotebookExecutionJob.php b/AiPlatform/src/V1/NotebookExecutionJob.php new file mode 100644 index 000000000000..fc41927aac80 --- /dev/null +++ b/AiPlatform/src/V1/NotebookExecutionJob.php @@ -0,0 +1,704 @@ +google.cloud.aiplatform.v1.NotebookExecutionJob + */ +class NotebookExecutionJob extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The resource name of this NotebookExecutionJob. Format: + * `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $name = ''; + /** + * The display name of the NotebookExecutionJob. The name can be up to 128 + * characters long and can consist of any UTF-8 characters. + * + * Generated from protobuf field string display_name = 2; + */ + protected $display_name = ''; + /** + * Max running time of the execution job in seconds (default 86400s / 24 hrs). + * + * Generated from protobuf field .google.protobuf.Duration execution_timeout = 5; + */ + protected $execution_timeout = null; + /** + * Output only. The Schedule resource name if this job is triggered by one. + * Format: + * `projects/{project_id}/locations/{location}/schedules/{schedule_id}` + * + * Generated from protobuf field string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + */ + protected $schedule_resource_name = ''; + /** + * Output only. The state of the NotebookExecutionJob. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $job_state = 0; + /** + * Output only. Populated when the NotebookExecutionJob is completed. When + * there is an error during notebook execution, the error details are + * populated. + * + * Generated from protobuf field .google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = null; + /** + * Output only. Timestamp when this NotebookExecutionJob was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. Timestamp when this NotebookExecutionJob was most recently + * updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * The labels with user-defined metadata to organize NotebookExecutionJobs. + * Label keys and values can be no longer than 64 characters + * (Unicode codepoints), can only contain lowercase letters, numeric + * characters, underscores and dashes. International characters are allowed. + * See https://goo.gl/xmQnxf for more information and examples of labels. + * System reserved label keys are prefixed with "aiplatform.googleapis.com/" + * and are immutable. + * + * Generated from protobuf field map labels = 19; + */ + private $labels; + protected $notebook_source; + protected $environment_spec; + protected $execution_sink; + protected $execution_identity; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\DataformRepositorySource $dataform_repository_source + * The Dataform Repository pointing to a single file notebook repository. + * @type \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\GcsNotebookSource $gcs_notebook_source + * The Cloud Storage url pointing to the ipynb file. Format: + * `gs://bucket/notebook_file.ipynb` + * @type \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\DirectNotebookSource $direct_notebook_source + * The contents of an input notebook file. + * @type string $notebook_runtime_template_resource_name + * The NotebookRuntimeTemplate to source compute configuration from. + * @type string $gcs_output_uri + * The Cloud Storage location to upload the result to. Format: + * `gs://bucket-name` + * @type string $execution_user + * The user email to run the execution as. Only supported by Colab runtimes. + * @type string $service_account + * The service account to run the execution as. + * @type string $name + * Output only. The resource name of this NotebookExecutionJob. Format: + * `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` + * @type string $display_name + * The display name of the NotebookExecutionJob. The name can be up to 128 + * characters long and can consist of any UTF-8 characters. + * @type \Google\Protobuf\Duration $execution_timeout + * Max running time of the execution job in seconds (default 86400s / 24 hrs). + * @type string $schedule_resource_name + * Output only. The Schedule resource name if this job is triggered by one. + * Format: + * `projects/{project_id}/locations/{location}/schedules/{schedule_id}` + * @type int $job_state + * Output only. The state of the NotebookExecutionJob. + * @type \Google\Rpc\Status $status + * Output only. Populated when the NotebookExecutionJob is completed. When + * there is an error during notebook execution, the error details are + * populated. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. Timestamp when this NotebookExecutionJob was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. Timestamp when this NotebookExecutionJob was most recently + * updated. + * @type array|\Google\Protobuf\Internal\MapField $labels + * The labels with user-defined metadata to organize NotebookExecutionJobs. + * Label keys and values can be no longer than 64 characters + * (Unicode codepoints), can only contain lowercase letters, numeric + * characters, underscores and dashes. International characters are allowed. + * See https://goo.gl/xmQnxf for more information and examples of labels. + * System reserved label keys are prefixed with "aiplatform.googleapis.com/" + * and are immutable. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookExecutionJob::initOnce(); + parent::__construct($data); + } + + /** + * The Dataform Repository pointing to a single file notebook repository. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3; + * @return \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\DataformRepositorySource|null + */ + public function getDataformRepositorySource() + { + return $this->readOneof(3); + } + + public function hasDataformRepositorySource() + { + return $this->hasOneof(3); + } + + /** + * The Dataform Repository pointing to a single file notebook repository. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3; + * @param \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\DataformRepositorySource $var + * @return $this + */ + public function setDataformRepositorySource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\DataformRepositorySource::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * The Cloud Storage url pointing to the ipynb file. Format: + * `gs://bucket/notebook_file.ipynb` + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4; + * @return \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\GcsNotebookSource|null + */ + public function getGcsNotebookSource() + { + return $this->readOneof(4); + } + + public function hasGcsNotebookSource() + { + return $this->hasOneof(4); + } + + /** + * The Cloud Storage url pointing to the ipynb file. Format: + * `gs://bucket/notebook_file.ipynb` + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4; + * @param \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\GcsNotebookSource $var + * @return $this + */ + public function setGcsNotebookSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\GcsNotebookSource::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * The contents of an input notebook file. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17; + * @return \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\DirectNotebookSource|null + */ + public function getDirectNotebookSource() + { + return $this->readOneof(17); + } + + public function hasDirectNotebookSource() + { + return $this->hasOneof(17); + } + + /** + * The contents of an input notebook file. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17; + * @param \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\DirectNotebookSource $var + * @return $this + */ + public function setDirectNotebookSource($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\NotebookExecutionJob\DirectNotebookSource::class); + $this->writeOneof(17, $var); + + return $this; + } + + /** + * The NotebookRuntimeTemplate to source compute configuration from. + * + * Generated from protobuf field string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { + * @return string + */ + public function getNotebookRuntimeTemplateResourceName() + { + return $this->readOneof(14); + } + + public function hasNotebookRuntimeTemplateResourceName() + { + return $this->hasOneof(14); + } + + /** + * The NotebookRuntimeTemplate to source compute configuration from. + * + * Generated from protobuf field string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setNotebookRuntimeTemplateResourceName($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(14, $var); + + return $this; + } + + /** + * The Cloud Storage location to upload the result to. Format: + * `gs://bucket-name` + * + * Generated from protobuf field string gcs_output_uri = 8; + * @return string + */ + public function getGcsOutputUri() + { + return $this->readOneof(8); + } + + public function hasGcsOutputUri() + { + return $this->hasOneof(8); + } + + /** + * The Cloud Storage location to upload the result to. Format: + * `gs://bucket-name` + * + * Generated from protobuf field string gcs_output_uri = 8; + * @param string $var + * @return $this + */ + public function setGcsOutputUri($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(8, $var); + + return $this; + } + + /** + * The user email to run the execution as. Only supported by Colab runtimes. + * + * Generated from protobuf field string execution_user = 9; + * @return string + */ + public function getExecutionUser() + { + return $this->readOneof(9); + } + + public function hasExecutionUser() + { + return $this->hasOneof(9); + } + + /** + * The user email to run the execution as. Only supported by Colab runtimes. + * + * Generated from protobuf field string execution_user = 9; + * @param string $var + * @return $this + */ + public function setExecutionUser($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(9, $var); + + return $this; + } + + /** + * The service account to run the execution as. + * + * Generated from protobuf field string service_account = 18; + * @return string + */ + public function getServiceAccount() + { + return $this->readOneof(18); + } + + public function hasServiceAccount() + { + return $this->hasOneof(18); + } + + /** + * The service account to run the execution as. + * + * Generated from protobuf field string service_account = 18; + * @param string $var + * @return $this + */ + public function setServiceAccount($var) + { + GPBUtil::checkString($var, True); + $this->writeOneof(18, $var); + + return $this; + } + + /** + * Output only. The resource name of this NotebookExecutionJob. Format: + * `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Output only. The resource name of this NotebookExecutionJob. Format: + * `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * The display name of the NotebookExecutionJob. The name can be up to 128 + * characters long and can consist of any UTF-8 characters. + * + * Generated from protobuf field string display_name = 2; + * @return string + */ + public function getDisplayName() + { + return $this->display_name; + } + + /** + * The display name of the NotebookExecutionJob. The name can be up to 128 + * characters long and can consist of any UTF-8 characters. + * + * Generated from protobuf field string display_name = 2; + * @param string $var + * @return $this + */ + public function setDisplayName($var) + { + GPBUtil::checkString($var, True); + $this->display_name = $var; + + return $this; + } + + /** + * Max running time of the execution job in seconds (default 86400s / 24 hrs). + * + * Generated from protobuf field .google.protobuf.Duration execution_timeout = 5; + * @return \Google\Protobuf\Duration|null + */ + public function getExecutionTimeout() + { + return $this->execution_timeout; + } + + public function hasExecutionTimeout() + { + return isset($this->execution_timeout); + } + + public function clearExecutionTimeout() + { + unset($this->execution_timeout); + } + + /** + * Max running time of the execution job in seconds (default 86400s / 24 hrs). + * + * Generated from protobuf field .google.protobuf.Duration execution_timeout = 5; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setExecutionTimeout($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->execution_timeout = $var; + + return $this; + } + + /** + * Output only. The Schedule resource name if this job is triggered by one. + * Format: + * `projects/{project_id}/locations/{location}/schedules/{schedule_id}` + * + * Generated from protobuf field string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @return string + */ + public function getScheduleResourceName() + { + return $this->schedule_resource_name; + } + + /** + * Output only. The Schedule resource name if this job is triggered by one. + * Format: + * `projects/{project_id}/locations/{location}/schedules/{schedule_id}` + * + * Generated from protobuf field string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setScheduleResourceName($var) + { + GPBUtil::checkString($var, True); + $this->schedule_resource_name = $var; + + return $this; + } + + /** + * Output only. The state of the NotebookExecutionJob. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getJobState() + { + return $this->job_state; + } + + /** + * Output only. The state of the NotebookExecutionJob. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setJobState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\JobState::class); + $this->job_state = $var; + + return $this; + } + + /** + * Output only. Populated when the NotebookExecutionJob is completed. When + * there is an error during notebook execution, the error details are + * populated. + * + * Generated from protobuf field .google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Rpc\Status|null + */ + public function getStatus() + { + return $this->status; + } + + public function hasStatus() + { + return isset($this->status); + } + + public function clearStatus() + { + unset($this->status); + } + + /** + * Output only. Populated when the NotebookExecutionJob is completed. When + * there is an error during notebook execution, the error details are + * populated. + * + * Generated from protobuf field .google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Rpc\Status $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkMessage($var, \Google\Rpc\Status::class); + $this->status = $var; + + return $this; + } + + /** + * Output only. Timestamp when this NotebookExecutionJob was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. Timestamp when this NotebookExecutionJob was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. Timestamp when this NotebookExecutionJob was most recently + * updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. Timestamp when this NotebookExecutionJob was most recently + * updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * The labels with user-defined metadata to organize NotebookExecutionJobs. + * Label keys and values can be no longer than 64 characters + * (Unicode codepoints), can only contain lowercase letters, numeric + * characters, underscores and dashes. International characters are allowed. + * See https://goo.gl/xmQnxf for more information and examples of labels. + * System reserved label keys are prefixed with "aiplatform.googleapis.com/" + * and are immutable. + * + * Generated from protobuf field map labels = 19; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * The labels with user-defined metadata to organize NotebookExecutionJobs. + * Label keys and values can be no longer than 64 characters + * (Unicode codepoints), can only contain lowercase letters, numeric + * characters, underscores and dashes. International characters are allowed. + * See https://goo.gl/xmQnxf for more information and examples of labels. + * System reserved label keys are prefixed with "aiplatform.googleapis.com/" + * and are immutable. + * + * Generated from protobuf field map labels = 19; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * @return string + */ + public function getNotebookSource() + { + return $this->whichOneof("notebook_source"); + } + + /** + * @return string + */ + public function getEnvironmentSpec() + { + return $this->whichOneof("environment_spec"); + } + + /** + * @return string + */ + public function getExecutionSink() + { + return $this->whichOneof("execution_sink"); + } + + /** + * @return string + */ + public function getExecutionIdentity() + { + return $this->whichOneof("execution_identity"); + } + +} + diff --git a/AiPlatform/src/V1/NotebookExecutionJob/DataformRepositorySource.php b/AiPlatform/src/V1/NotebookExecutionJob/DataformRepositorySource.php new file mode 100644 index 000000000000..94f601c02482 --- /dev/null +++ b/AiPlatform/src/V1/NotebookExecutionJob/DataformRepositorySource.php @@ -0,0 +1,110 @@ +google.cloud.aiplatform.v1.NotebookExecutionJob.DataformRepositorySource + */ +class DataformRepositorySource extends \Google\Protobuf\Internal\Message +{ + /** + * The resource name of the Dataform Repository. Format: + * `projects/{project_id}/locations/{location}/repositories/{repository_id}` + * + * Generated from protobuf field string dataform_repository_resource_name = 1; + */ + protected $dataform_repository_resource_name = ''; + /** + * The commit SHA to read repository with. If unset, the file will be read + * at HEAD. + * + * Generated from protobuf field string commit_sha = 2; + */ + protected $commit_sha = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $dataform_repository_resource_name + * The resource name of the Dataform Repository. Format: + * `projects/{project_id}/locations/{location}/repositories/{repository_id}` + * @type string $commit_sha + * The commit SHA to read repository with. If unset, the file will be read + * at HEAD. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookExecutionJob::initOnce(); + parent::__construct($data); + } + + /** + * The resource name of the Dataform Repository. Format: + * `projects/{project_id}/locations/{location}/repositories/{repository_id}` + * + * Generated from protobuf field string dataform_repository_resource_name = 1; + * @return string + */ + public function getDataformRepositoryResourceName() + { + return $this->dataform_repository_resource_name; + } + + /** + * The resource name of the Dataform Repository. Format: + * `projects/{project_id}/locations/{location}/repositories/{repository_id}` + * + * Generated from protobuf field string dataform_repository_resource_name = 1; + * @param string $var + * @return $this + */ + public function setDataformRepositoryResourceName($var) + { + GPBUtil::checkString($var, True); + $this->dataform_repository_resource_name = $var; + + return $this; + } + + /** + * The commit SHA to read repository with. If unset, the file will be read + * at HEAD. + * + * Generated from protobuf field string commit_sha = 2; + * @return string + */ + public function getCommitSha() + { + return $this->commit_sha; + } + + /** + * The commit SHA to read repository with. If unset, the file will be read + * at HEAD. + * + * Generated from protobuf field string commit_sha = 2; + * @param string $var + * @return $this + */ + public function setCommitSha($var) + { + GPBUtil::checkString($var, True); + $this->commit_sha = $var; + + return $this; + } + +} + + diff --git a/AiPlatform/src/V1/NotebookExecutionJob/DirectNotebookSource.php b/AiPlatform/src/V1/NotebookExecutionJob/DirectNotebookSource.php new file mode 100644 index 000000000000..ad66d3410995 --- /dev/null +++ b/AiPlatform/src/V1/NotebookExecutionJob/DirectNotebookSource.php @@ -0,0 +1,68 @@ +google.cloud.aiplatform.v1.NotebookExecutionJob.DirectNotebookSource + */ +class DirectNotebookSource extends \Google\Protobuf\Internal\Message +{ + /** + * The base64-encoded contents of the input notebook file. + * + * Generated from protobuf field bytes content = 1; + */ + protected $content = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $content + * The base64-encoded contents of the input notebook file. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookExecutionJob::initOnce(); + parent::__construct($data); + } + + /** + * The base64-encoded contents of the input notebook file. + * + * Generated from protobuf field bytes content = 1; + * @return string + */ + public function getContent() + { + return $this->content; + } + + /** + * The base64-encoded contents of the input notebook file. + * + * Generated from protobuf field bytes content = 1; + * @param string $var + * @return $this + */ + public function setContent($var) + { + GPBUtil::checkString($var, False); + $this->content = $var; + + return $this; + } + +} + + diff --git a/AiPlatform/src/V1/NotebookExecutionJob/GcsNotebookSource.php b/AiPlatform/src/V1/NotebookExecutionJob/GcsNotebookSource.php new file mode 100644 index 000000000000..ee4fec8e6dda --- /dev/null +++ b/AiPlatform/src/V1/NotebookExecutionJob/GcsNotebookSource.php @@ -0,0 +1,114 @@ +google.cloud.aiplatform.v1.NotebookExecutionJob.GcsNotebookSource + */ +class GcsNotebookSource extends \Google\Protobuf\Internal\Message +{ + /** + * The Cloud Storage uri pointing to the ipynb file. Format: + * `gs://bucket/notebook_file.ipynb` + * + * Generated from protobuf field string uri = 1; + */ + protected $uri = ''; + /** + * The version of the Cloud Storage object to read. If unset, the current + * version of the object is read. See + * https://cloud.google.com/storage/docs/metadata#generation-number. + * + * Generated from protobuf field string generation = 2; + */ + protected $generation = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $uri + * The Cloud Storage uri pointing to the ipynb file. Format: + * `gs://bucket/notebook_file.ipynb` + * @type string $generation + * The version of the Cloud Storage object to read. If unset, the current + * version of the object is read. See + * https://cloud.google.com/storage/docs/metadata#generation-number. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookExecutionJob::initOnce(); + parent::__construct($data); + } + + /** + * The Cloud Storage uri pointing to the ipynb file. Format: + * `gs://bucket/notebook_file.ipynb` + * + * Generated from protobuf field string uri = 1; + * @return string + */ + public function getUri() + { + return $this->uri; + } + + /** + * The Cloud Storage uri pointing to the ipynb file. Format: + * `gs://bucket/notebook_file.ipynb` + * + * Generated from protobuf field string uri = 1; + * @param string $var + * @return $this + */ + public function setUri($var) + { + GPBUtil::checkString($var, True); + $this->uri = $var; + + return $this; + } + + /** + * The version of the Cloud Storage object to read. If unset, the current + * version of the object is read. See + * https://cloud.google.com/storage/docs/metadata#generation-number. + * + * Generated from protobuf field string generation = 2; + * @return string + */ + public function getGeneration() + { + return $this->generation; + } + + /** + * The version of the Cloud Storage object to read. If unset, the current + * version of the object is read. See + * https://cloud.google.com/storage/docs/metadata#generation-number. + * + * Generated from protobuf field string generation = 2; + * @param string $var + * @return $this + */ + public function setGeneration($var) + { + GPBUtil::checkString($var, True); + $this->generation = $var; + + return $this; + } + +} + + diff --git a/AiPlatform/src/V1/NotebookExecutionJobView.php b/AiPlatform/src/V1/NotebookExecutionJobView.php new file mode 100644 index 000000000000..47dad924cba7 --- /dev/null +++ b/AiPlatform/src/V1/NotebookExecutionJobView.php @@ -0,0 +1,61 @@ +google.cloud.aiplatform.v1.NotebookExecutionJobView + */ +class NotebookExecutionJobView +{ + /** + * When unspecified, the API defaults to the BASIC view. + * + * Generated from protobuf enum NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED = 0; + */ + const NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED = 0; + /** + * Includes all fields except for direct notebook inputs. + * + * Generated from protobuf enum NOTEBOOK_EXECUTION_JOB_VIEW_BASIC = 1; + */ + const NOTEBOOK_EXECUTION_JOB_VIEW_BASIC = 1; + /** + * Includes all fields. + * + * Generated from protobuf enum NOTEBOOK_EXECUTION_JOB_VIEW_FULL = 2; + */ + const NOTEBOOK_EXECUTION_JOB_VIEW_FULL = 2; + + private static $valueToName = [ + self::NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED => 'NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED', + self::NOTEBOOK_EXECUTION_JOB_VIEW_BASIC => 'NOTEBOOK_EXECUTION_JOB_VIEW_BASIC', + self::NOTEBOOK_EXECUTION_JOB_VIEW_FULL => 'NOTEBOOK_EXECUTION_JOB_VIEW_FULL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + diff --git a/AiPlatform/src/V1/RayLogsSpec.php b/AiPlatform/src/V1/RayLogsSpec.php new file mode 100644 index 000000000000..e87b221ac95c --- /dev/null +++ b/AiPlatform/src/V1/RayLogsSpec.php @@ -0,0 +1,67 @@ +google.cloud.aiplatform.v1.RayLogsSpec + */ +class RayLogsSpec extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + * + * Generated from protobuf field bool disabled = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $disabled = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type bool $disabled + * Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\PersistentResource::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + * + * Generated from protobuf field bool disabled = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getDisabled() + { + return $this->disabled; + } + + /** + * Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + * + * Generated from protobuf field bool disabled = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setDisabled($var) + { + GPBUtil::checkBool($var); + $this->disabled = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/RaySpec.php b/AiPlatform/src/V1/RaySpec.php index d8354d76c376..3525a9545cb2 100644 --- a/AiPlatform/src/V1/RaySpec.php +++ b/AiPlatform/src/V1/RaySpec.php @@ -58,6 +58,12 @@ class RaySpec extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.aiplatform.v1.RayMetricSpec ray_metric_spec = 8 [(.google.api.field_behavior) = OPTIONAL]; */ protected $ray_metric_spec = null; + /** + * Optional. OSS Ray logging configurations. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $ray_logs_spec = null; /** * Constructor. @@ -89,6 +95,8 @@ class RaySpec extends \Google\Protobuf\Internal\Message * set. * @type \Google\Cloud\AIPlatform\V1\RayMetricSpec $ray_metric_spec * Optional. Ray metrics configurations. + * @type \Google\Cloud\AIPlatform\V1\RayLogsSpec $ray_logs_spec + * Optional. OSS Ray logging configurations. * } */ public function __construct($data = NULL) { @@ -242,5 +250,41 @@ public function setRayMetricSpec($var) return $this; } + /** + * Optional. OSS Ray logging configurations. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\AIPlatform\V1\RayLogsSpec|null + */ + public function getRayLogsSpec() + { + return $this->ray_logs_spec; + } + + public function hasRayLogsSpec() + { + return isset($this->ray_logs_spec); + } + + public function clearRayLogsSpec() + { + unset($this->ray_logs_spec); + } + + /** + * Optional. OSS Ray logging configurations. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.RayLogsSpec ray_logs_spec = 10 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\AIPlatform\V1\RayLogsSpec $var + * @return $this + */ + public function setRayLogsSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\RayLogsSpec::class); + $this->ray_logs_spec = $var; + + return $this; + } + } diff --git a/AiPlatform/src/V1/Retrieval.php b/AiPlatform/src/V1/Retrieval.php index 584bb80f7da7..2a6fe4a832f0 100644 --- a/AiPlatform/src/V1/Retrieval.php +++ b/AiPlatform/src/V1/Retrieval.php @@ -16,11 +16,10 @@ class Retrieval extends \Google\Protobuf\Internal\Message { /** - * Optional. Disable using the result from this tool in detecting grounding - * attribution. This does not affect how the result is given to the model for - * generation. + * Optional. Deprecated. This option is no longer supported. * - * Generated from protobuf field bool disable_attribution = 3 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field bool disable_attribution = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; + * @deprecated */ protected $disable_attribution = false; protected $source; @@ -34,9 +33,7 @@ class Retrieval extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\AIPlatform\V1\VertexAISearch $vertex_ai_search * Set to use data source powered by Vertex AI Search. * @type bool $disable_attribution - * Optional. Disable using the result from this tool in detecting grounding - * attribution. This does not affect how the result is given to the model for - * generation. + * Optional. Deprecated. This option is no longer supported. * } */ public function __construct($data = NULL) { @@ -76,29 +73,29 @@ public function setVertexAiSearch($var) } /** - * Optional. Disable using the result from this tool in detecting grounding - * attribution. This does not affect how the result is given to the model for - * generation. + * Optional. Deprecated. This option is no longer supported. * - * Generated from protobuf field bool disable_attribution = 3 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field bool disable_attribution = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; * @return bool + * @deprecated */ public function getDisableAttribution() { + @trigger_error('disable_attribution is deprecated.', E_USER_DEPRECATED); return $this->disable_attribution; } /** - * Optional. Disable using the result from this tool in detecting grounding - * attribution. This does not affect how the result is given to the model for - * generation. + * Optional. Deprecated. This option is no longer supported. * - * Generated from protobuf field bool disable_attribution = 3 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field bool disable_attribution = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; * @param bool $var * @return $this + * @deprecated */ public function setDisableAttribution($var) { + @trigger_error('disable_attribution is deprecated.', E_USER_DEPRECATED); GPBUtil::checkBool($var); $this->disable_attribution = $var; diff --git a/AiPlatform/src/V1/Scheduling.php b/AiPlatform/src/V1/Scheduling.php index 8f2c96c214b2..22bc476f9a17 100644 --- a/AiPlatform/src/V1/Scheduling.php +++ b/AiPlatform/src/V1/Scheduling.php @@ -29,6 +29,12 @@ class Scheduling extends \Google\Protobuf\Internal\Message * Generated from protobuf field bool restart_job_on_worker_restart = 3; */ protected $restart_job_on_worker_restart = false; + /** + * Optional. This determines which type of scheduling strategy to use. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.Scheduling.Strategy strategy = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $strategy = 0; /** * Optional. Indicates if the job should retry for internal errors after the * job starts running. If true, overrides @@ -50,6 +56,8 @@ class Scheduling extends \Google\Protobuf\Internal\Message * Restarts the entire CustomJob if a worker gets restarted. * This feature can be used by distributed training jobs that are not * resilient to workers leaving and joining a job. + * @type int $strategy + * Optional. This determines which type of scheduling strategy to use. * @type bool $disable_retries * Optional. Indicates if the job should retry for internal errors after the * job starts running. If true, overrides @@ -127,6 +135,32 @@ public function setRestartJobOnWorkerRestart($var) return $this; } + /** + * Optional. This determines which type of scheduling strategy to use. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.Scheduling.Strategy strategy = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getStrategy() + { + return $this->strategy; + } + + /** + * Optional. This determines which type of scheduling strategy to use. + * + * Generated from protobuf field .google.cloud.aiplatform.v1.Scheduling.Strategy strategy = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setStrategy($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\Scheduling\Strategy::class); + $this->strategy = $var; + + return $this; + } + /** * Optional. Indicates if the job should retry for internal errors after the * job starts running. If true, overrides diff --git a/AiPlatform/src/V1/Scheduling/Strategy.php b/AiPlatform/src/V1/Scheduling/Strategy.php new file mode 100644 index 000000000000..2c027eb99eb4 --- /dev/null +++ b/AiPlatform/src/V1/Scheduling/Strategy.php @@ -0,0 +1,66 @@ +google.cloud.aiplatform.v1.Scheduling.Strategy + */ +class Strategy +{ + /** + * Strategy will default to ON_DEMAND. + * + * Generated from protobuf enum STRATEGY_UNSPECIFIED = 0; + */ + const STRATEGY_UNSPECIFIED = 0; + /** + * Regular on-demand provisioning strategy. + * + * Generated from protobuf enum ON_DEMAND = 1; + */ + const ON_DEMAND = 1; + /** + * Low cost by making potential use of spot resources. + * + * Generated from protobuf enum LOW_COST = 2; + */ + const LOW_COST = 2; + + private static $valueToName = [ + self::STRATEGY_UNSPECIFIED => 'STRATEGY_UNSPECIFIED', + self::ON_DEMAND => 'ON_DEMAND', + self::LOW_COST => 'LOW_COST', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/AiPlatform/src/V1/Segment.php b/AiPlatform/src/V1/Segment.php new file mode 100644 index 000000000000..7d756224d119 --- /dev/null +++ b/AiPlatform/src/V1/Segment.php @@ -0,0 +1,177 @@ +google.cloud.aiplatform.v1.Segment + */ +class Segment extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The index of a Part object within its parent Content object. + * + * Generated from protobuf field int32 part_index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $part_index = 0; + /** + * Output only. Start index in the given Part, measured in bytes. Offset from + * the start of the Part, inclusive, starting at zero. + * + * Generated from protobuf field int32 start_index = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $start_index = 0; + /** + * Output only. End index in the given Part, measured in bytes. Offset from + * the start of the Part, exclusive, starting at zero. + * + * Generated from protobuf field int32 end_index = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $end_index = 0; + /** + * Output only. The text corresponding to the segment from the response. + * + * Generated from protobuf field string text = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $text = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $part_index + * Output only. The index of a Part object within its parent Content object. + * @type int $start_index + * Output only. Start index in the given Part, measured in bytes. Offset from + * the start of the Part, inclusive, starting at zero. + * @type int $end_index + * Output only. End index in the given Part, measured in bytes. Offset from + * the start of the Part, exclusive, starting at zero. + * @type string $text + * Output only. The text corresponding to the segment from the response. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Aiplatform\V1\Content::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The index of a Part object within its parent Content object. + * + * Generated from protobuf field int32 part_index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getPartIndex() + { + return $this->part_index; + } + + /** + * Output only. The index of a Part object within its parent Content object. + * + * Generated from protobuf field int32 part_index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setPartIndex($var) + { + GPBUtil::checkInt32($var); + $this->part_index = $var; + + return $this; + } + + /** + * Output only. Start index in the given Part, measured in bytes. Offset from + * the start of the Part, inclusive, starting at zero. + * + * Generated from protobuf field int32 start_index = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getStartIndex() + { + return $this->start_index; + } + + /** + * Output only. Start index in the given Part, measured in bytes. Offset from + * the start of the Part, inclusive, starting at zero. + * + * Generated from protobuf field int32 start_index = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setStartIndex($var) + { + GPBUtil::checkInt32($var); + $this->start_index = $var; + + return $this; + } + + /** + * Output only. End index in the given Part, measured in bytes. Offset from + * the start of the Part, exclusive, starting at zero. + * + * Generated from protobuf field int32 end_index = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getEndIndex() + { + return $this->end_index; + } + + /** + * Output only. End index in the given Part, measured in bytes. Offset from + * the start of the Part, exclusive, starting at zero. + * + * Generated from protobuf field int32 end_index = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setEndIndex($var) + { + GPBUtil::checkInt32($var); + $this->end_index = $var; + + return $this; + } + + /** + * Output only. The text corresponding to the segment from the response. + * + * Generated from protobuf field string text = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getText() + { + return $this->text; + } + + /** + * Output only. The text corresponding to the segment from the response. + * + * Generated from protobuf field string text = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->text = $var; + + return $this; + } + +} + diff --git a/AiPlatform/src/V1/SupervisedTuningDataStats.php b/AiPlatform/src/V1/SupervisedTuningDataStats.php index ffb3538df044..6935fbdd6e68 100644 --- a/AiPlatform/src/V1/SupervisedTuningDataStats.php +++ b/AiPlatform/src/V1/SupervisedTuningDataStats.php @@ -30,9 +30,16 @@ class SupervisedTuningDataStats extends \Google\Protobuf\Internal\Message /** * Output only. Number of billable characters in the tuning dataset. * - * Generated from protobuf field int64 total_billable_character_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field int64 total_billable_character_count = 3 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; + * @deprecated */ protected $total_billable_character_count = 0; + /** + * Output only. Number of billable tokens in the tuning dataset. + * + * Generated from protobuf field int64 total_billable_token_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $total_billable_token_count = 0; /** * Output only. Number of tuning steps for this Tuning Job. * @@ -76,6 +83,8 @@ class SupervisedTuningDataStats extends \Google\Protobuf\Internal\Message * Output only. Number of tuning characters in the tuning dataset. * @type int|string $total_billable_character_count * Output only. Number of billable characters in the tuning dataset. + * @type int|string $total_billable_token_count + * Output only. Number of billable tokens in the tuning dataset. * @type int|string $tuning_step_count * Output only. Number of tuning steps for this Tuning Job. * @type \Google\Cloud\AIPlatform\V1\SupervisedTuningDatasetDistribution $user_input_token_distribution @@ -148,29 +157,59 @@ public function setTotalTuningCharacterCount($var) /** * Output only. Number of billable characters in the tuning dataset. * - * Generated from protobuf field int64 total_billable_character_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field int64 total_billable_character_count = 3 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; * @return int|string + * @deprecated */ public function getTotalBillableCharacterCount() { + @trigger_error('total_billable_character_count is deprecated.', E_USER_DEPRECATED); return $this->total_billable_character_count; } /** * Output only. Number of billable characters in the tuning dataset. * - * Generated from protobuf field int64 total_billable_character_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * Generated from protobuf field int64 total_billable_character_count = 3 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY]; * @param int|string $var * @return $this + * @deprecated */ public function setTotalBillableCharacterCount($var) { + @trigger_error('total_billable_character_count is deprecated.', E_USER_DEPRECATED); GPBUtil::checkInt64($var); $this->total_billable_character_count = $var; return $this; } + /** + * Output only. Number of billable tokens in the tuning dataset. + * + * Generated from protobuf field int64 total_billable_token_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getTotalBillableTokenCount() + { + return $this->total_billable_token_count; + } + + /** + * Output only. Number of billable tokens in the tuning dataset. + * + * Generated from protobuf field int64 total_billable_token_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setTotalBillableTokenCount($var) + { + GPBUtil::checkInt64($var); + $this->total_billable_token_count = $var; + + return $this; + } + /** * Output only. Number of tuning steps for this Tuning Job. * diff --git a/AiPlatform/src/V1/SupervisedTuningDatasetDistribution.php b/AiPlatform/src/V1/SupervisedTuningDatasetDistribution.php index d23ca9c9f6f1..5cef116edb45 100644 --- a/AiPlatform/src/V1/SupervisedTuningDatasetDistribution.php +++ b/AiPlatform/src/V1/SupervisedTuningDatasetDistribution.php @@ -21,6 +21,12 @@ class SupervisedTuningDatasetDistribution extends \Google\Protobuf\Internal\Mess * Generated from protobuf field int64 sum = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $sum = 0; + /** + * Output only. Sum of a given population of values that are billable. + * + * Generated from protobuf field int64 billable_sum = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $billable_sum = 0; /** * Output only. The minimum of the population values. * @@ -72,6 +78,8 @@ class SupervisedTuningDatasetDistribution extends \Google\Protobuf\Internal\Mess * * @type int|string $sum * Output only. Sum of a given population of values. + * @type int|string $billable_sum + * Output only. Sum of a given population of values that are billable. * @type float $min * Output only. The minimum of the population values. * @type float $max @@ -119,6 +127,32 @@ public function setSum($var) return $this; } + /** + * Output only. Sum of a given population of values that are billable. + * + * Generated from protobuf field int64 billable_sum = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getBillableSum() + { + return $this->billable_sum; + } + + /** + * Output only. Sum of a given population of values that are billable. + * + * Generated from protobuf field int64 billable_sum = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setBillableSum($var) + { + GPBUtil::checkInt64($var); + $this->billable_sum = $var; + + return $this; + } + /** * Output only. The minimum of the population values. * diff --git a/AiPlatform/src/V1/TrialContext.php b/AiPlatform/src/V1/TrialContext.php index 24ef9182a4d0..d2f9bdba2f02 100644 --- a/AiPlatform/src/V1/TrialContext.php +++ b/AiPlatform/src/V1/TrialContext.php @@ -9,8 +9,6 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Next ID: 3 - * * Generated from protobuf message google.cloud.aiplatform.v1.TrialContext */ class TrialContext extends \Google\Protobuf\Internal\Message diff --git a/AiPlatform/src/V1/UpdateFeatureGroupRequest.php b/AiPlatform/src/V1/UpdateFeatureGroupRequest.php index f35043a6db47..667babdca060 100644 --- a/AiPlatform/src/V1/UpdateFeatureGroupRequest.php +++ b/AiPlatform/src/V1/UpdateFeatureGroupRequest.php @@ -34,6 +34,9 @@ class UpdateFeatureGroupRequest extends \Google\Protobuf\Internal\Message * fields. * Updatable fields: * * `labels` + * * `description` + * * `big_query` + * * `big_query.entity_id_columns` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; */ @@ -54,6 +57,9 @@ class UpdateFeatureGroupRequest extends \Google\Protobuf\Internal\Message * Updatable fields: * * * `labels` + * * `description` + * * `big_query` + * * `big_query.entity_id_columns` * * @return \Google\Cloud\AIPlatform\V1\UpdateFeatureGroupRequest * @@ -86,6 +92,9 @@ public static function build(\Google\Cloud\AIPlatform\V1\FeatureGroup $featureGr * fields. * Updatable fields: * * `labels` + * * `description` + * * `big_query` + * * `big_query.entity_id_columns` * } */ public function __construct($data = NULL) { @@ -143,6 +152,9 @@ public function setFeatureGroup($var) * fields. * Updatable fields: * * `labels` + * * `description` + * * `big_query` + * * `big_query.entity_id_columns` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @return \Google\Protobuf\FieldMask|null @@ -172,6 +184,9 @@ public function clearUpdateMask() * fields. * Updatable fields: * * `labels` + * * `description` + * * `big_query` + * * `big_query.entity_id_columns` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @param \Google\Protobuf\FieldMask $var diff --git a/AiPlatform/src/V1/UpdateFeatureOnlineStoreRequest.php b/AiPlatform/src/V1/UpdateFeatureOnlineStoreRequest.php index 5603df68aca6..16f08583ca7e 100644 --- a/AiPlatform/src/V1/UpdateFeatureOnlineStoreRequest.php +++ b/AiPlatform/src/V1/UpdateFeatureOnlineStoreRequest.php @@ -33,10 +33,11 @@ class UpdateFeatureOnlineStoreRequest extends \Google\Protobuf\Internal\Message * request will be overwritten. Set the update_mask to `*` to override all * fields. * Updatable fields: - * * `big_query_source` - * * `bigtable` * * `labels` - * * `sync_config` + * * `description` + * * `bigtable` + * * `bigtable.auto_scaling` + * * `bigtable.enable_multi_region_replica` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; */ @@ -56,10 +57,11 @@ class UpdateFeatureOnlineStoreRequest extends \Google\Protobuf\Internal\Message * * Updatable fields: * - * * `big_query_source` - * * `bigtable` * * `labels` - * * `sync_config` + * * `description` + * * `bigtable` + * * `bigtable.auto_scaling` + * * `bigtable.enable_multi_region_replica` * * @return \Google\Cloud\AIPlatform\V1\UpdateFeatureOnlineStoreRequest * @@ -91,10 +93,11 @@ public static function build(\Google\Cloud\AIPlatform\V1\FeatureOnlineStore $fea * request will be overwritten. Set the update_mask to `*` to override all * fields. * Updatable fields: - * * `big_query_source` - * * `bigtable` * * `labels` - * * `sync_config` + * * `description` + * * `bigtable` + * * `bigtable.auto_scaling` + * * `bigtable.enable_multi_region_replica` * } */ public function __construct($data = NULL) { @@ -151,10 +154,11 @@ public function setFeatureOnlineStore($var) * request will be overwritten. Set the update_mask to `*` to override all * fields. * Updatable fields: - * * `big_query_source` - * * `bigtable` * * `labels` - * * `sync_config` + * * `description` + * * `bigtable` + * * `bigtable.auto_scaling` + * * `bigtable.enable_multi_region_replica` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @return \Google\Protobuf\FieldMask|null @@ -183,10 +187,11 @@ public function clearUpdateMask() * request will be overwritten. Set the update_mask to `*` to override all * fields. * Updatable fields: - * * `big_query_source` - * * `bigtable` * * `labels` - * * `sync_config` + * * `description` + * * `bigtable` + * * `bigtable.auto_scaling` + * * `bigtable.enable_multi_region_replica` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @param \Google\Protobuf\FieldMask $var diff --git a/AiPlatform/src/V1/UpdateFeatureRequest.php b/AiPlatform/src/V1/UpdateFeatureRequest.php index 6a4fd909e868..32f735ef0f99 100644 --- a/AiPlatform/src/V1/UpdateFeatureRequest.php +++ b/AiPlatform/src/V1/UpdateFeatureRequest.php @@ -39,7 +39,8 @@ class UpdateFeatureRequest extends \Google\Protobuf\Internal\Message * Updatable fields: * * `description` * * `labels` - * * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * * `disable_monitoring` (Not supported for FeatureRegistryService Feature) + * * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; */ @@ -63,7 +64,8 @@ class UpdateFeatureRequest extends \Google\Protobuf\Internal\Message * * * `description` * * `labels` - * * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * * `disable_monitoring` (Not supported for FeatureRegistryService Feature) + * * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) * * @return \Google\Cloud\AIPlatform\V1\UpdateFeatureRequest * @@ -99,7 +101,8 @@ public static function build(\Google\Cloud\AIPlatform\V1\Feature $feature, \Goog * Updatable fields: * * `description` * * `labels` - * * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * * `disable_monitoring` (Not supported for FeatureRegistryService Feature) + * * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) * } */ public function __construct($data = NULL) { @@ -162,7 +165,8 @@ public function setFeature($var) * Updatable fields: * * `description` * * `labels` - * * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * * `disable_monitoring` (Not supported for FeatureRegistryService Feature) + * * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @return \Google\Protobuf\FieldMask|null @@ -193,7 +197,8 @@ public function clearUpdateMask() * Updatable fields: * * `description` * * `labels` - * * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * * `disable_monitoring` (Not supported for FeatureRegistryService Feature) + * * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @param \Google\Protobuf\FieldMask $var diff --git a/AiPlatform/src/V1/UpdateFeatureViewRequest.php b/AiPlatform/src/V1/UpdateFeatureViewRequest.php index b23313f79682..60352c3e3a16 100644 --- a/AiPlatform/src/V1/UpdateFeatureViewRequest.php +++ b/AiPlatform/src/V1/UpdateFeatureViewRequest.php @@ -34,7 +34,14 @@ class UpdateFeatureViewRequest extends \Google\Protobuf\Internal\Message * fields. * Updatable fields: * * `labels` - * * `serviceAgentType` + * * `service_agent_type` + * * `big_query_source` + * * `big_query_source.uri` + * * `big_query_source.entity_id_columns` + * * `feature_registry_source` + * * `feature_registry_source.feature_groups` + * * `sync_config` + * * `sync_config.cron` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; */ @@ -55,7 +62,14 @@ class UpdateFeatureViewRequest extends \Google\Protobuf\Internal\Message * Updatable fields: * * * `labels` - * * `serviceAgentType` + * * `service_agent_type` + * * `big_query_source` + * * `big_query_source.uri` + * * `big_query_source.entity_id_columns` + * * `feature_registry_source` + * * `feature_registry_source.feature_groups` + * * `sync_config` + * * `sync_config.cron` * * @return \Google\Cloud\AIPlatform\V1\UpdateFeatureViewRequest * @@ -88,7 +102,14 @@ public static function build(\Google\Cloud\AIPlatform\V1\FeatureView $featureVie * fields. * Updatable fields: * * `labels` - * * `serviceAgentType` + * * `service_agent_type` + * * `big_query_source` + * * `big_query_source.uri` + * * `big_query_source.entity_id_columns` + * * `feature_registry_source` + * * `feature_registry_source.feature_groups` + * * `sync_config` + * * `sync_config.cron` * } */ public function __construct($data = NULL) { @@ -146,7 +167,14 @@ public function setFeatureView($var) * fields. * Updatable fields: * * `labels` - * * `serviceAgentType` + * * `service_agent_type` + * * `big_query_source` + * * `big_query_source.uri` + * * `big_query_source.entity_id_columns` + * * `feature_registry_source` + * * `feature_registry_source.feature_groups` + * * `sync_config` + * * `sync_config.cron` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @return \Google\Protobuf\FieldMask|null @@ -176,7 +204,14 @@ public function clearUpdateMask() * fields. * Updatable fields: * * `labels` - * * `serviceAgentType` + * * `service_agent_type` + * * `big_query_source` + * * `big_query_source.uri` + * * `big_query_source.entity_id_columns` + * * `feature_registry_source` + * * `feature_registry_source.feature_groups` + * * `sync_config` + * * `sync_config.cron` * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; * @param \Google\Protobuf\FieldMask $var diff --git a/AiPlatform/src/V1/gapic_metadata.json b/AiPlatform/src/V1/gapic_metadata.json index 82de93ba951a..2a666c6f8252 100644 --- a/AiPlatform/src/V1/gapic_metadata.json +++ b/AiPlatform/src/V1/gapic_metadata.json @@ -1691,11 +1691,21 @@ "assignNotebookRuntime" ] }, + "CreateNotebookExecutionJob": { + "methods": [ + "createNotebookExecutionJob" + ] + }, "CreateNotebookRuntimeTemplate": { "methods": [ "createNotebookRuntimeTemplate" ] }, + "DeleteNotebookExecutionJob": { + "methods": [ + "deleteNotebookExecutionJob" + ] + }, "DeleteNotebookRuntime": { "methods": [ "deleteNotebookRuntime" @@ -1706,6 +1716,11 @@ "deleteNotebookRuntimeTemplate" ] }, + "GetNotebookExecutionJob": { + "methods": [ + "getNotebookExecutionJob" + ] + }, "GetNotebookRuntime": { "methods": [ "getNotebookRuntime" @@ -1716,6 +1731,11 @@ "getNotebookRuntimeTemplate" ] }, + "ListNotebookExecutionJobs": { + "methods": [ + "listNotebookExecutionJobs" + ] + }, "ListNotebookRuntimeTemplates": { "methods": [ "listNotebookRuntimeTemplates" diff --git a/AiPlatform/src/V1/resources/notebook_service_client_config.json b/AiPlatform/src/V1/resources/notebook_service_client_config.json index a902448d9065..ce76a76e2cec 100644 --- a/AiPlatform/src/V1/resources/notebook_service_client_config.json +++ b/AiPlatform/src/V1/resources/notebook_service_client_config.json @@ -21,11 +21,21 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "CreateNotebookExecutionJob": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "CreateNotebookRuntimeTemplate": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "DeleteNotebookExecutionJob": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "DeleteNotebookRuntime": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", @@ -36,6 +46,11 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "GetNotebookExecutionJob": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "GetNotebookRuntime": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", @@ -46,6 +61,11 @@ "retry_codes_name": "no_retry_codes", "retry_params_name": "no_retry_params" }, + "ListNotebookExecutionJobs": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "ListNotebookRuntimeTemplates": { "timeout_millis": 60000, "retry_codes_name": "no_retry_codes", diff --git a/AiPlatform/src/V1/resources/notebook_service_descriptor_config.php b/AiPlatform/src/V1/resources/notebook_service_descriptor_config.php index 005d0f0e10a8..9290937a300a 100644 --- a/AiPlatform/src/V1/resources/notebook_service_descriptor_config.php +++ b/AiPlatform/src/V1/resources/notebook_service_descriptor_config.php @@ -42,6 +42,25 @@ ], ], ], + 'CreateNotebookExecutionJob' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\AIPlatform\V1\NotebookExecutionJob', + 'metadataReturnType' => '\Google\Cloud\AIPlatform\V1\CreateNotebookExecutionJobOperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'CreateNotebookRuntimeTemplate' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate', @@ -61,6 +80,25 @@ ], ], ], + 'DeleteNotebookExecutionJob' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Protobuf\GPBEmpty', + 'metadataReturnType' => '\Google\Cloud\AIPlatform\V1\DeleteOperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'DeleteNotebookRuntime' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Protobuf\GPBEmpty', @@ -137,6 +175,18 @@ ], ], ], + 'GetNotebookExecutionJob' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\AIPlatform\V1\NotebookExecutionJob', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'GetNotebookRuntime' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\AIPlatform\V1\NotebookRuntime', @@ -161,6 +211,26 @@ ], ], ], + 'ListNotebookExecutionJobs' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getNotebookExecutionJobs', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\AIPlatform\V1\ListNotebookExecutionJobsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'ListNotebookRuntimeTemplates' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', @@ -290,8 +360,10 @@ 'templateMap' => [ 'location' => 'projects/{project}/locations/{location}', 'network' => 'projects/{project}/global/networks/{network}', + 'notebookExecutionJob' => 'projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}', 'notebookRuntime' => 'projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}', 'notebookRuntimeTemplate' => 'projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}', + 'schedule' => 'projects/{project}/locations/{location}/schedules/{schedule}', 'subnetwork' => 'projects/{project}/regions/{region}/subnetworks/{subnetwork}', ], ], diff --git a/AiPlatform/src/V1/resources/notebook_service_rest_client_config.php b/AiPlatform/src/V1/resources/notebook_service_rest_client_config.php index af247963b8e8..2adc84dcd34b 100644 --- a/AiPlatform/src/V1/resources/notebook_service_rest_client_config.php +++ b/AiPlatform/src/V1/resources/notebook_service_rest_client_config.php @@ -35,6 +35,18 @@ ], ], ], + 'CreateNotebookExecutionJob' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/notebookExecutionJobs', + 'body' => 'notebook_execution_job', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'CreateNotebookRuntimeTemplate' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/notebookRuntimeTemplates', @@ -47,6 +59,17 @@ ], ], ], + 'DeleteNotebookExecutionJob' => [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/notebookExecutionJobs/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'DeleteNotebookRuntime' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/notebookRuntimes/*}', @@ -69,6 +92,17 @@ ], ], ], + 'GetNotebookExecutionJob' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/notebookExecutionJobs/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'GetNotebookRuntime' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/notebookRuntimes/*}', @@ -91,6 +125,17 @@ ], ], ], + 'ListNotebookExecutionJobs' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/notebookExecutionJobs', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'ListNotebookRuntimeTemplates' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/notebookRuntimeTemplates', diff --git a/AiPlatform/tests/Unit/V1/Client/EndpointServiceClientTest.php b/AiPlatform/tests/Unit/V1/Client/EndpointServiceClientTest.php index b523ec2af791..bd09cb515175 100644 --- a/AiPlatform/tests/Unit/V1/Client/EndpointServiceClientTest.php +++ b/AiPlatform/tests/Unit/V1/Client/EndpointServiceClientTest.php @@ -117,6 +117,10 @@ public function createEndpointTest() $network = 'network1843485230'; $enablePrivateServiceConnect = true; $modelDeploymentMonitoringJob = 'modelDeploymentMonitoringJob1797127786'; + $dedicatedEndpointEnabled = false; + $dedicatedEndpointDns = 'dedicatedEndpointDns598984655'; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new Endpoint(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -125,6 +129,10 @@ public function createEndpointTest() $expectedResponse->setNetwork($network); $expectedResponse->setEnablePrivateServiceConnect($enablePrivateServiceConnect); $expectedResponse->setModelDeploymentMonitoringJob($modelDeploymentMonitoringJob); + $expectedResponse->setDedicatedEndpointEnabled($dedicatedEndpointEnabled); + $expectedResponse->setDedicatedEndpointDns($dedicatedEndpointDns); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); @@ -501,6 +509,10 @@ public function getEndpointTest() $network = 'network1843485230'; $enablePrivateServiceConnect = true; $modelDeploymentMonitoringJob = 'modelDeploymentMonitoringJob1797127786'; + $dedicatedEndpointEnabled = false; + $dedicatedEndpointDns = 'dedicatedEndpointDns598984655'; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new Endpoint(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); @@ -509,6 +521,10 @@ public function getEndpointTest() $expectedResponse->setNetwork($network); $expectedResponse->setEnablePrivateServiceConnect($enablePrivateServiceConnect); $expectedResponse->setModelDeploymentMonitoringJob($modelDeploymentMonitoringJob); + $expectedResponse->setDedicatedEndpointEnabled($dedicatedEndpointEnabled); + $expectedResponse->setDedicatedEndpointDns($dedicatedEndpointDns); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]'); @@ -915,6 +931,10 @@ public function updateEndpointTest() $network = 'network1843485230'; $enablePrivateServiceConnect = true; $modelDeploymentMonitoringJob = 'modelDeploymentMonitoringJob1797127786'; + $dedicatedEndpointEnabled = false; + $dedicatedEndpointDns = 'dedicatedEndpointDns598984655'; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new Endpoint(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -923,6 +943,10 @@ public function updateEndpointTest() $expectedResponse->setNetwork($network); $expectedResponse->setEnablePrivateServiceConnect($enablePrivateServiceConnect); $expectedResponse->setModelDeploymentMonitoringJob($modelDeploymentMonitoringJob); + $expectedResponse->setDedicatedEndpointEnabled($dedicatedEndpointEnabled); + $expectedResponse->setDedicatedEndpointDns($dedicatedEndpointDns); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $endpoint = new Endpoint(); @@ -1345,6 +1369,10 @@ public function createEndpointAsyncTest() $network = 'network1843485230'; $enablePrivateServiceConnect = true; $modelDeploymentMonitoringJob = 'modelDeploymentMonitoringJob1797127786'; + $dedicatedEndpointEnabled = false; + $dedicatedEndpointDns = 'dedicatedEndpointDns598984655'; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new Endpoint(); $expectedResponse->setName($name); $expectedResponse->setDisplayName($displayName); @@ -1353,6 +1381,10 @@ public function createEndpointAsyncTest() $expectedResponse->setNetwork($network); $expectedResponse->setEnablePrivateServiceConnect($enablePrivateServiceConnect); $expectedResponse->setModelDeploymentMonitoringJob($modelDeploymentMonitoringJob); + $expectedResponse->setDedicatedEndpointEnabled($dedicatedEndpointEnabled); + $expectedResponse->setDedicatedEndpointDns($dedicatedEndpointDns); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $anyResponse = new Any(); $anyResponse->setValue($expectedResponse->serializeToString()); $completeOperation = new Operation(); diff --git a/AiPlatform/tests/Unit/V1/Client/LlmUtilityServiceClientTest.php b/AiPlatform/tests/Unit/V1/Client/LlmUtilityServiceClientTest.php index cf681f6b4f39..ef3e0e54c2f8 100644 --- a/AiPlatform/tests/Unit/V1/Client/LlmUtilityServiceClientTest.php +++ b/AiPlatform/tests/Unit/V1/Client/LlmUtilityServiceClientTest.php @@ -153,14 +153,7 @@ public function countTokensTest() $transport->addResponse($expectedResponse); // Mock request $formattedEndpoint = $gapicClient->endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]'); - $model = 'model104069929'; - $instances = []; - $contents = []; - $request = (new CountTokensRequest()) - ->setEndpoint($formattedEndpoint) - ->setModel($model) - ->setInstances($instances) - ->setContents($contents); + $request = (new CountTokensRequest())->setEndpoint($formattedEndpoint); $response = $gapicClient->countTokens($request); $this->assertEquals($expectedResponse, $response); $actualRequests = $transport->popReceivedCalls(); @@ -170,12 +163,6 @@ public function countTokensTest() $this->assertSame('/google.cloud.aiplatform.v1.LlmUtilityService/CountTokens', $actualFuncCall); $actualValue = $actualRequestObject->getEndpoint(); $this->assertProtobufEquals($formattedEndpoint, $actualValue); - $actualValue = $actualRequestObject->getModel(); - $this->assertProtobufEquals($model, $actualValue); - $actualValue = $actualRequestObject->getInstances(); - $this->assertProtobufEquals($instances, $actualValue); - $actualValue = $actualRequestObject->getContents(); - $this->assertProtobufEquals($contents, $actualValue); $this->assertTrue($transport->isExhausted()); } @@ -202,14 +189,7 @@ public function countTokensExceptionTest() $transport->addResponse(null, $status); // Mock request $formattedEndpoint = $gapicClient->endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]'); - $model = 'model104069929'; - $instances = []; - $contents = []; - $request = (new CountTokensRequest()) - ->setEndpoint($formattedEndpoint) - ->setModel($model) - ->setInstances($instances) - ->setContents($contents); + $request = (new CountTokensRequest())->setEndpoint($formattedEndpoint); try { $gapicClient->countTokens($request); // If the $gapicClient method call did not throw, fail the test diff --git a/AiPlatform/tests/Unit/V1/Client/NotebookServiceClientTest.php b/AiPlatform/tests/Unit/V1/Client/NotebookServiceClientTest.php index 53be8286861d..0c4137816805 100644 --- a/AiPlatform/tests/Unit/V1/Client/NotebookServiceClientTest.php +++ b/AiPlatform/tests/Unit/V1/Client/NotebookServiceClientTest.php @@ -28,15 +28,21 @@ use Google\ApiCore\Testing\MockTransport; use Google\Cloud\AIPlatform\V1\AssignNotebookRuntimeRequest; use Google\Cloud\AIPlatform\V1\Client\NotebookServiceClient; +use Google\Cloud\AIPlatform\V1\CreateNotebookExecutionJobRequest; use Google\Cloud\AIPlatform\V1\CreateNotebookRuntimeTemplateRequest; +use Google\Cloud\AIPlatform\V1\DeleteNotebookExecutionJobRequest; use Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeRequest; use Google\Cloud\AIPlatform\V1\DeleteNotebookRuntimeTemplateRequest; +use Google\Cloud\AIPlatform\V1\GetNotebookExecutionJobRequest; use Google\Cloud\AIPlatform\V1\GetNotebookRuntimeRequest; use Google\Cloud\AIPlatform\V1\GetNotebookRuntimeTemplateRequest; +use Google\Cloud\AIPlatform\V1\ListNotebookExecutionJobsRequest; +use Google\Cloud\AIPlatform\V1\ListNotebookExecutionJobsResponse; use Google\Cloud\AIPlatform\V1\ListNotebookRuntimeTemplatesRequest; use Google\Cloud\AIPlatform\V1\ListNotebookRuntimeTemplatesResponse; use Google\Cloud\AIPlatform\V1\ListNotebookRuntimesRequest; use Google\Cloud\AIPlatform\V1\ListNotebookRuntimesResponse; +use Google\Cloud\AIPlatform\V1\NotebookExecutionJob; use Google\Cloud\AIPlatform\V1\NotebookRuntime; use Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplate; use Google\Cloud\AIPlatform\V1\StartNotebookRuntimeRequest; @@ -264,6 +270,148 @@ public function assignNotebookRuntimeExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function createNotebookExecutionJobTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createNotebookExecutionJobTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $notebookRuntimeTemplateResourceName = 'notebookRuntimeTemplateResourceName-798820286'; + $gcsOutputUri = 'gcsOutputUri-2035620010'; + $executionUser = 'executionUser-1470379886'; + $name = 'name3373707'; + $displayName = 'displayName1615086568'; + $scheduleResourceName = 'scheduleResourceName-627484556'; + $expectedResponse = new NotebookExecutionJob(); + $expectedResponse->setNotebookRuntimeTemplateResourceName($notebookRuntimeTemplateResourceName); + $expectedResponse->setGcsOutputUri($gcsOutputUri); + $expectedResponse->setExecutionUser($executionUser); + $expectedResponse->setName($name); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setScheduleResourceName($scheduleResourceName); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createNotebookExecutionJobTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $notebookExecutionJob = new NotebookExecutionJob(); + $request = (new CreateNotebookExecutionJobRequest()) + ->setParent($formattedParent) + ->setNotebookExecutionJob($notebookExecutionJob); + $response = $gapicClient->createNotebookExecutionJob($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.aiplatform.v1.NotebookService/CreateNotebookExecutionJob', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getNotebookExecutionJob(); + $this->assertProtobufEquals($notebookExecutionJob, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createNotebookExecutionJobTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createNotebookExecutionJobExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createNotebookExecutionJobTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $notebookExecutionJob = new NotebookExecutionJob(); + $request = (new CreateNotebookExecutionJobRequest()) + ->setParent($formattedParent) + ->setNotebookExecutionJob($notebookExecutionJob); + $response = $gapicClient->createNotebookExecutionJob($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createNotebookExecutionJobTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function createNotebookRuntimeTemplateTest() { @@ -413,6 +561,128 @@ public function createNotebookRuntimeTemplateExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function deleteNotebookExecutionJobTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteNotebookExecutionJobTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $expectedResponse = new GPBEmpty(); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/deleteNotebookExecutionJobTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedName = $gapicClient->notebookExecutionJobName('[PROJECT]', '[LOCATION]', '[NOTEBOOK_EXECUTION_JOB]'); + $request = (new DeleteNotebookExecutionJobRequest())->setName($formattedName); + $response = $gapicClient->deleteNotebookExecutionJob($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.aiplatform.v1.NotebookService/DeleteNotebookExecutionJob', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteNotebookExecutionJobTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function deleteNotebookExecutionJobExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/deleteNotebookExecutionJobTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->notebookExecutionJobName('[PROJECT]', '[LOCATION]', '[NOTEBOOK_EXECUTION_JOB]'); + $request = (new DeleteNotebookExecutionJobRequest())->setName($formattedName); + $response = $gapicClient->deleteNotebookExecutionJob($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/deleteNotebookExecutionJobTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function deleteNotebookRuntimeTest() { @@ -668,6 +938,81 @@ public function deleteNotebookRuntimeTemplateExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function getNotebookExecutionJobTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $notebookRuntimeTemplateResourceName = 'notebookRuntimeTemplateResourceName-798820286'; + $gcsOutputUri = 'gcsOutputUri-2035620010'; + $executionUser = 'executionUser-1470379886'; + $name2 = 'name2-1052831874'; + $displayName = 'displayName1615086568'; + $scheduleResourceName = 'scheduleResourceName-627484556'; + $expectedResponse = new NotebookExecutionJob(); + $expectedResponse->setNotebookRuntimeTemplateResourceName($notebookRuntimeTemplateResourceName); + $expectedResponse->setGcsOutputUri($gcsOutputUri); + $expectedResponse->setExecutionUser($executionUser); + $expectedResponse->setName($name2); + $expectedResponse->setDisplayName($displayName); + $expectedResponse->setScheduleResourceName($scheduleResourceName); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->notebookExecutionJobName('[PROJECT]', '[LOCATION]', '[NOTEBOOK_EXECUTION_JOB]'); + $request = (new GetNotebookExecutionJobRequest())->setName($formattedName); + $response = $gapicClient->getNotebookExecutionJob($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.aiplatform.v1.NotebookService/GetNotebookExecutionJob', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getNotebookExecutionJobExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->notebookExecutionJobName('[PROJECT]', '[LOCATION]', '[NOTEBOOK_EXECUTION_JOB]'); + $request = (new GetNotebookExecutionJobRequest())->setName($formattedName); + try { + $gapicClient->getNotebookExecutionJob($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function getNotebookRuntimeTest() { @@ -834,6 +1179,77 @@ public function getNotebookRuntimeTemplateExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function listNotebookExecutionJobsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $notebookExecutionJobsElement = new NotebookExecutionJob(); + $notebookExecutionJobs = [$notebookExecutionJobsElement]; + $expectedResponse = new ListNotebookExecutionJobsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setNotebookExecutionJobs($notebookExecutionJobs); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListNotebookExecutionJobsRequest())->setParent($formattedParent); + $response = $gapicClient->listNotebookExecutionJobs($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getNotebookExecutionJobs()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.aiplatform.v1.NotebookService/ListNotebookExecutionJobs', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listNotebookExecutionJobsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListNotebookExecutionJobsRequest())->setParent($formattedParent); + try { + $gapicClient->listNotebookExecutionJobs($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function listNotebookRuntimeTemplatesTest() {