DeleteSome
deletes a resource and streams back the resources that failed to be deleted and a description for the failure.
DeleteSome is supported on all keyed resources.
However, in certain releases, this may have been missing. See Support section below for details.
The Keys
field is required to be fully-specified because DeleteSome
needs to identify resources to delete.
The protobuf definition of DeleteSome
is defined as such (for ExampleConfig
):
rpc DeleteSome (ExampleConfigDeleteSomeRequest) returns (stream ExampleConfigDeleteSomeResponse);
The generated request for a model (ExampleConfig
, here) looks like so:
message ExampleConfigDeleteSomeRequest {
// Keys indicates which ExampleConfig instances to remove.
// This field must always be set.
repeated ExampleKey keys = 1;
};
The generated response for a model (ExampleConfig
, here) looks like so:
// ExampleConfigDeleteSomeResponse is only sent when there is an error.
message ExampleConfigDeleteSomeResponse {
// Key echoes back the key of ExampleConfig instance that failed to be deleted.
ExampleKey key = 1;
// Error is a description of the error encountered while deleting the
// ExampleConfig instance.
string error = 2;
};
Supported for configlet.v1, studio.v1, tag.v2, workspace.v1 in CloudVision-as-a-Service.
Supported for configlet.v1, studio.v1, tag.v2 from CVP 2024.2.0