package api.bucketsd.pb
Get desktop application:
View/edit binary Protocol Buffers messages
service APIService
bucketsd.proto:345rpc List (, )
bucketsd.proto:346message
bucketsd.proto:44(message has no fields)
message
bucketsd.proto:46repeated roots = 1
rpc Create (, )
bucketsd.proto:347message
bucketsd.proto:50string name = 1
string bootstrap_cid = 2
bool private = 3
bool unfreeze = 4
message
bucketsd.proto:57optional root = 1
optional links = 2
bytes seed = 3
string seed_cid = 4
int64 pinned = 5
string retrieval_id = 6
rpc Root (, )
bucketsd.proto:348message
bucketsd.proto:66string key = 1
message
bucketsd.proto:70optional root = 1
rpc Links (, )
bucketsd.proto:349message
bucketsd.proto:74string key = 1
string path = 2
rpc ListPath (, )
bucketsd.proto:350message
bucketsd.proto:85string key = 1
string path = 2
message
bucketsd.proto:90optional item = 1
optional root = 2
rpc ListIpfsPath (, )
bucketsd.proto:351message
bucketsd.proto:106string path = 1
message
bucketsd.proto:110optional item = 1
rpc PushPath (stream , stream )
bucketsd.proto:352message
bucketsd.proto:114oneof payload
header = 1
bytes chunk = 2
message
bucketsd.proto:127optional event = 1
rpc PushPaths (stream , stream )
bucketsd.proto:353message
bucketsd.proto:140oneof payload
header = 1
chunk = 2
message
bucketsd.proto:158string path = 1
string cid = 2
int64 size = 3
int64 pinned = 4
optional root = 5
rpc PullPath (, stream )
bucketsd.proto:354message
bucketsd.proto:166string key = 1
string path = 2
message
bucketsd.proto:171bytes chunk = 1
rpc PullIpfsPath (, stream )
bucketsd.proto:355message
bucketsd.proto:175string path = 1
message
bucketsd.proto:179bytes chunk = 1
rpc SetPath (, )
bucketsd.proto:356message
bucketsd.proto:183string key = 1
string path = 2
string cid = 3
message
bucketsd.proto:189int64 pinned = 1
rpc MovePath (, )
bucketsd.proto:357message
bucketsd.proto:193string key = 1
string from_path = 2
string to_path = 3
message
bucketsd.proto:199(message has no fields)
rpc Remove (, )
bucketsd.proto:358message
bucketsd.proto:201string key = 1
message
bucketsd.proto:205int64 pinned = 1
rpc RemovePath (, )
bucketsd.proto:359message
bucketsd.proto:209string key = 1
string path = 2
string root = 3
message
bucketsd.proto:215optional root = 1
int64 pinned = 2
message
bucketsd.proto:227string key = 1
string path = 2
map<string, PathAccessRole> roles = 3
message
bucketsd.proto:233int64 pinned = 1
message
bucketsd.proto:237string key = 1
string path = 2
message
bucketsd.proto:242map<string, PathAccessRole> roles = 1
Archive
message
bucketsd.proto:304string key = 1
message
bucketsd.proto:308optional archive_config = 1
message
bucketsd.proto:312string key = 1
optional archive_config = 2
message
bucketsd.proto:317(message has no fields)
rpc Archive (, )
bucketsd.proto:366message
bucketsd.proto:319string key = 1
optional archive_config = 2
bool skip_automatic_verified_deal = 3
message
bucketsd.proto:325(message has no fields)
rpc Archives (, )
bucketsd.proto:367message
bucketsd.proto:327string key = 1
message
bucketsd.proto:332todo: For v3, change this to { Archives archives = 1; }
optional current = 1
repeated history = 2
rpc ArchiveWatch (, stream )
bucketsd.proto:368message
bucketsd.proto:337string key = 1
message
bucketsd.proto:341string msg = 1
message
bucketsd.proto:264Used in: ,
string cid = 1
string job_id = 2
ArchiveStatus archive_status = 3
bool aborted = 4
string aborted_msg = 5
string failure_msg = 6
int64 created_at = 7
repeated deal_info = 8
message
bucketsd.proto:246Used in: , ,
int32 rep_factor = 1
int64 deal_min_duration = 2
repeated string excluded_miners = 3
repeated string trusted_miners = 4
repeated string country_codes = 5
optional renew = 6
uint64 max_price = 7
bool fast_retrieval = 8
int64 deal_start_offset = 9
bool verified_deal = 10
message
bucketsd.proto:299Used in:
bool enabled = 1
int32 threshold = 2
Used in:
ARCHIVE_STATUS_UNSPECIFIED = 0
ARCHIVE_STATUS_QUEUED = 1
ARCHIVE_STATUS_EXECUTING = 2
ARCHIVE_STATUS_FAILED = 3
ARCHIVE_STATUS_CANCELED = 4
ARCHIVE_STATUS_SUCCESS = 5
message
bucketsd.proto:259Used in:
optional current = 1
repeated history = 2
message
bucketsd.proto:284Used in:
string proposal_cid = 1
uint64 state_id = 2
string state_name = 3
string miner = 4
string piece_cid = 5
uint64 size = 6
uint64 price_per_epoch = 7
uint64 start_epoch = 8
uint64 duration = 9
uint64 deal_id = 10
int64 activation_epoch = 11
string message = 12
message
bucketsd.proto:79Used as response type in: APIService.Links
Used as field type in:
string url = 1
string www = 2
string ipns = 3
message
bucketsd.proto:5Used in: ,
map<string, PathAccessRole> roles = 1
int64 updated_at = 2
string key = 3
Used in: , ,
PATH_ACCESS_ROLE_UNSPECIFIED = 0
PATH_ACCESS_ROLE_READER = 1
PATH_ACCESS_ROLE_WRITER = 2
PATH_ACCESS_ROLE_ADMIN = 3
message
bucketsd.proto:95Used in: ,
string cid = 1
string name = 2
string path = 3
int64 size = 4
bool is_dir = 5
repeated items = 6
int32 items_count = 7
optional metadata = 9
@todo: For v3, change this to 8.
message
bucketsd.proto:120Used in:
string key = 1
string path = 2
string root = 3
message
bucketsd.proto:130Used in:
string name = 1
string path = 2
int64 bytes = 3
string size = 4
optional root = 5
int64 pinned = 6
message
bucketsd.proto:152Used in:
string path = 1
bytes data = 2
message
bucketsd.proto:146Used in:
string key = 1
string root = 2
repeated string paths = 3
message
bucketsd.proto:16Used in: , , , , , ,
string key = 1
string name = 2
string path = 3
int64 created_at = 4
int64 updated_at = 5
string thread = 6
string owner = 7
int32 version = 8
optional metadata = 9
string link_key = 10
map<string, > path_metadata = 11
optional archives = 12