Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Resource Manager API, gRPC: CloudService.Delete

Written by
Updated at October 17, 2024

Deletes the specified cloud.

gRPC request

rpc Delete (DeleteCloudRequest) returns (operation.Operation)

DeleteCloudRequest

{
  "cloudId": "string",
  "deleteAfter": "google.protobuf.Timestamp"
}

Field

Description

cloudId

string

Required field. ID of the cloud to delete.
To get the cloud ID, use a CloudService.List request.

deleteAfter

google.protobuf.Timestamp

The timestamp after which the process of deleting the cloud should begin.
Until this timestamp, the cloud goes into the PENDING_DELETION state and all resources in this
cloud are stopped. In this state, it is possible to cancel the delete operation without any loss.
After this timestamp, the status of the cloud will become DELETING and the process of deleting
all the resources of the cloud will be started. If deleteAfter is not specified it will be
(now + 24 hours). To initiate an immediate deletion deleteAfter must be <= now.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cloudId": "string",
    "deleteAfter": "google.protobuf.Timestamp",
    "cancelledBy": "string",
    "cancelledAt": "google.protobuf.Timestamp"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

DeleteCloudMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Empty

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

DeleteCloudMetadata

Field

Description

cloudId

string

ID of the cloud that is being deleted.

deleteAfter

google.protobuf.Timestamp

The timestamp after which the process of deleting the cloud should begin.

cancelledBy

string

Information about operation cancellation

cancelledAt

google.protobuf.Timestamp
Previous
Update
Next
ListOperations