objectstorev1

type AssetProviderClient interface {
	// FetchAsset writes the object at asset_uri to write_path if, and only if,
	// its content hashes to sha256. Nothing is written to write_path otherwise.
	// It returns PERMISSION_DENIED if asset_uri, or any prefix of it, is a
	// snapshot or tag URI, before reading anything; NOT_FOUND if the object does
	// not exist; and FAILED_PRECONDITION if the object is larger than max_bytes
	// or than the plugin can hold while verifying it, or its sha256 does not
	// match.
	FetchAsset(ctx context.Context, in *FetchAssetRequest, opts ...grpc.CallOption) (*FetchAssetResponse, error)
}

type AssetProviderServer interface {
	// FetchAsset writes the object at asset_uri to write_path if, and only if,
	// its content hashes to sha256. Nothing is written to write_path otherwise.
	// It returns PERMISSION_DENIED if asset_uri, or any prefix of it, is a
	// snapshot or tag URI, before reading anything; NOT_FOUND if the object does
	// not exist; and FAILED_PRECONDITION if the object is larger than max_bytes
	// or than the plugin can hold while verifying it, or its sha256 does not
	// match.
	FetchAsset(context.Context, *FetchAssetRequest) (*FetchAssetResponse, error)
	// contains filtered or unexported methods
}

type CleanupSnapshotRequest struct {

	// A snapshot URI, or the prefix of a resource that owns several snapshots
	// (e.g. gs://<bucket>/<root>/atespaces/<atespace>/actors/<uid>). Every file
	// below it is deleted. A bare bucket is rejected with INVALID_ARGUMENT.
	SnapshotUri string `protobuf:"bytes,1,opt,name=snapshot_uri,json=snapshotUri,proto3" json:"snapshot_uri,omitempty"`
	// contains filtered or unexported fields
}

type CleanupSnapshotResponse struct {
	// contains filtered or unexported fields
}

type ControlProviderClient interface {
	// CleanupSnapshot deletes every file of a snapshot, or of every snapshot
	// under an owner's prefix. Deleting an absent snapshot succeeds.
	CleanupSnapshot(ctx context.Context, in *CleanupSnapshotRequest, opts ...grpc.CallOption) (*CleanupSnapshotResponse, error)
	// CopySnapshot copies every file of src_uri to dst_uri, overwriting files
	// already at dst_uri. src_uri and dst_uri may be in different buckets. It
	// returns FAILED_PRECONDITION if src_uri holds no files.
	CopySnapshot(ctx context.Context, in *CopySnapshotRequest, opts ...grpc.CallOption) (*CopySnapshotResponse, error)
}

type ControlProviderServer interface {
	// CleanupSnapshot deletes every file of a snapshot, or of every snapshot
	// under an owner's prefix. Deleting an absent snapshot succeeds.
	CleanupSnapshot(context.Context, *CleanupSnapshotRequest) (*CleanupSnapshotResponse, error)
	// CopySnapshot copies every file of src_uri to dst_uri, overwriting files
	// already at dst_uri. src_uri and dst_uri may be in different buckets. It
	// returns FAILED_PRECONDITION if src_uri holds no files.
	CopySnapshot(context.Context, *CopySnapshotRequest) (*CopySnapshotResponse, error)
	// contains filtered or unexported methods
}

type CopySnapshotRequest struct {

	// The URI to copy from, e.g. an actor's snapshot.
	SrcUri string `protobuf:"bytes,1,opt,name=src_uri,json=srcUri,proto3" json:"src_uri,omitempty"`
	// The URI to copy to, e.g. a tag's prefix.
	DstUri string `protobuf:"bytes,2,opt,name=dst_uri,json=dstUri,proto3" json:"dst_uri,omitempty"`
	// contains filtered or unexported fields
}

type CopySnapshotResponse struct {
	// contains filtered or unexported fields
}

type FetchAssetRequest struct {

	// The object to read, e.g. gs://<bucket>/kata-assets/vmlinux. Which schemes
	// a plugin serves is up to the plugin. At most 2048 bytes, the SandboxConfig
	// URL's limit. Masked in logged requests, like the SandboxConfig URL it
	// comes from.
	AssetUri string `protobuf:"bytes,1,opt,name=asset_uri,json=assetUri,proto3" json:"asset_uri,omitempty"`
	// The expected SHA-256 of the object's content, as 64 lower-case hex
	// characters.
	Sha256 string `protobuf:"bytes,2,opt,name=sha256,proto3" json:"sha256,omitempty"`
	// Full local path of an existing regular file the asset is written to. The
	// plugin replaces the file, keeping its mode, only once the content has been
	// verified, never creates it, and leaves it unchanged on any error. The
	// caller opens it after the call: a descriptor opened before still reads
	// the old content.
	WritePath string `protobuf:"bytes,3,opt,name=write_path,json=writePath,proto3" json:"write_path,omitempty"`
	// The largest object, in bytes, the caller accepts. Must be positive.
	MaxBytes int64 `protobuf:"varint,4,opt,name=max_bytes,json=maxBytes,proto3" json:"max_bytes,omitempty"`
	// contains filtered or unexported fields
}

