@ -31,10 +31,13 @@ import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto" ;
import "google/protobuf/field_mask.proto" ;
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1" ;
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform" ;
option java_multiple_files = true ;
option java_outer_classname = "MetadataServiceProto" ;
option java_package = "com.google.cloud.aiplatform.v1beta1" ;
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1" ;
option ruby_package = "Google::Cloud::AIPlatform::V1beta1" ;
/ / Service for reading and writing metadata entries.
service MetadataService {
@ -116,6 +119,31 @@ service MetadataService {
option ( google.api.method_signature ) = "artifact,update_mask" ;
}
/ / Deletes an Artifact.
rpc DeleteArtifact ( DeleteArtifactRequest ) returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
delete : "/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*}"
} ;
option ( google.api.method_signature ) = "name" ;
option ( google.longrunning.operation_info ) = {
response_type : "google.protobuf.Empty"
metadata_type : "DeleteOperationMetadata"
} ;
}
/ / Purges Artifacts.
rpc PurgeArtifacts ( PurgeArtifactsRequest ) returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
post : "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/artifacts:purge"
body : "*"
} ;
option ( google.api.method_signature ) = "parent" ;
option ( google.longrunning.operation_info ) = {
response_type : "PurgeArtifactsResponse"
metadata_type : "PurgeArtifactsMetadata"
} ;
}
/ / Creates a Context associated with a MetadataStore.
rpc CreateContext ( CreateContextRequest ) returns ( Context ) {
option ( google.api.http ) = {
@ -162,6 +190,19 @@ service MetadataService {
} ;
}
/ / Purges Contexts.
rpc PurgeContexts ( PurgeContextsRequest ) returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
post : "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/contexts:purge"
body : "*"
} ;
option ( google.api.method_signature ) = "parent" ;
option ( google.longrunning.operation_info ) = {
response_type : "PurgeContextsResponse"
metadata_type : "PurgeContextsMetadata"
} ;
}
/ / Adds a set of Artifacts and Executions to a Context. If any of the
/ / Artifacts or Executions have already been added to a Context , they are
/ / simply skipped.
@ -229,6 +270,31 @@ service MetadataService {
option ( google.api.method_signature ) = "execution,update_mask" ;
}
/ / Deletes an Execution.
rpc DeleteExecution ( DeleteExecutionRequest ) returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
delete : "/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*}"
} ;
option ( google.api.method_signature ) = "name" ;
option ( google.longrunning.operation_info ) = {
response_type : "google.protobuf.Empty"
metadata_type : "DeleteOperationMetadata"
} ;
}
/ / Purges Executions.
rpc PurgeExecutions ( PurgeExecutionsRequest ) returns ( google.longrunning.Operation ) {
option ( google.api.http ) = {
post : "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/executions:purge"
body : "*"
} ;
option ( google.api.method_signature ) = "parent" ;
option ( google.longrunning.operation_info ) = {
response_type : "PurgeExecutionsResponse"
metadata_type : "PurgeExecutionsMetadata"
} ;
}
/ / Adds Events to the specified Execution. An Event indicates whether an
/ / Artifact was used as an input or output for an Execution. If an Event
/ / already exists between the Execution and the Artifact , the Event is
@ -514,6 +580,66 @@ message UpdateArtifactRequest {
bool allow_missing = 3 ;
}
/ / Request message for [ MetadataService.DeleteArtifact ] [ google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact ] .
message DeleteArtifactRequest {
/ / Required. The resource name of the Artifact to delete.
/ / Format :
/ / projects / { project } / locations / { location } / metadataStores / { metadatastore } / artifacts / { artifact }
string name = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
type : "aiplatform.googleapis.com/Artifact"
}
] ;
/ / Optional. The etag of the Artifact to delete.
/ / If this is provided , it must match the server ' s etag. Otherwise , the
/ / request will fail with a FAILED_PRECONDITION.
string etag = 2 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Request message for [ MetadataService.PurgeArtifacts ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts ] .
message PurgeArtifactsRequest {
/ / Required. The metadata store to purge Artifacts from.
/ / Format :
/ / projects / { project } / locations / { location } / metadataStores / { metadatastore }
string parent = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
child_type : "aiplatform.googleapis.com/Artifact"
}
] ;
/ / Required. A required filter matching the Artifacts to be purged.
/ / E.g. , update_time < = 2020 - 11 - 19 T11 : 30 : 00 - 04 : 00.
string filter = 2 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / Optional. Flag to indicate to actually perform the purge.
/ / If ` force ` is set to false , the method will return a sample of
/ / Artifact names that would be deleted.
bool force = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Response message for [ MetadataService.PurgeArtifacts ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts ] .
message PurgeArtifactsResponse {
/ / The number of Artifacts that this request deleted ( or , if ` force ` is false ,
/ / the number of Artifacts that will be deleted ) . This can be an estimate.
int64 purge_count = 1 ;
/ / A sample of the Artifact names that will be deleted.
/ / Only populated if ` force ` is set to false . The maximum number of samples is
/ / 100 ( it is possible to return fewer ) .
repeated string purge_sample = 2 [ ( google.api.resource_reference ) = {
type : "aiplatform.googleapis.com/Artifact"
} ] ;
}
/ / Details of operations that perform [ MetadataService.PurgeArtifacts ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts ] .
message PurgeArtifactsMetadata {
/ / Operation metadata for purging Artifacts.
GenericOperationMetadata generic_metadata = 1 ;
}
/ / Request message for [ MetadataService.CreateContext ] [ google.cloud.aiplatform.v1beta1.MetadataService.CreateContext ] .
message CreateContextRequest {
/ / Required. The resource name of the MetadataStore where the Context should be
@ -641,7 +767,7 @@ message UpdateContextRequest {
/ / Request message for [ MetadataService.DeleteContext ] [ google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext ] .
message DeleteContextRequest {
/ / Required. The resource name of the Context to retriev e.
/ / Required. The resource name of the Context to delet e.
/ / Format :
/ / projects / { project } / locations / { location } / metadataStores / { metadatastore } / contexts / { context }
string name = 1 [
@ -651,11 +777,56 @@ message DeleteContextRequest {
}
] ;
/ / If set to true , any child resources of this Context will be deleted.
/ / ( Otherwise , the request will fail with a FAILED_PRECONDITION error if the
/ / Context has any child resources , such as another Context , Artifact , or
/ / Execution ) .
/ / The force deletion semantics is still undefined.
/ / Users should not use this field.
bool force = 2 ;
/ / Optional. The etag of the Context to delete.
/ / If this is provided , it must match the server ' s etag. Otherwise , the
/ / request will fail with a FAILED_PRECONDITION.
string etag = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Request message for [ MetadataService.PurgeContexts ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts ] .
message PurgeContextsRequest {
/ / Required. The metadata store to purge Contexts from.
/ / Format :
/ / projects / { project } / locations / { location } / metadataStores / { metadatastore }
string parent = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
child_type : "aiplatform.googleapis.com/Context"
}
] ;
/ / Required. A required filter matching the Contexts to be purged.
/ / E.g. , update_time < = 2020 - 11 - 19 T11 : 30 : 00 - 04 : 00.
string filter = 2 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / Optional. Flag to indicate to actually perform the purge.
/ / If ` force ` is set to false , the method will return a sample of
/ / Context names that would be deleted.
bool force = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Response message for [ MetadataService.PurgeContexts ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts ] .
message PurgeContextsResponse {
/ / The number of Contexts that this request deleted ( or , if ` force ` is false ,
/ / the number of Contexts that will be deleted ) . This can be an estimate.
int64 purge_count = 1 ;
/ / A sample of the Context names that will be deleted.
/ / Only populated if ` force ` is set to false . The maximum number of samples is
/ / 100 ( it is possible to return fewer ) .
repeated string purge_sample = 2 [ ( google.api.resource_reference ) = {
type : "aiplatform.googleapis.com/Context"
} ] ;
}
/ / Details of operations that perform [ MetadataService.PurgeContexts ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts ] .
message PurgeContextsMetadata {
/ / Operation metadata for purging Contexts.
GenericOperationMetadata generic_metadata = 1 ;
}
/ / Request message for [ MetadataService.AddContextArtifactsAndExecutions ] [ google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions ] .
@ -857,6 +1028,67 @@ message UpdateExecutionRequest {
bool allow_missing = 3 ;
}
/ / Request message for [ MetadataService.DeleteExecution ] [ google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution ] .
message DeleteExecutionRequest {
/ / Required. The resource name of the Execution to delete.
/ / Format :
/ / projects / { project } / locations / { location } / metadataStores / { metadatastore } / executions / { execution }
string name = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
type : "aiplatform.googleapis.com/Execution"
}
] ;
/ / Optional. The etag of the Execution to delete.
/ / If this is provided , it must match the server ' s etag. Otherwise , the
/ / request will fail with a FAILED_PRECONDITION.
string etag = 2 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Request message for [ MetadataService.PurgeExecutions ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions ] .
message PurgeExecutionsRequest {
/ / Required. The metadata store to purge Executions from.
/ / Format :
/ / projects / { project } / locations / { location } / metadataStores / { metadatastore }
string parent = 1 [
( google.api.field_behavior ) = REQUIRED ,
( google.api.resource_reference ) = {
child_type : "aiplatform.googleapis.com/Execution"
}
] ;
/ / Required. A required filter matching the Executions to be purged.
/ / E.g. , update_time < = 2020 - 11 - 19 T11 : 30 : 00 - 04 : 00.
string filter = 2 [ ( google.api.field_behavior ) = REQUIRED ] ;
/ / Optional. Flag to indicate to actually perform the purge.
/ / If ` force ` is set to false , the method will return a sample of
/ / Execution names that would be deleted.
bool force = 3 [ ( google.api.field_behavior ) = OPTIONAL ] ;
}
/ / Response message for [ MetadataService.PurgeExecutions ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions ] .
message PurgeExecutionsResponse {
/ / The number of Executions that this request deleted ( or , if ` force ` is
/ / false , the number of Executions that will be deleted ) . This can be an
/ / estimate.
int64 purge_count = 1 ;
/ / A sample of the Execution names that will be deleted.
/ / Only populated if ` force ` is set to false . The maximum number of samples is
/ / 100 ( it is possible to return fewer ) .
repeated string purge_sample = 2 [ ( google.api.resource_reference ) = {
type : "aiplatform.googleapis.com/Execution"
} ] ;
}
/ / Details of operations that perform [ MetadataService.PurgeExecutions ] [ google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions ] .
message PurgeExecutionsMetadata {
/ / Operation metadata for purging Executions.
GenericOperationMetadata generic_metadata = 1 ;
}
/ / Request message for [ MetadataService.AddExecutionEvents ] [ google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents ] .
message AddExecutionEventsRequest {
/ / Required. The resource name of the Execution that the Events connect