feat: add enable_dashboard_access in aiplatform v1 and v1beta1 (#460)

* feat: add NVIDIA_A100_80GB to AcceleratorType in aiplatform v1beta1 accelerator_type.proto feat: add annotation_labels to ImportDataConfig in aiplatform v1beta1 dataset.proto feat: add total_deployed_model_count and total_endpoint_count to QueryDeployedModelsResponse in aiplatform v1beta1 deployment_resource_pool_service.proto feat: add start_time to BatchReadFeatureValuesRequest in aiplatform v1beta1 featurestore_service.proto feat: add metadata_artifact to Model in aiplatform v1beta1 model.proto feat: add failed_main_jobs and failed_pre_caching_check_jobs to ContainerDetail in aiplatform v1beta1 pipeline_job.proto feat: add persist_ml_use_assignment to InputDataConfig in aiplatform v1beta1 training_pipeline.proto PiperOrigin-RevId: 485963130 Source-Link: googleapis/googleapis@af14709 Source-Link: googleapis/googleapis-gen@3d9d484 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiM2Q5ZDQ4NGEwMTA0ZTBjY2M0MzY3NzY5Yjc5MzA1YzJjYjZmYzNkOCJ9 * feat: add annotation_labels to ImportDataConfig in aiplatform v1 dataset.proto feat: add start_time to BatchReadFeatureValuesRequest in aiplatform v1 featurestore_service.proto feat: add metadata_artifact to Model in aiplatform v1 model.proto feat: add failed_main_jobs and failed_pre_caching_check_jobs to ContainerDetail in aiplatform v1 pipeline_job.proto feat: add persist_ml_use_assignment to InputDataConfig in aiplatform v1 training_pipeline.proto PiperOrigin-RevId: 485963171 Source-Link: googleapis/googleapis@9691f51 Source-Link: googleapis/googleapis-gen@8571031 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODU3MTAzMTZmMzI5ZGZjNzNmMjQ0NjEwZWIwMTk5MjRlNDU4MGE1NiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add instance_config to batch_prediction_job in aiplatform v1beta1 batch_prediction_job.proto PiperOrigin-RevId: 487284583 Source-Link: googleapis/googleapis@17fb30e Source-Link: googleapis/googleapis-gen@464638f Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDY0NjM4ZmIxNDNmZGI2NzI0MjdkZjNiOTkyZmZkNjBjODBmMzJmMiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add service_account to batch_prediction_job in aiplatform v1 batch_prediction_job.proto PiperOrigin-RevId: 488416174 Source-Link: googleapis/googleapis@b4dea4a Source-Link: googleapis/googleapis-gen@6a98691 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNmE5ODY5MTA4NTM1OTU2ZjRjMTY2Njc1MDUzMmNjNTc4ZDM4NDRkYiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add metadata_artifact to Dataset in aiplatform v1 dataset.proto feat: add WriteFeatureValues rpc to FeaturestoreOnlineServingService in aiplatform v1 featurestore_online_service.proto PiperOrigin-RevId: 491933995 Source-Link: googleapis/googleapis@693430f Source-Link: googleapis/googleapis-gen@0bf52e5 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGJmNTJlNTE3MmQ4ODFkNWY3MTM5MjE4YTM3M2EzOGVjN2RkNTFhMCJ9 * feat: add metadata_artifact to Dataset in aiplatform v1beta1 dataset.proto feat: add offline_storage_ttl_days to EntityType in aiplatform v1beta1 entity_type.proto feat: add online_storage_ttl_days to Featurestore in aiplatform v1beta1 featurestore.proto feat: add source_uris to ImportFeatureValuesOperationMetadata in aiplatform v1beta1 featurestore_service.proto PiperOrigin-RevId: 491934619 Source-Link: googleapis/googleapis@572774c Source-Link: googleapis/googleapis-gen@129d372 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTI5ZDM3MjQ0YWRlZTE1ZWYxMzYwOWE0MmE2NGUzN2ZjODAwNWNjZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add SearchDataItems RPC in aiplatform version v1 and v1beta1 dataset_service.proto PiperOrigin-RevId: 493139921 Source-Link: googleapis/googleapis@268ee4d Source-Link: googleapis/googleapis-gen@f4b4248 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZjRiNDI0ODMxMzU0YzViNTZhMmE0YjFmZWZkMGY2YjRkNmM2NDYwZSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add service_account to UploadModelRequest in aiplatform v1 model_service.proto PiperOrigin-RevId: 493943349 Source-Link: googleapis/googleapis@9df3838 Source-Link: googleapis/googleapis-gen@7345a78 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNzM0NWE3OGFkMzNiNDQ5ZjQ1ZDdkNjc2ZmYwYWY5MzQxMWNlYWU5NCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add service_account to UploadModelRequest in aiplatform v1beta1 model_service.proto PiperOrigin-RevId: 493951002 Source-Link: googleapis/googleapis@aee01fa Source-Link: googleapis/googleapis-gen@d731f74 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDczMWY3NDM0MDliYTIxMjYxNDQyMjI0ZWVjODE3YjIyYzBlYzkyMiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add saved_queries to Dataset in aiplatform v1beta1 dataset.proto feat: add order_by to ListModelVersionRequest in aiplatform v1beta1 model_service.proto feat: add update_all_stopped_trials to ConvexAutomatedStoppingSpec in aiplatform v1beta1 study.proto feat: add ReadTensorboardUsage rpc in aiplatform v1beta1 tensorboard_service.proto PiperOrigin-RevId: 500741013 Source-Link: googleapis/googleapis@e8675f0 Source-Link: googleapis/googleapis-gen@0c99ee7 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGM5OWVlNzNiZTM3NzExOGQwZGU1ZmYxNjIxNjM2ZDlmMmVhNDZhMSJ9 * feat: add saved_queries to Dataset in aiplatform v1 dataset.proto feat: add order_by to ListModelVersionRequest in aiplatform v1 model_service.proto feat: add update_all_stopped_trials to ConvexAutomatedStoppingSpec in aiplatform v1 study.proto feat: add ReadTensorboardUsage rpc in aiplatform v1 tensorboard_service.proto PiperOrigin-RevId: 500741387 Source-Link: googleapis/googleapis@2293b99 Source-Link: googleapis/googleapis-gen@21abc86 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjFhYmM4NmEyZmE0ZmZiYzJkOTY5ZjQ4ZWE3ZmMwN2Y2ZDhkMDNkMCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add instance_config to BatchPredictionJob in aiplatform v1 batch_prediction_job.proto PiperOrigin-RevId: 500777760 Source-Link: googleapis/googleapis@517c248 Source-Link: googleapis/googleapis-gen@b722d01 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjcyMmQwMTU4MWE3ZGM0Yzc4MDUwNjI2OWYxMTMzNGVjNDUwYjFlZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add enable_dashboard_access in aiplatform v1 and v1beta1 custom_job.proto PiperOrigin-RevId: 502722710 Source-Link: googleapis/googleapis@6d9a0f3 Source-Link: googleapis/googleapis-gen@845ecc6 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODQ1ZWNjNjA0N2FkZmQxNmRlZTk1NmI4NWNhYjdkYmQ1NjlmODM1MiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * add quickstart * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Sofia Leon <sofialeon@google.com>
googleapis · Jan 25, 2023 · 58d9da5 · 58d9da5
1 parent 617822a
commit 58d9da5
Show file tree

Hide file tree

Showing 614 changed files with 71,715 additions and 6,294 deletions.
diff --git a/packages/google-cloud-aiplatform/.jsdoc.js b/packages/google-cloud-aiplatform/.jsdoc.js
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ module.exports = {
     includePattern: '\\.js$'
   },
   templates: {
-    copyright: 'Copyright 2022 Google LLC',
+    copyright: 'Copyright 2023 Google LLC',
     includeDate: false,
     sourceFiles: false,
     systemName: '@google-cloud/aiplatform',

diff --git a/packages/google-cloud-aiplatform/README.md b/packages/google-cloud-aiplatform/README.md
@@ -34,8 +34,8 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 * [Quickstart](#quickstart)
   * [Before you begin](#before-you-begin)
   * [Installing the client library](#installing-the-client-library)
-
-
+  * [Using the client library](#using-the-client-library)
+* [Samples](#samples)
 * [Versioning](#versioning)
 * [Contributing](#contributing)
 * [License](#license)
@@ -57,6 +57,55 @@ npm install @google-cloud/aiplatform
 ```
 
 
+### Using the client library
+
+```javascript
+/**
+ * TODO(developer): Uncomment these variables before running the sample.
+ */
+// const projectId = 'YOUR_PROJECT_ID';
+// const location = 'YOUR_PROJECT_LOCATION';
+
+const {EndpointServiceClient} = require('@google-cloud/aiplatform');
+
+// Specifies the location of the api endpoint
+const clientOptions = {
+  apiEndpoint: 'us-central1-aiplatform.googleapis.com',
+};
+const client = new EndpointServiceClient(clientOptions);
+
+async function listEndpoints() {
+  // Configure the parent resource
+  const parent = `projects/${projectId}/locations/${location}`;
+  const request = {
+    parent,
+  };
+
+  // Get and print out a list of all the endpoints for this resource
+  const [result] = await client.listEndpoints(request);
+  for (const endpoint of result) {
+    console.log(`\nEndpoint name: ${endpoint.name}`);
+    console.log(`Display name: ${endpoint.displayName}`);
+    if (endpoint.deployedModels[0]) {
+      console.log(
+        `First deployed model: ${endpoint.deployedModels[0].model}`
+      );
+    }
+  }
+}
+listEndpoints();
+
+```
+
+
+
+## Samples
+
+Samples are in the [`samples/`](https://github.com/googleapis/nodejs-ai-platform/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.
+
+| Sample                      | Source Code                       | Try it |
+| --------------------------- | --------------------------------- | ------ |
+| Quickstart | [source code](https://github.com/googleapis/nodejs-ai-platform/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-ai-platform&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
 
 
 

diff --git a/packages/google-cloud-aiplatform/package.json b/packages/google-cloud-aiplatform/package.json
@@ -43,6 +43,7 @@
     "prelint": "cd samples; npm link ../; npm i",
     "prepare": "npm run compile-protos && npm run compile",
     "system-test": "c8 mocha build/system-test",
+    "samples-test": "cd samples/ && npm link ../ && npm test",
     "test": "c8 node build/test/run.js"
   },
   "dependencies": {

diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto
@@ -41,8 +41,9 @@ message Annotation {
   // Output only. Resource name of the Annotation.
   string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1.Annotation.payload]. The
-  // schema is defined as an [OpenAPI 3.0.2 Schema
+  // Required. Google Cloud Storage URI points to a YAML file describing
+  // [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is
+  // defined as an [OpenAPI 3.0.2 Schema
   // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
   // The schema files that can be used here are found in
   // gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
@@ -55,19 +56,23 @@ message Annotation {
   google.protobuf.Value payload = 3 [(google.api.field_behavior) = REQUIRED];
 
   // Output only. Timestamp when this Annotation was created.
-  google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. Timestamp when this Annotation was last updated.
-  google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp update_time = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
-  // "overwrite" update happens.
+  // Optional. Used to perform consistent read-modify-write updates. If not set,
+  // a blind "overwrite" update happens.
   string etag = 8 [(google.api.field_behavior) = OPTIONAL];
 
   // Output only. The source of the Annotation.
-  UserActionReference annotation_source = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+  UserActionReference annotation_source = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Optional. The labels with user-defined metadata to organize your Annotations.
+  // Optional. The labels with user-defined metadata to organize your
+  // Annotations.
   //
   // Label keys and values can be no longer than 64 characters
   // (Unicode codepoints), can only contain lowercase letters, numeric
@@ -84,7 +89,8 @@ message Annotation {
   //   If not set, the Annotation is not visible in the UI.
   //
   // * "aiplatform.googleapis.com/payload_schema":
-  //   output only, its value is the [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
+  //   output only, its value is the
+  //   [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri]
   //   title.
   map<string, string> labels = 6 [(google.api.field_behavior) = OPTIONAL];
 }
diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto
@@ -39,17 +39,19 @@ message AnnotationSpec {
   string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Required. The user-defined name of the AnnotationSpec.
-  // The name can be up to 128 characters long and can be consist of any UTF-8
+  // The name can be up to 128 characters long and can consist of any UTF-8
   // characters.
   string display_name = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Output only. Timestamp when this AnnotationSpec was created.
-  google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. Timestamp when AnnotationSpec was last updated.
-  google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp update_time = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
-  // "overwrite" update happens.
+  // Optional. Used to perform consistent read-modify-write updates. If not set,
+  // a blind "overwrite" update happens.
   string etag = 5 [(google.api.field_behavior) = OPTIONAL];
 }
diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/artifact.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/artifact.proto
@@ -75,10 +75,12 @@ message Artifact {
   map<string, string> labels = 10;
 
   // Output only. Timestamp when this Artifact was created.
-  google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 11
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. Timestamp when this Artifact was last updated.
-  google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp update_time = 12
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // The state of this Artifact. This is a property of the Artifact, and does
   // not imply or capture any ongoing process. This property is managed by
@@ -101,6 +103,7 @@ message Artifact {
   string schema_version = 15;
 
   // Properties of the Artifact.
+  // Top level metadata keys' heading and trailing spaces will be trimmed.
   // The size of this field should not exceed 200KB.
   google.protobuf.Struct metadata = 16;