package neoshowcase.protobuf
Get desktop application:
View/edit binary Protocol Buffers messages
service APIService
gateway.proto:515General / System
rpc CancelBuild (, )
gateway.proto:637CancelBuild 該当ビルドが進行中の場合キャンセルします
rpc CreateApplication (, )
gateway.proto:574CreateApplication アプリを作成します
message
gateway.proto:407string name = 1
string repository_id = 2
string ref_name = 3
optional config = 4
repeated websites = 5
repeated port_publications = 6
bool start_on_create = 7
rpc CreateRepository (, )
gateway.proto:547CreateRepository リポジトリを登録します
message
gateway.proto:353string name = 1
string url = 2
optional auth = 3
rpc CreateUserKey (, )
gateway.proto:536CreateUserKey アプリコンテナSSH用の公開鍵を登録します
message
gateway.proto:327string public_key = 1
string name = 2
rpc DeleteApplication (, )
gateway.proto:586DeleteApplication アプリを削除します 先にアプリのシャットダウンが必要です
rpc DeleteEnvVar (, )
gateway.proto:614DeleteEnvVar アプリの環境変数を削除します システムによって設定された環境変数は削除できません
message
gateway.proto:483string application_id = 1
string key = 2
rpc DeleteRepository (, )
gateway.proto:569DeleteRepository リポジトリを削除します 関連する全てのアプリケーションの削除が必要です
rpc DeleteUserKey (, )
gateway.proto:542DeleteUserKey 登録した公開鍵を削除します
message
gateway.proto:332string key_id = 1
rpc GenerateKeyPair (, )
gateway.proto:523GenerateKeyPair リポジトリ登録で使用する鍵ペアを一時的に生成します
message
gateway.proto:314string key_id = 1
string public_key = 2
rpc GetAllBuilds (, )
gateway.proto:623GetAllBuilds すべてのアプリケーションのビルドキューを取得します
message
gateway.proto:459int32 page = 1
zero-indexed page
int32 limit = 2
rpc GetApplication (, )
gateway.proto:580GetApplication アプリを取得します
GetApplicationMetrics アプリのメトリクスを取得します
message
gateway.proto:488string application_id = 1
string metrics_name = 2
optional before = 3
int64 limit_seconds = 4
message
gateway.proto:267repeated metrics = 1
rpc GetApplications (, )
gateway.proto:576GetApplications アプリ一覧を取得します
message
gateway.proto:417GetApplicationsRequest.Scope scope = 1
optional string repository_id = 2
message
gateway.proto:451repeated applications = 1
rpc GetAvailableMetrics (, )
gateway.proto:591GetAvailableMetrics 取得可能メトリクス一覧を取得します
message
gateway.proto:258repeated string metrics_names = 1
rpc GetBuild (, )
gateway.proto:631GetBuild アプリのビルド情報を取得します
rpc GetBuildArtifact (, )
gateway.proto:645GetBuildArtifact 静的サイトアプリの場合ビルド成果物（静的ファイルのtar）を取得します
message
gateway.proto:469string artifact_id = 1
message
gateway.proto:246string filename = 1
bytes content = 2
rpc GetBuildLog (, )
gateway.proto:639GetBuildLog 終了したビルドのログを取得します
rpc GetBuildLogStream (, stream )
gateway.proto:643GetBuildLogStream ビルド中のログをストリーム形式で取得します
rpc GetBuilds (, )
gateway.proto:627GetBuilds アプリのビルド一覧を取得します
rpc GetEnvVars (, )
gateway.proto:608GetEnvVars アプリの環境変数を取得します
rpc GetMe (, )
gateway.proto:528GetMe 自身の情報を取得します プロキシ認証のため常に成功します
rpc GetOutput (, )
gateway.proto:599GetOutput アプリの出力を取得します
message
gateway.proto:495string application_id = 1
optional before = 2
int32 limit = 3
message
gateway.proto:276repeated outputs = 1
rpc GetOutputStream (, stream )
gateway.proto:603GetOutputStream アプリの出力をストリーム形式で取得します
message
gateway.proto:501string application_id = 1
optional begin = 2
rpc GetRepositories (, )
gateway.proto:549GetRepositories リポジトリ一覧を取得します
message
gateway.proto:359GetRepositoriesRequest.Scope scope = 1
message
gateway.proto:447repeated repositories = 1
rpc GetRepository (, )
gateway.proto:557GetRepository リポジトリを取得します
GetRepositoryCommits コミットのメタ情報を取得します
message
gateway.proto:385repeated string hashes = 1
message
gateway.proto:389repeated commits = 1
rpc GetRepositoryRefs (, )
gateway.proto:561GetRepositoryRefs リポジトリの現在の有効なref一覧を取得します
message
gateway.proto:511repeated refs = 1
rpc GetSystemInfo (, )
gateway.proto:519GetSystemInfo システム固有情報を取得します
rpc GetUserKeys (, )
gateway.proto:538GetUserKeys 登録した公開鍵一覧を取得します
message
gateway.proto:323repeated keys = 1
rpc GetUsers (, )
gateway.proto:532GetUsers 全てのユーザーの情報を取得します
message
gateway.proto:319repeated users = 1
rpc RefreshRepository (, )
gateway.proto:567RefreshRepository 自動更新間隔を待たず、手動でリモートリポジトリの最新情報に追従させます
rpc RetryCommitBuild (, )
gateway.proto:635RetryCommitBuild アプリの該当コミットのビルドをやり直します
message
gateway.proto:506string application_id = 1
string commit = 2
rpc SetEnvVar (, )
gateway.proto:612SetEnvVar アプリの環境変数をセットします システムによって設定された環境変数は上書きできません
message
gateway.proto:477string application_id = 1
string key = 2
string value = 3
rpc StartApplication (, )
gateway.proto:616StartApplication アプリを起動します 起動中の場合は再起動します
rpc StopApplication (, )
gateway.proto:618StopApplication アプリをシャットダウンします
rpc UpdateApplication (, )
gateway.proto:584UpdateApplication アプリ情報を更新します
message
gateway.proto:427string id = 1
optional string name = 2
optional string repository_id = 3
optional string ref_name = 4
optional config = 5
optional websites = 6
optional port_publications = 7
optional owner_ids = 8
rpc UpdateRepository (, )
gateway.proto:565UpdateRepository リポジトリ情報を更新します
message
gateway.proto:370string id = 1
optional string name = 2
optional string url = 3
optional auth = 4
optional owner_ids = 5
rpc CopyFileTree (, )
controller.proto:166message
controller.proto:96string destination = 1
bytes tar_content = 2
TODO: stream contents?
rpc Exec (, stream )
controller.proto:167message
controller.proto:106string work_dir = 1
repeated string cmd = 2
repeated envs = 3
message
controller.proto:112HelperExecResponse.Type type = 1
oneof body
bytes log = 2
int32 exit_code = 3
rpc ConnectBuilder (stream , stream )
controller.proto:162message
controller.proto:84BuilderResponse.Type type = 1
oneof body
connected = 2
settled = 3
message
controller.proto:62BuilderRequest.Type type = 1
oneof body
start_build = 2
cancel_build = 3
message
controller.proto:23bytes private_key = 1
optional image_config = 2
rpc PingBuild (, )
controller.proto:157rpc SaveArtifact (, )
controller.proto:159message
controller.proto:33optional artifact = 1
bytes body = 2
TODO: stream contents?
rpc SaveBuildLog (, )
controller.proto:160message
controller.proto:38string build_id = 1
bytes log = 2
rpc SaveRuntimeImage (, )
controller.proto:161message
controller.proto:43string build_id = 1
int64 size = 2
rpc StreamBuildLog (stream , )
controller.proto:158message
controller.proto:28string build_id = 1
bytes log = 2
rpc ConnectSSGen (, stream )
controller.proto:171message
controller.proto:124SSGenRequest.Type type = 1
rpc CancelBuild (, )
controller.proto:147rpc CancelBuildLocal (, )
controller.proto:152rpc FetchRepository (, )
controller.proto:141rpc GetSystemInfo (, )
controller.proto:139rpc RegisterBuild (, )
controller.proto:142rpc StartBuild (, )
controller.proto:146rpc StartBuildLocal (, )
controller.proto:150rpc StreamBuildLog (, stream )
controller.proto:145rpc SyncDeployments (, )
controller.proto:143
rpc Sync (, )
controller.proto:175
message
gateway.proto:31Used in:
string name = 1
string url = 2
message
controller.proto:7Used as response type in: ControllerService.DiscoverBuildLogInstance, ControllerService.DiscoverBuildLogLocal
optional string address = 1
message
gateway.proto:196Used as response type in: APIService.CreateApplication, APIService.GetApplication
Used as field type in: ,
string id = 1
string name = 2
string repository_id = 3
string ref_name = 4
string commit = 5
DeployType deploy_type = 6
bool running = 7
Application.ContainerState container = 8
string container_message = 9
string current_build = 10
optional created_at = 11
optional updated_at = 12
optional config = 13
repeated websites = 14
repeated port_publications = 15
repeated string owner_ids = 16
optional BuildStatus latest_build_status = 17
Used in:
MISSING = 0
STARTING = 1
RESTARTING = 2
RUNNING = 3
EXITED = 4
ERRORED = 5
UNKNOWN = 6
message
gateway.proto:157Used in: , ,
oneof build_config
runtime_buildpack = 1
runtime_cmd = 2
runtime_dockerfile = 3
static_buildpack = 4
static_cmd = 5
static_dockerfile = 6
message
gateway.proto:226Used in:
string application_id = 1
string key = 2
string value = 3
bool system = 4
message
gateway.proto:233Used as response type in: APIService.GetEnvVars
Used as field type in:
repeated variables = 1
message
gateway.proto:455Used as request type in: APIService.DeleteApplication, APIService.GetApplication, APIService.GetBuilds, APIService.GetEnvVars, APIService.StartApplication, APIService.StopApplication, ControllerService.RegisterBuild
string id = 1
message
gateway.proto:262Used in:
optional time = 1
double value = 2
message
gateway.proto:271Used as response type in: APIService.GetOutputStream
Used as field type in:
optional time = 1
string log = 2
message
gateway.proto:237Used in: ,
string id = 1
string name = 2
string build_id = 3
int64 size = 4
optional created_at = 5
optional deleted_at = 6
Used in: ,
OFF = 0
SOFT = 1
HARD = 2
message
gateway.proto:100Used in:
bool enabled = 1
AutoShutdownConfig.StartupBehavior startup = 2
Used in:
UNDEFINED = 0
LOADING_PAGE = 1
BLOCKING = 2
message
gateway.proto:17Used in:
string domain = 1
repeated string exclude_domains = 2
bool auth_available = 3
bool already_bound = 4
already_bound ドメインが他のアプリケーションによって専有されているか
message
gateway.proto:25Used in:
int32 start_port = 1
int32 end_port = 2
PortPublicationProtocol protocol = 3
message
gateway.proto:289Used as response type in: APIService.GetBuild
Used as field type in: ,
string id = 1
string application_id = 2
string commit = 3
BuildStatus status = 4
optional queued_at = 5
optional started_at = 6
optional updated_at = 7
optional finished_at = 8
bool retriable = 9
repeated artifacts = 10
optional runtime_image = 11
message
gateway.proto:118Used in:
optional runtime_config = 1
string context = 2
message
gateway.proto:123Used in:
optional runtime_config = 1
string base_image = 2
string build_cmd = 3
message
gateway.proto:129Used in:
optional runtime_config = 1
string dockerfile_name = 2
string context = 3
message
gateway.proto:140Used in:
optional static_config = 1
string context = 2
message
gateway.proto:145Used in:
optional static_config = 1
string base_image = 2
string build_cmd = 3
message
gateway.proto:151Used in:
optional static_config = 1
string dockerfile_name = 2
string context = 3
message
gateway.proto:465Used as request type in: APIService.CancelBuild, APIService.GetBuild, APIService.GetBuildLog, APIService.GetBuildLogStream, ControllerBuilderService.PingBuild, ControllerService.CancelBuild, ControllerService.CancelBuildLocal, ControllerService.DiscoverBuildLogInstance, ControllerService.DiscoverBuildLogLocal, ControllerService.StreamBuildLog
Used as field type in:
string build_id = 1
message
gateway.proto:303Used as response type in: APIService.GetBuildLog, APIService.GetBuildLogStream, ControllerService.StreamBuildLog
bytes log = 1
message
controller.proto:79Used in:
string build_id = 1
BuildStatus status = 2
Used in: , ,
QUEUED = 0
BUILDING = 1
SUCCEEDED = 2
FAILED = 3
CANCELLED = 4
SKIPPED = 5
Used in:
START_BUILD = 0
CANCEL_BUILD = 1
Used in:
CONNECTED = 0
BUILD_SETTLED = 1
message
controller.proto:74Used in:
int64 priority = 1
Larger value means higher priority
message
gateway.proto:345Used in: ,
oneof auth
none = 1
basic = 2
ssh = 3
message
gateway.proto:336Used in:
string username = 1
string password = 2
message
gateway.proto:341Used in:
string key_id = 1
message
gateway.proto:393Used in: ,
string fqdn = 1
string path_prefix = 2
bool strip_prefix = 3
bool https = 4
bool h2c = 5
int32 http_port = 6
AuthenticationType authentication = 7
message
gateway.proto:403string id = 1
Used in:
RUNTIME = 0
STATIC = 1
Used in:
MINE = 0
ALL = 1
REPOSITORY = 2
message
gateway.proto:473Used as response type in: APIService.GetAllBuilds, APIService.GetBuilds
repeated builds = 1
Used in:
MINE = 0
CREATABLE = 1
PUBLIC = 2
ALL = 3
admin only
message
gateway.proto:307Used in:
string ref_name = 1
string commit = 2
message
controller.proto:131GiteaIntegrationRequest.Type type = 1
Used in:
RESYNC = 0
message
controller.proto:101Used in:
string key = 1
string value = 2
Used in:
LOG = 0
EXIT_CODE = 1
message
controller.proto:11Used in:
optional registry = 1
string name_prefix = 2
string tmp_name_prefix = 3
message
controller.proto:12Used in:
string scheme = 1
string addr = 2
string username = 3
string password = 4
message
null.proto:6Used in: ,
optional timestamp = 1
bool valid = 2
message
gateway.proto:190Used in: , ,
int32 internet_port = 1
int32 application_port = 2
PortPublicationProtocol protocol = 3
Used in: ,
TCP = 0
UDP = 1
message
gateway.proto:72Used as response type in: APIService.CreateRepository, APIService.GetRepository
Used as field type in: ,
string id = 1
string name = 2
string url = 3
string html_url = 4
Repository.AuthMethod auth_method = 5
repeated string owner_ids = 6
Used in:
NONE = 0
BASIC = 1
SSH = 2
message
gateway.proto:381Used as request type in: APIService.DeleteRepository, APIService.GetRepository, APIService.GetRepositoryRefs, APIService.RefreshRepository, ControllerService.FetchRepository
string repository_id = 1
message
controller.proto:48Used in:
optional repo = 1
string username = 2
string password = 3
string ssh_key = 4
message
gateway.proto:110Used in: , ,
bool use_mariadb = 1
bool use_mongodb = 2
string entrypoint = 3
string command = 4
optional auto_shutdown = 5
message
gateway.proto:251Used in:
string id = 1
string build_id = 2
int64 size = 3
optional created_at = 4
Used in:
RELOAD = 0
message
gateway.proto:12Used in:
string host = 1
int32 port = 2
message
gateway.proto:86Used in:
string hash = 1
string author_name = 2
optional commit_date = 3
string message = 4
message
controller.proto:55Used in:
optional repo = 1
optional app = 2
optional app_envs = 3
optional build = 4
message
gateway.proto:135Used in: , ,
string artifact_path = 1
bool spa = 2
message
gateway.proto:36Used as response type in: APIService.GetSystemInfo, ControllerService.GetSystemInfo
string public_key = 1
public_key システムのSSH公開鍵 リポジトリごとにSSH秘密鍵を設定しないデフォルトSSH認証で使用
optional ssh = 2
ssh アプリケーションにSSH接続するための情報
repeated domains = 3
domains 使用可能なドメイン一覧
repeated ports = 4
ports 使用可能なポート一覧
repeated additional_links = 5
additional_links UIメニューに表示するリンク一覧
string version = 6
version NeoShowcase version
string revision = 7
revision NeoShowcase version
message
gateway.proto:441Used in:
repeated string owner_ids = 1
message
gateway.proto:437Used in:
repeated port_publications = 1
message
gateway.proto:433Used in:
repeated websites = 1
message
gateway.proto:375Used in:
repeated string owner_ids = 1
message
gateway.proto:55Used as response type in: APIService.GetMe
Used as field type in:
string id = 1
string name = 2
bool admin = 3
string avatar_url = 4
message
gateway.proto:62Used as response type in: APIService.CreateUserKey
Used as field type in:
string id = 1
string user_id = 2
string public_key = 3
string name = 4
optional created_at = 5
message
gateway.proto:174Used in:
string id = 1
string fqdn = 2
string path_prefix = 3
bool strip_prefix = 4
bool https = 5
bool h2c = 6
int32 http_port = 7
AuthenticationType authentication = 8