feat: add deleteFeatureValues in aiplatform v1beta1 featurestore_service.proto

Google APIs · copybara-github · commit 39c28bfb6e8c · 2022-09-15T12:57:36.000-07:00
PiperOrigin-RevId: 474635535
diff --git a/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml b/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml
@@ -44,6 +44,8 @@ types:
 - name: google.cloud.aiplatform.v1beta1.CreateMetadataStoreOperationMetadata
 - name: google.cloud.aiplatform.v1beta1.CreateSpecialistPoolOperationMetadata
 - name: google.cloud.aiplatform.v1beta1.CreateTensorboardOperationMetadata
+- name: google.cloud.aiplatform.v1beta1.DeleteFeatureValuesOperationMetadata
+- name: google.cloud.aiplatform.v1beta1.DeleteFeatureValuesResponse
 - name: google.cloud.aiplatform.v1beta1.DeleteMetadataStoreOperationMetadata
 - name: google.cloud.aiplatform.v1beta1.DeleteOperationMetadata
 - name: google.cloud.aiplatform.v1beta1.DeployIndexOperationMetadata
diff --git a/google/cloud/aiplatform/v1beta1/featurestore_service.proto b/google/cloud/aiplatform/v1beta1/featurestore_service.proto
@@ -280,6 +280,29 @@ service FeaturestoreService {
     };
   }
 
+  // Delete Feature values from Featurestore.
+  //
+  // The progress of the deletion is tracked by the returned operation. The
+  // deleted feature values are guaranteed to be invisible to subsequent read
+  // operations after the operation is marked as successfully done.
+  //
+  // If a delete feature values operation fails, the feature values
+  // returned from reads and exports may be inconsistent. If consistency is
+  // required, the caller must retry the same delete request again and wait till
+  // the new operation returned is marked as successfully done.
+  rpc DeleteFeatureValues(DeleteFeatureValuesRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:deleteFeatureValues"
+      body: "*"
+    };
+    option (google.api.method_signature) = "entity_type";
+    option (google.longrunning.operation_info) = {
+      response_type: "DeleteFeatureValuesResponse"
+      metadata_type: "DeleteFeatureValuesOperationMetadata"
+    };
+  }
+
   // Searches Features matching a query in a given project.
   rpc SearchFeatures(SearchFeaturesRequest) returns (SearchFeaturesResponse) {
     option (google.api.http) = {
@@ -1207,6 +1230,12 @@ message BatchReadFeatureValuesOperationMetadata {
   GenericOperationMetadata generic_metadata = 1;
 }
 
+// Details of operations that delete Feature values.
+message DeleteFeatureValuesOperationMetadata {
+  // Operation metadata for Featurestore delete Features values.
+  GenericOperationMetadata generic_metadata = 1;
+}
+
 // Details of operations that perform create EntityType.
 message CreateEntityTypeOperationMetadata {
   // Operation metadata for EntityType.
@@ -1224,3 +1253,51 @@ message BatchCreateFeaturesOperationMetadata {
   // Operation metadata for Feature.
   GenericOperationMetadata generic_metadata = 1;
 }
+
+// Request message for
+// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues].
+message DeleteFeatureValuesRequest {
+  // Message to select entity.
+  // If an entity id is selected, all the feature values corresponding to the
+  // entity id will be deleted, including the entityId.
+  message SelectEntity {
+    // Required. Selectors choosing feature values of which entity id to be
+    // deleted from the EntityType.
+    EntityIdSelector entity_id_selector = 1
+        [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // Defines options to select feature values to be deleted.
+  oneof DeleteOption {
+    // Select feature values to be deleted by specifying entities.
+    SelectEntity select_entity = 2;
+  }
+
+  // Required. The resource name of the EntityType grouping the Features for
+  // which values are being deleted from. Format:
+  // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
+  string entity_type = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/EntityType"
+    }
+  ];
+}
+
+// Response message for
+// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues].
+message DeleteFeatureValuesResponse {}
+
+// Selector for entityId. Getting ids from the given source.
+message EntityIdSelector {
+  // Details about the source data, including the location of the storage and
+  // the format.
+  oneof EntityIdsSource {
+    // Source of Csv
+    CsvSource csv_source = 3;
+  }
+
+  // Source column that holds entity IDs. If not provided, entity IDs are
+  // extracted from the column named `entity_id`.
+  string entity_id_field = 5;
+}
