package containerd.services.content.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Content
content.proto:29Content provides access to a content addressable storage system.
rpc Abort (, )
content.proto:90Abort cancels the ongoing write named in the request. Any resources associated with the write will be collected.
message
content.proto:332string ref = 1
rpc Delete (, )
content.proto:52Delete will delete the referenced object.
message
content.proto:154string digest = 1
Digest specifies which content to delete.
rpc Info (, )
content.proto:34Info returns information about a committed object. This call can be used for getting the size of content and checking for existence.
message
content.proto:112string digest = 1
message
content.proto:116optional info = 1
rpc List (, stream )
content.proto:49List streams the entire set of content as Info objects and closes the stream. Typically, this will yield a large response, chunked into messages. Clients should make provisions to ensure they can handle the entire data set.
message
content.proto:136repeated string filters = 1
Filters contains one or more filters using the syntax defined in the containerd filter package. The returned result will be those that match any of the provided filters. Expanded, containers that match the following will be returned: filters[0] or filters[1] or ... or filters[n-1] or filters[n] If filters is zero-length or nil, all items will be returned.
message
content.proto:150repeated info = 1
rpc ListStatuses (, )
content.proto:68ListStatuses returns the status of ongoing object ingestions, started via Write. Only those matching the regular expression will be provided in the response. If the provided regular expression is empty, all ingestions will be provided.
message
content.proto:199repeated string filters = 1
message
content.proto:203repeated statuses = 1
rpc Read (, stream )
content.proto:57Read allows one to read an object based on the offset into the content. The requested data may be returned in one or more messages.
message
content.proto:161ReadContentRequest defines the fields that make up a request to read a portion of data from a stored object.
string digest = 1
Digest is the hash identity to read.
int64 offset = 2
Offset specifies the number of bytes from the start at which to begin the read. If zero or less, the read will be from the start. This uses standard zero-indexed semantics.
int64 size = 3
size is the total size of the read. If zero, the entire blob will be returned by the service.
message
content.proto:176ReadContentResponse carries byte data for a read request.
int64 offset = 1
offset of the returned data
bytes data = 2
actual data
rpc Status (, )
content.proto:60Status returns the status for a single reference.
message
content.proto:191string ref = 1
message
content.proto:195optional status = 1
rpc Update (, )
content.proto:41Update updates content metadata. This call can be used to manage the mutable content labels. The immutable metadata such as digest, size, and committed at cannot be updated.
message
content.proto:120optional info = 1
optional update_mask = 2
UpdateMask specifies which fields to perform the update on. If empty, the operation applies to all fields. In info, Digest, Size, and CreatedAt are immutable, other field may be updated using this mask. If no mask is provided, all mutable field are updated.
message
content.proto:132optional info = 1
rpc Write (stream , stream )
content.proto:86Write begins or resumes writes to a resource identified by a unique ref. Only one active stream may exist at a time for each ref. Once a write stream has started, it may only write to a single ref, thus once a stream is started, the ref may be omitted on subsequent writes. For any write transaction represented by a ref, only a single write may be made to a given offset. If overlapping writes occur, it is an error. Writes should be sequential and implementations may throw an error if this is required. If expected_digest is set and already part of the content store, the write will fail. When completed, the commit flag should be set to true. If expected size or digest is set, the content will be validated against those values.
message
content.proto:235WriteContentRequest writes data to the request ref at offset.
WriteAction action = 1
Action sets the behavior of the write. When this is a write and the ref is not yet allocated, the ref will be allocated and the data will be written at offset. If the action is write and the ref is allocated, it will accept data to an offset that has not yet been written. If the action is write and there is no data, the current write status will be returned. This works differently from status because the stream holds a lock.
string ref = 2
Ref identifies the pre-commit object to write to.
int64 total = 3
Total can be set to have the service validate the total size of the committed content. The latest value before or with the commit action message will be use to validate the content. If the offset overflows total, the service may report an error. It is only required on one message for the write. If the value is zero or less, no validation of the final content will be performed.
string expected = 4
Expected can be set to have the service validate the final content against the provided digest. If the digest is already present in the object store, an AlreadyExists error will be returned. Only the latest version will be used to check the content against the digest. It is only required to include it on a single message, before or with the commit action message.
int64 offset = 5
Offset specifies the number of bytes from the start at which to begin the write. For most implementations, this means from the start of the file. This uses standard, zero-indexed semantics. If the action is write, the remote may remove all previously written data after the offset. Implementations may support arbitrary offsets but MUST support reseting this value to zero with a write. If an implementation does not support a write at a particular offset, an OutOfRange error must be returned.
bytes data = 6
Data is the actual bytes to be written. If this is empty and the message is not a commit, a response will be returned with the current write state.
map<string, string> labels = 7
Labels are arbitrary data on snapshots. The combined size of a key/value pair cannot exceed 4096 bytes.
message
content.proto:298WriteContentResponse is returned on the culmination of a write call.
WriteAction action = 1
Action contains the action for the final message of the stream. A writer should confirm that they match the intended result.
optional started_at = 2
StartedAt provides the time at which the write began. This must be set for stat and commit write actions. All other write actions may omit this.
optional updated_at = 3
UpdatedAt provides the last time of a successful write. This must be set for stat and commit write actions. All other write actions may omit this.
int64 offset = 4
Offset is the current committed size for the write.
int64 total = 5
Total provides the current, expected total size of the write. We include this to provide consistency with the Status structure on the client writer. This is only valid on the Stat and Commit response.
string digest = 6
Digest, if present, includes the digest up to the currently committed bytes. If action is commit, this field will be set. It is implementation defined if this is set for other actions.
message
content.proto:93Used in: , , ,
string digest = 1
Digest is the hash identity of the blob.
int64 size = 2
Size is the total number of bytes in the blob.
optional created_at = 3
CreatedAt provides the time at which the blob was committed.
optional updated_at = 4
UpdatedAt provides the time the info was last updated.
map<string, string> labels = 5
Labels are arbitrary data on snapshots. The combined size of a key/value pair cannot exceed 4096 bytes.
message
content.proto:181Used in: ,
optional started_at = 1
optional updated_at = 2
string ref = 3
int64 offset = 4
int64 total = 5
string expected = 6
WriteAction defines the behavior of a WriteRequest.
Used in: ,
STAT = 0
WriteActionStat instructs the writer to return the current status while holding the lock on the write.
WRITE = 1
WriteActionWrite sets the action for the write request to write data. Any data included will be written at the provided offset. The transaction will be left open for further writes. This is the default.
COMMIT = 2
WriteActionCommit will write any outstanding data in the message and commit the write, storing it under the digest. This can be used in a single message to send the data, verify it and commit it. This action will always terminate the write.