package containerd.services.leases.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Leases service manages resources leases within the metadata store.

• rpc AddResource (AddResourceRequest, google.protobuf.Empty)

  leases.proto:42

  AddResource references the resource by the provided lease.

  message AddResourceRequest

  leases.proto:99

  • string id = 1

  • optional Resource resource = 2

• rpc Create (CreateRequest, CreateResponse)

  leases.proto:30

  Create creates a new lease for managing changes to metadata. A lease can be used to protect objects from being removed.

  message CreateRequest

  leases.proto:60

  • string id = 1

    ID is used to identity the lease, when the id is not set the service generates a random identifier for the lease.

  • map<string, string> labels = 3

  message CreateResponse

  leases.proto:68

  • optional Lease lease = 1

• rpc Delete (DeleteRequest, google.protobuf.Empty)

  leases.proto:35

  Delete deletes the lease and makes any unreferenced objects created during the lease eligible for garbage collection if not referenced or retained by other resources during the lease.

  message DeleteRequest

  leases.proto:72

  • string id = 1

  • bool sync = 2

    Sync indicates that the delete and cleanup should be done synchronously before returning to the caller Default is false

• rpc DeleteResource (DeleteResourceRequest, google.protobuf.Empty)

  leases.proto:45

  DeleteResource dereferences the resource by the provided lease.

  message DeleteResourceRequest

  leases.proto:105

  • string id = 1

  • optional Resource resource = 2

• rpc List (ListRequest, ListResponse)

  leases.proto:39

  List lists all active leases, returning the full list of leases and optionally including the referenced resources.

  message ListRequest

  leases.proto:82

  • repeated string filters = 1

  message ListResponse

  leases.proto:86

  • repeated Lease leases = 1

• rpc ListResources (ListResourcesRequest, ListResourcesResponse)

  leases.proto:48

  ListResources lists all the resources referenced by the lease.

  message ListResourcesRequest

  leases.proto:111

  • string id = 1

  message ListResourcesResponse

  leases.proto:115

  • repeated Resource resources = 1

Lease is an object which retains resources while it exists.

Used in: CreateResponse, ListResponse

• string id = 1

• optional google.protobuf.Timestamp created_at = 2

• map<string, string> labels = 3

Used in: AddResourceRequest, DeleteResourceRequest, ListResourcesResponse

• string id = 1

• string type = 2

  For snapshotter resource, there are many snapshotter types here, like overlayfs, devmapper etc. The type will be formatted with type, like "snapshotter/overlayfs".