package com.netflix.genie.proto

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc sync (stream AgentManifestMessage, stream ServerControlMessage)

  genie.proto:321

  message AgentManifestMessage

  genie.proto:325

  • string job_id = 1

  • string manifest_json = 2

  • bool large_files_supported = 3

    To be removed once all agents are running a recent version

  message ServerControlMessage

  genie.proto:331

  • oneof message

    • ServerFileRequestMessage server_file_request = 1

• rpc transmit (stream AgentFileMessage, stream ServerAckMessage)

  genie.proto:322

  message AgentFileMessage

  genie.proto:346

  • string stream_id = 1

  • bytes data = 2

  message ServerAckMessage

  genie.proto:351

  (message has no fields)

• rpc heartbeat (stream AgentHeartBeat, stream ServerHeartBeat)

  genie.proto:284

  message AgentHeartBeat

  genie.proto:287

  • string claimed_job_id = 1

  message ServerHeartBeat

  genie.proto:291

  (message has no fields)

• rpc registerForKillNotification (JobKillRegistrationRequest, JobKillRegistrationResponse)

  genie.proto:304

  message JobKillRegistrationRequest

  genie.proto:307

  • string job_id = 1

  message JobKillRegistrationResponse

  genie.proto:311

  (message has no fields)

-------------------------------------------------------------------- Job Service This service handles all functional protocols between agent and server required to successfully execute a job. From reserving an ID to resolving and retrieving a job specification, to job state updates. --------------------------------------------------------------------

• rpc handshake (HandshakeRequest, HandshakeResponse)

  genie.proto:46

  message HandshakeRequest

  genie.proto:101

  • optional AgentMetadata agent_metadata = 1

  message HandshakeResponse

  genie.proto:105

  • HandshakeResponse.Type type = 1

  • string message = 2

• rpc configure (ConfigureRequest, ConfigureResponse)

  genie.proto:47

  message ConfigureRequest

  genie.proto:259

  • optional AgentMetadata agent_metadata = 1

  message ConfigureResponse

  genie.proto:263

  • map<string, string> properties = 1

• rpc reserveJobId (ReserveJobIdRequest, ReserveJobIdResponse)

  genie.proto:48

  message ReserveJobIdRequest

  genie.proto:117

  • optional JobMetadata metadata = 1

  • optional ExecutionResourceCriteria criteria = 2

  • optional AgentConfig agent_config = 3

  • optional AgentMetadata agent_metadata = 4

  • optional JobArchivalData job_archival_data = 5

  message ReserveJobIdResponse

  genie.proto:136

  • oneof response

    • string id = 1

    • ReserveJobIdError error = 2

• rpc resolveJobSpecification (JobSpecificationRequest, JobSpecificationResponse)

  genie.proto:49

• rpc getJobSpecification (JobSpecificationRequest, JobSpecificationResponse)

  genie.proto:50

• rpc resolveJobSpecificationDryRun (DryRunJobSpecificationRequest, JobSpecificationResponse)

  genie.proto:51

  message DryRunJobSpecificationRequest

  genie.proto:147

  • optional JobMetadata metadata = 1

  • optional ExecutionResourceCriteria criteria = 2

  • optional AgentConfig agent_config = 3

  • optional JobArchivalData job_archival_data = 4

• rpc claimJob (ClaimJobRequest, ClaimJobResponse)

  genie.proto:52

  message ClaimJobRequest

  genie.proto:206

  • string id = 1

  • optional AgentMetadata agent_metadata = 2

  message ClaimJobResponse

  genie.proto:223

  • bool successful = 1

  • optional ClaimJobError error = 2

• rpc changeJobStatus (ChangeJobStatusRequest, ChangeJobStatusResponse)

  genie.proto:53

  message ChangeJobStatusRequest

  genie.proto:228

  • string id = 1

  • string current_status = 2

  • string new_status = 3

  • string new_status_message = 4

  message ChangeJobStatusResponse

  genie.proto:246

  • bool successful = 1

  • optional ChangeJobStatusError error = 2

• rpc getJobStatus (GetJobStatusRequest, GetJobStatusResponse)

  genie.proto:54

  message GetJobStatusRequest

  genie.proto:251

  • string id = 1

  message GetJobStatusResponse

  genie.proto:255

  • string status = 1

• rpc changeJobArchiveStatus (ChangeJobArchiveStatusRequest, ChangeJobArchiveStatusResponse)

  genie.proto:55

  message ChangeJobArchiveStatusRequest

  genie.proto:267

  • string id = 1

  • string new_status = 2

  message ChangeJobArchiveStatusResponse

  genie.proto:272

  (message has no fields)

-------------------------------------------------------------------- Ping Service This service provides a simple ping-pong protocol between a client and a server, it can be used to test connectivity. --------------------------------------------------------------------

