Protocol Documentation

Table of Contents

• analysis_record.proto

  • Analysis
  • AnalysisType
  • BatchStatus

• analysis_requests.proto

  • AnalysisRecordList
  • AnalysisRecordLookupRequest
  • AnalysisRecordResponse
  • AnalysisRecordResponse.StatusCountRecord

• analysis_status.proto

  • AnalysisStatus

• analysis_submission.proto

  • AnalysisSubmission
  • Extra
  • FileMetadata
  • HTCondorExtraInfo
  • Job
  • Step
  • Step.Component
  • Step.Config
  • Step.EnvironmentEntry
  • Step.Input
  • Step.Output
  • Step.Param

• Scalar Value Types

Top

analysis_record.proto

Analysis

An analysis in the system.

An analysis is an app that was run by a user.

Field	Type	Label	Description
id	string		The UUID for the analysis
description	string		The description of the analysis provided by the user.
name	string		The name of the analysis provided by the user.
app	apps.App		App information about the analysis.
app_version	apps.AppVersion		App version information for the analysis.
kind	AnalysisType		The analysis type, which tells which environment to run the analysis in.
result_folder_path	string		The path to the folder containing analysis outputs.
start_date	google.protobuf.Timestamp		The date the analysis was submitted.
end_date	google.protobuf.Timestamp		The date the analyses finished.
planned_end_date	google.protobuf.Timestamp		The date the analysis was scheduled to end.
status	string		The status of the analysis
deleted	bool		Whether the analysis was deleted.
notify	bool		Whether notifications should be emitted on status changes.
user	user.User		The user that submitted the analysis.
subdomain	string		The subdomain assigned to the analysis for VICE.
parent_id	string		The UUID of the analysis that spawned this analysis. Used for batch analyses.
millicores_reserved	double		The number of millicores reserved for the analysis.

AnalysisType

Corresponds to the job_types table in the database.

Field	Type	Label	Description
id	string		The UUID for the analysis type.
name	string		The name of the analysis type.
system_id	string		The kind of system the analysis should run on.

BatchStatus

Field	Type	Label	Description
total	int64
completed	int64
running	int64
submitted	int64

Top

analysis_requests.proto

AnalysisRecordList

Field	Type	Label	Description
header	header.Header
analyses	Analysis	repeated
error	svcerror.ServiceError

AnalysisRecordLookupRequest

Field	Type	Label	Description
analysis_id	string
external_id	string
user_id	string
username	string
header	header.Header
requesting_user	string

AnalysisRecordResponse

Field	Type	Label	Description
header	header.Header
analyses	Analysis	repeated
timestamp	string
total	int64
status_count	AnalysisRecordResponse.StatusCountRecord	repeated
error	svcerror.ServiceError

AnalysisRecordResponse.StatusCountRecord

Field	Type	Label	Description
count	int64
status	string

Top

analysis_status.proto

AnalysisStatus

Field	Type	Label	Description
header	header.Header
error	svcerror.ServiceError
job	AnalysisSubmission
version	int32
state	string
message	string
sent_on	string
sender	string

Top

analysis_submission.proto

AnalysisSubmission

Field	Type	Label	Description
app_description	string
app_id	string
app_name	string
archive_logs	bool
batch_id	string
condor_id	string
condor_log_path	string
create_output_subdir	bool
date_submitted	google.protobuf.Timestamp
date_started	google.protobuf.Timestamp
date_completed	google.protobuf.Timestamp
description	string
email	string
extra	Extra		read all about it
execution_target	string
exit_code	int32
failure_count	int64
failure_threshold	int64
file_metadata	FileMetadata	repeated	The - is used instead of _ for backwards compatibility.
filter_files	string	repeated
group	string
input_path_list_file	string
input_tickets_file	string
invocation_id	string		AKA the external ID.
irods_base	string
name	string
nfs_base	string
notify	bool
now_date	string
output_dir	string
output_dir_ticket	string
output_ticket_file	string
request_type	string
run_on_nfs	bool		The - is on purpose.
skip_parent_metadata	bool		The - is on purpose.
steps	Step	repeated
submission_date	string
submitter	string		Yup, the JSON name is completely different from the field name.
type	string
user_id	string
user_groups	string	repeated
user_home	string
wiki_url	string
config_file	string

Extra

Field	Type	Label	Description
ht_condor	HTCondorExtraInfo

FileMetadata

Field	Type	Label	Description
attribute	string
value	string
unit	string

HTCondorExtraInfo

Field	Type	Label	Description
extra_requirements	string

Job

Since protocol buffers don't have a way to alias messages, we're copying the Analysis definition into Job and deprecating it.

Field	Type	Label	Description
app_description	string
app_id	string
app_name	string
archive_logs	bool
batch_id	string
condor_id	string
condor_log_path	string
create_output_subdir	bool
date_submitted	google.protobuf.Timestamp
date_started	google.protobuf.Timestamp
date_completed	google.protobuf.Timestamp
description	string
email	string
extra	Extra		read all about it
execution_target	string
exit_code	int32
failure_count	int64
failure_threshold	int64
file_metadata	FileMetadata	repeated	The - is used instead of _ for backwards compatibility.
filter_files	string	repeated
group	string
input_path_list_file	string
input_tickets_file	string
invocation_id	string		AKA the external ID.
irods_base	string
name	string
nfs_base	string
notify	bool
now_date	string
output_dir	string
output_dir_ticket	string
output_ticket_file	string
request_type	string
run_on_nfs	bool		The - is on purpose.
skip_parent_metadata	bool		The - is on purpose.
steps	Step	repeated
submission_date	string
submitter	string		Yup, the JSON name is completely different from the field name.
type	string
user_id	string
user_groups	string	repeated
user_home	string
wiki_url	string
config_file	string

Step

Field	Type	Label	Description
component	Step.Component
config	Step.Config
type	string
stdin_path	string
stdout_path	string
stderr_path	string
log_file	string
environment	Step.EnvironmentEntry	repeated
input	Step.Input	repeated	It's really annoying, but this is singular for backwards compatibility.
output	Step.Output	repeated	It's really annoying, but this is singular for backwards compatibility.

Step.Component

Field	Type	Label	Description
container	containers.Container
type	string
name	string
location	string
description	string
time_limit	int32
restricted	bool
is_interactive	bool

Step.Config

Field	Type	Label	Description
params	Step.Param	repeated
inputs	Step.Input	repeated	Keep it singular in the JSON for backwards-compatibility.
outputs	Step.Output	repeated	Keep it singular in the JSON for backwards-compatibility.

Step.EnvironmentEntry

Field	Type	Label	Description
key	string
value	string

Step.Input

Field	Type	Label	Description
id	string
ticket	string
multiplicity	string
name	string
property	string
retain	bool
type	string
value	string

Step.Output

Field	Type	Label	Description
multiplicity	string
name	string
property	string
qual_id	string
retain	bool
type	string

Step.Param

Field	Type	Label	Description
id	string
name	string
value	string
order	int32
type	string
path	string

Scalar Value Types

| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | | double | | double | double | float | float64 | double | float | Float | | float | | float | float | float | float32 | float | float | Float | | int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | | uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | | uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | | sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | | fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | | fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | | sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | | bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | | string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | | bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |