usage.proto

path mgmt/v1alpha1/usage.proto

package mgmt.v1alpha1

---

Messages

RecordRunEndedRequest

Name	Type	Description
job_id	string	The job the run belongs to. The account and the kind of the run are read from it.
run_id	string	The identifier of the run, as the orchestrator gives it.
started_at	google.protobuf.Timestamp	When the run began.
ended_at	google.protobuf.Timestamp	When the run ended.
outcome	RunOutcome	How the run ended.
rows_read	int64	The rows the run read from its source.
rows_discarded	int64	The rows the run set aside instead of writing them.
retries	int64	The times the run's activities were tried again.

RecordRunEndedResponse

Name	Type	Description

RecordRunStartedRequest

Name	Type	Description
job_id	string	The job the run belongs to. The account and the kind of the run are read from it.
run_id	string	The identifier of the run, as the orchestrator gives it.
started_at	google.protobuf.Timestamp	When the run began.

RecordRunStartedResponse

Name	Type	Description

---

Enums

RunOutcome

How a run ended.

Name	Number	Description
RUN_OUTCOME_UNSPECIFIED	0
RUN_OUTCOME_COMPLETED	1	The run finished its work.
RUN_OUTCOME_FAILED	2	The run stopped on an error.
RUN_OUTCOME_CANCELED	3	The run was told to stop.

---

Services

UsageService

Holds the counters of what the instance runs.

RecordRunStarted

Method	RecordRunStarted
Request	RecordRunStartedRequest
Response	RecordRunStartedResponse
Description	Tells that a run has begun. Only the worker calls this, with its key.

RecordRunEnded

Method	RecordRunEnded
Request	RecordRunEndedRequest
Response	RecordRunEndedResponse
Description	Tells that a run has ended, and what it did. Only the worker calls this, with its key.

---