type FetchAssetResponse struct {
	// contains filtered or unexported fields
}

type FetchSnapshotRequest struct {

	// The snapshot to read, e.g. gs://<bucket>/<prefix>.
	SnapshotUri string `protobuf:"bytes,1,opt,name=snapshot_uri,json=snapshotUri,proto3" json:"snapshot_uri,omitempty"`
	// The JWT of the actor that owns the snapshot, for plugins that authorize
	// storage access per actor. Substrate does not set it yet, so it is
	// currently always empty.
	ActorJwt string `protobuf:"bytes,2,opt,name=actor_jwt,json=actorJwt,proto3" json:"actor_jwt,omitempty"`
	// Full local path of the directory the files are written into. It must
	// exist.
	WritePath string `protobuf:"bytes,3,opt,name=write_path,json=writePath,proto3" json:"write_path,omitempty"`
	// Base names of the files to download. Required.
	Files []string `protobuf:"bytes,4,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

type FetchSnapshotResponse struct {
	// contains filtered or unexported fields
}

type NodeProviderClient interface {
	// FetchSnapshot downloads the named files of a snapshot into write_path.
	// It returns NOT_FOUND if any requested file is absent from the snapshot.
	// A plugin that authorizes per actor returns PERMISSION_DENIED if actor_jwt
	// does not grant read access to snapshot_uri.
	FetchSnapshot(ctx context.Context, in *FetchSnapshotRequest, opts ...grpc.CallOption) (*FetchSnapshotResponse, error)
	// UploadSnapshot uploads the named files from local_path into a snapshot.
	// It returns success only once every file is durably stored. On failure,
	// files already stored may remain, and the caller can remove them with
	// ControlProvider.CleanupSnapshot. A plugin that authorizes per actor returns
	// PERMISSION_DENIED if actor_jwt does not grant write access to snapshot_uri.
	UploadSnapshot(ctx context.Context, in *UploadSnapshotRequest, opts ...grpc.CallOption) (*UploadSnapshotResponse, error)
}

type NodeProviderServer interface {
	// FetchSnapshot downloads the named files of a snapshot into write_path.
	// It returns NOT_FOUND if any requested file is absent from the snapshot.
	// A plugin that authorizes per actor returns PERMISSION_DENIED if actor_jwt
	// does not grant read access to snapshot_uri.
	FetchSnapshot(context.Context, *FetchSnapshotRequest) (*FetchSnapshotResponse, error)
	// UploadSnapshot uploads the named files from local_path into a snapshot.
	// It returns success only once every file is durably stored. On failure,
	// files already stored may remain, and the caller can remove them with
	// ControlProvider.CleanupSnapshot. A plugin that authorizes per actor returns
	// PERMISSION_DENIED if actor_jwt does not grant write access to snapshot_uri.
	UploadSnapshot(context.Context, *UploadSnapshotRequest) (*UploadSnapshotResponse, error)
	// contains filtered or unexported methods
}

type UnimplementedAssetProviderServer struct{}

type UnimplementedControlProviderServer struct{}

type UnimplementedNodeProviderServer struct{}

type UnsafeAssetProviderServer interface {
	// contains filtered or unexported methods
}

type UnsafeControlProviderServer interface {
	// contains filtered or unexported methods
}

type UnsafeNodeProviderServer interface {
	// contains filtered or unexported methods
}

type UploadSnapshotRequest struct {

	// The snapshot to write, e.g. gs://<bucket>/<prefix>.
	SnapshotUri string `protobuf:"bytes,1,opt,name=snapshot_uri,json=snapshotUri,proto3" json:"snapshot_uri,omitempty"`
	// The JWT of the actor that owns the snapshot, for plugins that authorize
	// storage access per actor. Substrate does not set it yet, so it is
	// currently always empty.
	ActorJwt string `protobuf:"bytes,2,opt,name=actor_jwt,json=actorJwt,proto3" json:"actor_jwt,omitempty"`
	// Full local path of the directory the files are read from.
	LocalPath string `protobuf:"bytes,3,opt,name=local_path,json=localPath,proto3" json:"local_path,omitempty"`
	// Base names of the files to upload. Required.
	Files []string `protobuf:"bytes,4,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

type UploadSnapshotResponse struct {
	// contains filtered or unexported fields
}