Merge branch 'main' into release-please--branches--main

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto

@@ -278,6 +278,11 @@ message BatchPredictionJob {
   //              or
   //            `projects/{project}/locations/{location}/models/{model}@golden`
   // if no version is specified, the default version will be deployed.
+  //
+  // The model resource could also be a publisher model.
+  //  Example: `publishers/{publisher}/models/{model}`
+  //              or
+  //           `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
   string model = 3 [(google.api.resource_reference) = {
     type: "aiplatform.googleapis.com/Model"
   }];

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto

@@ -59,6 +59,10 @@ message Dataset {
   // Required. Additional information about the Dataset.
   google.protobuf.Value metadata = 8 [(google.api.field_behavior) = REQUIRED];
 
+  // Output only. The number of DataItems in this Dataset. Only apply for
+  // non-structured Dataset.
+  int64 data_item_count = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Output only. Timestamp when this Dataset was created.
   google.protobuf.Timestamp create_time = 4
       [(google.api.field_behavior) = OUTPUT_ONLY];

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto

@@ -38,8 +38,7 @@ option java_package = "com.google.cloud.aiplatform.v1";
 option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
 option ruby_package = "Google::Cloud::AIPlatform::V1";
 
-// The service that handles the CRUD of Vertex AI Dataset and its child
-// resources.
+// The service that manages Vertex AI Dataset and its child resources.
 service DatasetService {
   option (google.api.default_host) = "aiplatform.googleapis.com";
   option (google.api.oauth_scopes) =
@@ -148,6 +147,19 @@ service DatasetService {
     option (google.api.method_signature) = "parent";
   }
 
+  // Deletes a SavedQuery.
+  rpc DeleteSavedQuery(DeleteSavedQueryRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v1/{name=projects/*/locations/*/datasets/*/savedQueries/*}"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.protobuf.Empty"
+      metadata_type: "DeleteOperationMetadata"
+    };
+  }
+
   // Gets an AnnotationSpec.
   rpc GetAnnotationSpec(GetAnnotationSpecRequest) returns (AnnotationSpec) {
     option (google.api.http) = {
@@ -573,6 +585,20 @@ message ListSavedQueriesResponse {
   string next_page_token = 2;
 }
 
+// Request message for
+// [DatasetService.DeleteSavedQuery][google.cloud.aiplatform.v1.DatasetService.DeleteSavedQuery].
+message DeleteSavedQueryRequest {
+  // Required. The resource name of the SavedQuery to delete.
+  // Format:
+  // `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/SavedQuery"
+    }
+  ];
+}
+
 // Request message for
 // [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec].
 message GetAnnotationSpecRequest {

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_service.proto

@@ -335,7 +335,7 @@ service FeaturestoreService {
 message CreateFeaturestoreRequest {
   // Required. The resource name of the Location to create Featurestores.
   // Format:
-  // `projects/{project}/locations/{location}'`
+  // `projects/{project}/locations/{location}`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -957,7 +957,7 @@ message CreateFeatureRequest {
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
-      type: "aiplatform.googleapis.com/EntityType"
+      child_type: "aiplatform.googleapis.com/Feature"
     }
   ];
 
@@ -1167,6 +1167,7 @@ message SearchFeaturesRequest {
   // * `featurestore_id`: Supports = comparisons.
   //
   // Examples:
+  //
   // * `description = "foo bar"` --> Any Feature with description exactly equal
   // to `foo bar`
   // * `value_type = DOUBLE` --> Features whose type is DOUBLE.

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_state.proto

@@ -60,4 +60,7 @@ enum JobState {
   // The job is being updated. Only jobs in the `RUNNING` state can be updated.
   // After updating, the job goes back to the `RUNNING` state.
   JOB_STATE_UPDATING = 10;
+
+  // The job is partially succeeded, some results may be missing due to errors.
+  JOB_STATE_PARTIALLY_SUCCEEDED = 11;
 }

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto

@@ -204,10 +204,14 @@ message Model {
     }
   ];
 
-  // This field is populated if the model is produced by a pipeline job.
-  string pipeline_job = 47 [(google.api.resource_reference) = {
-    type: "aiplatform.googleapis.com/PipelineJob"
-  }];
+  // Optional. This field is populated if the model is produced by a pipeline
+  // job.
+  string pipeline_job = 47 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/PipelineJob"
+    }
+  ];
 
   // Input only. The specification of the container that is to be used when
   // deploying this Model. The specification is ingested upon

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto

@@ -622,11 +622,6 @@ message ExportModelRequest {
   OutputConfig output_config = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
-// Response message of
-// [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset]
-// operation.
-message UpdateExplanationDatasetResponse {}
-
 // Details of
 // [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel]
 // operation.
@@ -652,6 +647,11 @@ message ExportModelOperationMetadata {
   OutputInfo output_info = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
+// Response message of
+// [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset]
+// operation.
+message UpdateExplanationDatasetResponse {}
+
 // Response message of
 // [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel]
 // operation.

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/nas_job.proto

@@ -99,7 +99,7 @@ message NasJob {
       [deprecated = true, (google.api.field_behavior) = OPTIONAL];
 }
 
-// Represents a NasTrial details along with it's parameters. If there is a
+// Represents a NasTrial details along with its parameters. If there is a
 // corresponding train NasTrial, the train NasTrial is also returned.
 message NasTrialDetail {
   option (google.api.resource) = {

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_job.proto

@@ -147,6 +147,9 @@ message PipelineJob {
   // characters, underscores and dashes. International characters are allowed.
   //
   // See https://goo.gl/xmQnxf for more information and examples of labels.
+  //
+  // Note there is some reserved label key for Vertex AI Pipelines.
+  // - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
   map<string, string> labels = 11;
 
   // Runtime config of the pipeline.
@@ -184,6 +187,16 @@ message PipelineJob {
     (google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
   ];
 
+  // A list of names for the reserved ip ranges under the VPC network
+  // that can be used for this Pipeline Job's workload.
+  //
+  // If set, we will deploy the Pipeline Job's workload within the provided ip
+  // ranges. Otherwise, the job will be deployed to any ip ranges under the
+  // provided VPC network.
+  //
+  // Example: ['vertex-ai-ip-range'].
+  repeated string reserved_ip_ranges = 25;
+
   // A template uri from where the
   // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec],
   // if empty, will be downloaded.

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_service.proto

@@ -67,15 +67,6 @@ service TensorboardService {
     option (google.api.method_signature) = "name";
   }
 
-  // Returns a list of monthly active users for a given TensorBoard instance.
-  rpc ReadTensorboardUsage(ReadTensorboardUsageRequest)
-      returns (ReadTensorboardUsageResponse) {
-    option (google.api.http) = {
-      get: "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage"
-    };
-    option (google.api.method_signature) = "tensorboard";
-  }
-
   // Updates a Tensorboard.
   rpc UpdateTensorboard(UpdateTensorboardRequest)
       returns (google.longrunning.Operation) {
@@ -112,6 +103,15 @@ service TensorboardService {
     };
   }
 
+  // Returns a list of monthly active users for a given TensorBoard instance.
+  rpc ReadTensorboardUsage(ReadTensorboardUsageRequest)
+      returns (ReadTensorboardUsageResponse) {
+    option (google.api.http) = {
+      get: "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage"
+    };
+    option (google.api.method_signature) = "tensorboard";
+  }
+
   // Creates a TensorboardExperiment.
   rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest)
       returns (TensorboardExperiment) {
@@ -391,41 +391,6 @@ message GetTensorboardRequest {
   ];
 }
 
-// Request message for [TensorboardService.GetTensorboardUsage][].
-message ReadTensorboardUsageRequest {
-  // Required. The name of the Tensorboard resource.
-  // Format:
-  // `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
-  string tensorboard = 1 [
-    (google.api.field_behavior) = REQUIRED,
-    (google.api.resource_reference) = {
-      type: "aiplatform.googleapis.com/Tensorboard"
-    }
-  ];
-}
-
-// Response message for
-// [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage].
-message ReadTensorboardUsageResponse {
-  // Per user usage data.
-  message PerUserUsageData {
-    // User's username
-    string username = 1;
-
-    // Number of times the user has read data within the Tensorboard.
-    int64 view_count = 2;
-  }
-
-  // Per month usage data
-  message PerMonthUsageData {
-    // Usage data for each user in the given month.
-    repeated PerUserUsageData user_usage_data = 1;
-  }
-
-  // Maps year-month (YYYYMM) string to per month usage data.
-  map<string, PerMonthUsageData> monthly_usage_data = 1;
-}
-
 // Request message for
 // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards].
 message ListTensorboardsRequest {
@@ -509,6 +474,42 @@ message DeleteTensorboardRequest {
   ];
 }
 
+// Request message for
+// [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage].
+message ReadTensorboardUsageRequest {
+  // Required. The name of the Tensorboard resource.
+  // Format:
+  // `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
+  string tensorboard = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/Tensorboard"
+    }
+  ];
+}
+
+// Response message for
+// [TensorboardService.ReadTensorboardUsage][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage].
+message ReadTensorboardUsageResponse {
+  // Per user usage data.
+  message PerUserUsageData {
+    // User's username
+    string username = 1;
+
+    // Number of times the user has read data within the Tensorboard.
+    int64 view_count = 2;
+  }
+
+  // Per month usage data
+  message PerMonthUsageData {
+    // Usage data for each user in the given month.
+    repeated PerUserUsageData user_usage_data = 1;
+  }
+
+  // Maps year-month (YYYYMM) string to per month usage data.
+  map<string, PerMonthUsageData> monthly_usage_data = 1;
+}
+
 // Request message for
 // [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment].
 message CreateTensorboardExperimentRequest {

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto

@@ -283,6 +283,11 @@ message BatchPredictionJob {
   //              or
   //            `projects/{project}/locations/{location}/models/{model}@golden`
   // if no version is specified, the default version will be deployed.
+  //
+  // The model resource could also be a publisher model.
+  //  Example: `publishers/{publisher}/models/{model}`
+  //              or
+  //           `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
   string model = 3 [(google.api.resource_reference) = {
     type: "aiplatform.googleapis.com/Model"
   }];

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/custom_job.proto

@@ -113,6 +113,20 @@ message CustomJob {
 
 // Represents the spec of a CustomJob.
 message CustomJobSpec {
+  // Optional. The ID of the PersistentResource in the same Project and Location
+  // which to run
+  //
+  // If this is specified, the job will be run on existing machines held by the
+  // PersistentResource instead of on-demand short-live machines.
+  // The network and CMEK configs on the job should be consistent with those on
+  // the PersistentResource, otherwise, the job will be rejected.
+  string persistent_resource_id = 14 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/PersistentResource"
+    }
+  ];
+
   // Required. The spec of the worker pools including machine type and Docker
   // image. All worker pools except the first one are optional and can be
   // skipped by providing an empty value.

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset.proto

@@ -59,6 +59,10 @@ message Dataset {
   // Required. Additional information about the Dataset.
   google.protobuf.Value metadata = 8 [(google.api.field_behavior) = REQUIRED];
 
+  // Output only. The number of DataItems in this Dataset. Only apply for
+  // non-structured Dataset.
+  int64 data_item_count = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Output only. Timestamp when this Dataset was created.
   google.protobuf.Timestamp create_time = 4
       [(google.api.field_behavior) = OUTPUT_ONLY];

packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset_service.proto

@@ -38,8 +38,7 @@ option java_package = "com.google.cloud.aiplatform.v1beta1";
 option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
 option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
 
-// The service that handles the CRUD of Vertex AI Dataset and its child
-// resources.
+// The service that manages Vertex AI Dataset and its child resources.
 service DatasetService {
   option (google.api.default_host) = "aiplatform.googleapis.com";
   option (google.api.oauth_scopes) =
@@ -148,6 +147,19 @@ service DatasetService {
     option (google.api.method_signature) = "parent";
   }
 
+  // Deletes a SavedQuery.
+  rpc DeleteSavedQuery(DeleteSavedQueryRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v1beta1/{name=projects/*/locations/*/datasets/*/savedQueries/*}"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.protobuf.Empty"
+      metadata_type: "DeleteOperationMetadata"
+    };
+  }
+
   // Gets an AnnotationSpec.
   rpc GetAnnotationSpec(GetAnnotationSpecRequest) returns (AnnotationSpec) {
     option (google.api.http) = {
@@ -573,6 +585,20 @@ message ListSavedQueriesResponse {
   string next_page_token = 2;
 }
 
+// Request message for
+// [DatasetService.DeleteSavedQuery][google.cloud.aiplatform.v1beta1.DatasetService.DeleteSavedQuery].
+message DeleteSavedQueryRequest {
+  // Required. The resource name of the SavedQuery to delete.
+  // Format:
+  // `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/SavedQuery"
+    }
+  ];
+}
+
 // Request message for
 // [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec].
 message GetAnnotationSpecRequest {