Delete

Deletes the specified folder.

TypeScript

import {
  cloudApi,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const DeleteFolderRequest =
  cloudApi.resourcemanager.folder_service.DeleteFolderRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.FolderServiceClient);

  const operation = await client.delete(
    DeleteFolderRequest.fromPartial({
      folderId: "folderId",
      // deleteAfter: {
      // seconds: 0,
      // nanos: 0
      // }
    })
  );
  await waitForOperation(operation, session);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.resourcemanager.v1.folder_service_pb2 import DeleteFolderMetadata
from yandex.cloud.resourcemanager.v1.folder_service_pb2 import DeleteFolderRequest
from yandex.cloud.resourcemanager.v1.folder_service_pb2_grpc import FolderServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(FolderServiceStub)
operation = service.Delete()
operation_result = sdk.wait_operation_and_get_result(
    operation,
    meta_type=DeleteFolderMetadata,
)

DeleteFolderRequest

folderId : string

ID of the folder to delete. To get the folder ID, use a FolderService.List request.

deleteAfter : google.protobuf.Timestamp

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

Operation

An Operation resource. For more information, see Operation.

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 : google.protobuf.Any

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.

One of result

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.

• error : google.rpc.Status

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

• response : google.protobuf.Any

  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.

---