package hangar

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc PING (PingRequest, PingReply)

  hangar_service.proto:9

  message PingRequest

  hangar_service.proto:160

  (message has no fields)

  message PingReply

  hangar_service.proto:162

  • string result = 1

• rpc GetClientConfig (GetClientConfigRequest, GetClientConfigReply)

  hangar_service.proto:10

  message GetClientConfigRequest

  hangar_service.proto:167

  (message has no fields)

  message GetClientConfigReply

  hangar_service.proto:169

  • map<string, string> config = 1

    dictionary style map of the config options

  • optional ErrorProto error = 2

    success or not

• rpc FetchBranchRecord (FetchBranchRecordRequest, FetchBranchRecordReply)

  hangar_service.proto:12

  message FetchBranchRecordRequest

  hangar_service.proto:184

  • optional BranchRecord rec = 1

    name of the branch to fetch

  message FetchBranchRecordReply

  hangar_service.proto:188

  • optional BranchRecord rec = 1

    record result of the branch

  • optional ErrorProto error = 2

    success or not

• rpc FetchData (FetchDataRequest, stream FetchDataReply)

  hangar_service.proto:13

  message FetchDataRequest

  hangar_service.proto:196

  • string uri = 1

    bytes raw_data = 1; // total size of the split tensorprotos int64 comp_nbytes = 2; // total size of the uncompressed raw data int64 uncomp_nbytes = 3; // string schema_hash = 4; ErrorProto error = 4;

  message FetchDataReply

  hangar_service.proto:208

  • string uri = 1

  • bytes raw_data = 2

    data container for the tensor

  • int64 nbytes = 3

    total number of bytes

  • optional ErrorProto error = 4

    // total size of the split tensorprotos int64 comp_nbytes = 2; // total size of the uncompressed raw data int64 uncomp_nbytes = 3; success or not

• rpc FetchCommit (FetchCommitRequest, stream FetchCommitReply)

  hangar_service.proto:14

  message FetchCommitRequest

  hangar_service.proto:224

  • string commit = 1

    (hex)digest of the commit to fetch references to

  message FetchCommitReply

  hangar_service.proto:228

  • string commit = 1

    (hex)digest hash of the commit record

  • int64 total_byte_size = 2

    total size of bytes

  • optional CommitRecord record = 3

    data

  • optional ErrorProto error = 4

    success or not

• rpc FetchSchema (FetchSchemaRequest, FetchSchemaReply)

  hangar_service.proto:15

  message FetchSchemaRequest

  hangar_service.proto:240

  • optional SchemaRecord rec = 1

    schema record spec with hash specified

  message FetchSchemaReply

  hangar_service.proto:244

  • optional SchemaRecord rec = 1

    schema record spec

  • optional ErrorProto error = 2

    success or not

• rpc PushBranchRecord (PushBranchRecordRequest, PushBranchRecordReply)

  hangar_service.proto:17

  message PushBranchRecordRequest

  hangar_service.proto:259

  • optional BranchRecord rec = 1

    branch record to push

  message PushBranchRecordReply

  hangar_service.proto:263

  • optional ErrorProto error = 1

    success or not

• rpc PushData (stream PushDataRequest, PushDataReply)

  hangar_service.proto:18

  message PushDataRequest

  hangar_service.proto:268

  • string uri = 1

  • bytes raw_data = 2

    data container for the tensor

  • int64 nbytes = 3

    total number of bytes

  • DataType data_type = 4

    data type of the contents

  • string schema_hash = 5

    TODO: Remove need for schema hash

  message PushDataReply

  hangar_service.proto:279

  • optional ErrorProto error = 1

    success or not

• rpc PushCommit (stream PushCommitRequest, PushCommitReply)

  hangar_service.proto:19

  message PushCommitRequest

  hangar_service.proto:285

  • string commit = 1

    (hex)digest hash of the commit record

  • int64 total_byte_size = 2

    total size of bytes

  • optional CommitRecord record = 3

    data

  message PushCommitReply

  hangar_service.proto:293

  • optional ErrorProto error = 1

    success or not

• rpc PushSchema (PushSchemaRequest, PushSchemaReply)

  hangar_service.proto:20

  message PushSchemaRequest

  hangar_service.proto:298

  • optional SchemaRecord rec = 1

  message PushSchemaReply

  hangar_service.proto:301

  • optional ErrorProto error = 1

    SchemaRecord rec = 1;

• rpc FetchFindMissingCommits (FindMissingCommitsRequest, FindMissingCommitsReply)

  hangar_service.proto:22

• rpc FetchFindMissingHashRecords (stream FindMissingHashRecordsRequest, stream FindMissingHashRecordsReply)

  hangar_service.proto:23

• rpc FetchFindMissingSchemas (FindMissingSchemasRequest, FindMissingSchemasReply)

  hangar_service.proto:24

• rpc PushFindMissingCommits (FindMissingCommitsRequest, FindMissingCommitsReply)

  hangar_service.proto:26

• rpc PushFindMissingHashRecords (stream FindMissingHashRecordsRequest, stream FindMissingHashRecordsReply)

  hangar_service.proto:27

• rpc PushFindMissingSchemas (FindMissingSchemasRequest, FindMissingSchemasReply)

  hangar_service.proto:28

• rpc FetchFindDataOrigin (stream DataOriginRequest, stream DataOriginReply)

  hangar_service.proto:30

  message DataOriginRequest

  hangar_service.proto:102

  • string digest = 1

  message DataOriginReply

  hangar_service.proto:128

  • DataLocation location = 1

  • DataType data_type = 2

  • string digest = 3

  • string uri = 4

  • bool compression = 5

  • map<string, string> compression_opts = 6

• rpc PushFindDataOrigin (stream PushFindDataOriginRequest, stream PushFindDataOriginReply)

  hangar_service.proto:31

  message PushFindDataOriginRequest

  hangar_service.proto:138

  • DataType data_type = 1

  • string digest = 2

  • bool compression_is_desired = 3

  message PushFindDataOriginReply

  hangar_service.proto:144

  • string digest = 1

  • DataLocation location = 2

  • string uri = 3

  • bool compression_expected = 5

  • map<string, string> compression_opts_expected = 6

• rpc PushBeginContext (PushBeginContextRequest, PushBeginContextReply)

  hangar_service.proto:32

  message PushBeginContextRequest

  hangar_service.proto:44

  • string client_uuid = 1

    TODO: make this field actually do something

  message PushBeginContextReply

  hangar_service.proto:48

  • optional ErrorProto err = 1

• rpc PushEndContext (PushEndContextRequest, PushEndContextReply)

  hangar_service.proto:33

  message PushEndContextRequest

  hangar_service.proto:53

  • string client_uuid = 1

    TODO: make this field actually do something

  message PushEndContextReply

  hangar_service.proto:57

  • optional ErrorProto err = 1

Used in: FetchBranchRecordReply, FetchBranchRecordRequest, FindMissingCommitsReply, FindMissingCommitsRequest, PushBranchRecordRequest

• string name = 1

  name of the branch

• string commit = 2

  branch head commit hash

Used in: FetchCommitReply, PushCommitRequest

• bytes parent = 1

  parent hash(s) of the commit in same format as local store

• bytes ref = 2

  compressed record reference contents of the commit

• bytes spec = 3

  metadata attached to the commit record (username, email, message, time, etc.)

Used in: DataOriginReply, PushFindDataOriginReply

• REMOTE_SERVER = 0

  Server Side Local Disk

• MINIO = 1

  Minio Instance

• S3 = 2

  AWS S3

• GCS = 3

  Google Cloud Store

• ABS = 4

  Azure Blob Store

Used in: DataOriginReply, PushDataRequest, PushFindDataOriginRequest

• NP_ARRAY = 0

• SCHEMA = 1

  Do not know if intend to share this or not.

• STR = 2

• BYTES = 3

Used in: FetchBranchRecordReply, FetchCommitReply, FetchDataReply, FetchSchemaReply, FindMissingCommitsReply, FindMissingHashRecordsReply, FindMissingSchemasReply, GetClientConfigReply, PushBeginContextReply, PushBranchRecordReply, PushCommitReply, PushDataReply, PushEndContextReply, PushSchemaReply

• int64 code = 1

  binary indicator of success. 1: success, 0: failed

• string message = 2

  string response indicating success. 'OK': success, 'ERROR': failed

Used as response type in: HangarService.FetchFindMissingCommits, HangarService.PushFindMissingCommits

• repeated string commits = 1

  list of commits existing on one side but not the other in requested branch.

• optional BranchRecord branch = 2

  branch to query

• optional ErrorProto error = 3

  success or not

Used as request type in: HangarService.FetchFindMissingCommits, HangarService.PushFindMissingCommits

• repeated string commits = 1

  list of commits existing on one side

• optional BranchRecord branch = 2

  branch to query

Used as response type in: HangarService.FetchFindMissingHashRecords, HangarService.PushFindMissingHashRecords

• string commit = 1

  commit hash specified

• bytes hashs = 2

  all hashes existing on a side

• int64 total_byte_size = 3

  number of hashes total

• optional ErrorProto error = 4

  success or not

Used as request type in: HangarService.FetchFindMissingHashRecords, HangarService.PushFindMissingHashRecords

• string commit = 1

  commit hash to check hash records for

• bytes hashs = 2

  all hashes existing on a side

• int64 total_byte_size = 3

  total byte size

Used as response type in: HangarService.FetchFindMissingSchemas, HangarService.PushFindMissingSchemas

• string commit = 1

  commit hash specified

• repeated string schema_digests = 2

  schema records on that side

• optional ErrorProto error = 3

  success or not

Used as request type in: HangarService.FetchFindMissingSchemas, HangarService.PushFindMissingSchemas

• string commit = 1

  commit hash specified

• repeated string schema_digests = 2

  schema records on that side

• string type = 1

  specific hash algorithm used to calculate the digest

• string digest = 2

  (hex)digest of the hash record

Used in: FetchSchemaReply, FetchSchemaRequest, PushSchemaRequest

• string digest = 1

  hash of the schema def

• bytes blob = 2

  encoded schema val to be sent