repository.proto

syntax = "proto3";
package bentoml;

import "google/protobuf/timestamp.proto";

import "status.proto";


message BentoUri {
  enum StorageType {
    UNSET = 0;
    LOCAL = 1;
    S3 = 2;
    GCS = 3;
    AZURE_BLOB_STORAGE = 4;
    HDFS = 5;
  }

  StorageType type = 1;
  string uri = 2;
  string additional_fields = 3;
}

message BentoServiceMetadata {
  message BentoServiceEnv {
    string setup_sh = 1;
    string conda_env = 2;
    string pip_dependencies = 3;
    string python_version = 4;
  }

  message BentoArtifact {
    string name = 1;
    string artifact_type = 2;
  }

  message BentoServiceApi {
    string name = 1;
    string handler_type = 2;
    string docs = 3;
  }

  string name = 1;
  string version = 2;
  google.protobuf.Timestamp created_at = 3;
  BentoServiceEnv env = 4;
  repeated BentoArtifact artifacts = 5;
  repeated BentoServiceApi apis = 6;
}

message Bento {
  string name = 1;
  string version = 2;
  BentoUri uri = 3;
  BentoServiceMetadata bento_service_metadata = 4;
  UploadStatus status = 5;
}

message AddBentoRequest {
  string bento_name = 1;
  string bento_version = 2;
}

message AddBentoResponse {
  Status status = 1;
  BentoUri uri = 2;
}

message UploadStatus {
  enum Status {
    UNINITIALIZED = 0; // default
    UPLOADING = 1;
    DONE = 2;
    ERROR = 3;
    TIMEOUT = 4;
  }
  Status status = 1;
  google.protobuf.Timestamp updated_at = 2;
  int32 percentage = 3; // for uploading completion percentage
  string error_message = 4; // for error message
}

message UpdateBentoRequest {
  string bento_name = 1;
  string bento_version = 2;
  UploadStatus upload_status = 3;
  BentoServiceMetadata service_metadata = 4;
}

message UpdateBentoResponse {
  Status status = 1;
}

message DangerouslyDeleteBentoRequest {
  string bento_name = 1;
  string bento_version = 2;
}

message DangerouslyDeleteBentoResponse {
  Status status = 1;
}

message GetBentoRequest {
  string bento_name = 1;
  string bento_version = 2;
}

message GetBentoResponse {
  Status status = 1;
  Bento bento = 2;
}

message ListBentoRequest {
  string bento_name = 1;
  int32 offset = 2;
  int32 limit = 3;
  string filter = 4;
}

message ListBentoResponse {
  Status status = 1;
  repeated Bento bentos = 2;
}