• rpc ping (PingRequest, PongResponse)

  genie.proto:19

  message PingRequest

  genie.proto:23

  The Ping request with client metadata.

  • string request_id = 1

  • string source_name = 2

  • optional google.protobuf.Timestamp timestamp = 3

  • map<string, string> client_metadata = 4

  message PongResponse

  genie.proto:31

  The server response with server metadata.

  • string request_id = 1

  • optional google.protobuf.Timestamp timestamp = 2

  • map<string, string> server_metadata = 3

Used in: DryRunJobSpecificationRequest, ReserveJobIdRequest

• bool is_interactive = 1

• string job_directory_location = 2

• optional google.protobuf.Int32Value timeout = 3

  Requested timeout in seconds

• bool archiving_disabled = 4

Used in: ClaimJobRequest, ConfigureRequest, HandshakeRequest, ReserveJobIdRequest

• string agent_version = 1

• string agent_hostname = 2

• int32 agent_pid = 3

Used in: ChangeJobStatusResponse

• ChangeJobStatusError.Type type = 1

• string message = 2

Used in: ChangeJobStatusError

• UNKNOWN = 0

• INVALID_REQUEST = 1

• INCORRECT_CURRENT_STATUS = 2

• NO_SUCH_JOB = 3

Used in: ClaimJobResponse

• ClaimJobError.Type type = 1

• string message = 2

Used in: ClaimJobError

• UNKNOWN = 0

• ALREADY_CLAIMED = 1

• NO_SUCH_JOB = 2

• INVALID_REQUEST = 3

• INVALID_STATUS = 4

Used in: ExecutionResourceCriteria

• repeated string tags = 1

• string id = 2

• string name = 3

• string status = 4

• string version = 5

Used in: JobSpecification

• string id = 1

• string setup_file = 2

• repeated string configs = 3

• repeated string dependencies = 4

Used in: DryRunJobSpecificationRequest, ReserveJobIdRequest

• repeated Criterion cluster_criteria = 1

• optional Criterion command_criterion = 2

• repeated string requested_application_id_overrides = 3

Used in: HandshakeResponse

• UNKNOWN = 0

• ALLOWED = 1

• REJECTED = 2

• SERVER_ERROR = 3

• INVALID_REQUEST = 4

Used in: DryRunJobSpecificationRequest, ReserveJobIdRequest

• string requested_archive_location_prefix = 1

Used in: DryRunJobSpecificationRequest, ReserveJobIdRequest

• string id = 1

• string name = 2

• string user = 3

• string version = 4

• string description = 5

• repeated string tags = 6

• string metadata = 7

• string email = 8

• string grouping = 9

• string grouping_instance = 10

• string setup_file = 11

• repeated string configs = 12

• repeated string dependencies = 13

• repeated string command_args = 14

Used in: JobSpecificationResponse

• repeated string command_args = 1

  Deprecated by fields 11 & 12. Populated for backward compatibility.

• optional ExecutionResource job = 2

• optional ExecutionResource cluster = 3

• optional ExecutionResource command = 4

• repeated ExecutionResource applications = 5

• map<string, string> environment_variables = 6

• bool is_interactive = 7

• string job_directory_location = 8

• string archive_location = 9

• optional google.protobuf.Int32Value timeout = 10

  Optional number of seconds from start when the job should timeout

• repeated string executable_and_args = 11

• repeated string job_args = 12

Used in: JobSpecificationResponse

• JobSpecificationError.Type type = 1

• string message = 2

Used in: JobSpecificationError

• UNKNOWN = 0

• NO_CLUSTER_FOUND = 1

• NO_COMMAND_FOUND = 2

• NO_APPLICATION_FOUND = 3

• NO_JOB_FOUND = 4

• NO_SPECIFICATION_FOUND = 5

• INVALID_REQUEST = 6

• RESOLUTION_FAILED = 7

• RUNTIME_ERROR = 8

Used as request type in: JobService.getJobSpecification, JobService.resolveJobSpecification

• string id = 1

Used as response type in: JobService.getJobSpecification, JobService.resolveJobSpecification, JobService.resolveJobSpecificationDryRun

• oneof response

  • JobSpecification specification = 1

  • JobSpecificationError error = 2

Used in: ReserveJobIdResponse

• ReserveJobIdError.Type type = 1

• string message = 2

Used in: ReserveJobIdError

• UNKNOWN = 0

• ID_NOT_AVAILABLE = 1

• INVALID_REQUEST = 2

• SERVER_ERROR = 3

Used in: ServerControlMessage

• string stream_id = 1

• string relative_path = 2

• int32 deprecated_start_offset = 3

• int32 deprecated_end_offset = 4

• int64 start_offset = 5

• int64 end_offset = 6