Skip to main content

`job.proto`

path mgmt/v1alpha1/job.proto

package mgmt.v1alpha1

Messages

`ActivityFailure`

Name	Type	Description
`message`	`string`

`AwsS3DestinationConnectionOptions`

Name	Type	Description

`AwsS3SourceConnectionOptions`

Name	Type	Description
`connection_id`	`string`

`CancelJobRunRequest`

Name	Type	Description
`job_run_id`	`string`
`account_id`	`string`

`CancelJobRunResponse`

Name	Type	Description

`CreateJobDestination`

Name	Type	Description
`connection_id`	`string`
`options`	`JobDestinationOptions`

`CreateJobDestinationConnectionsRequest`

Name	Type	Description
`job_id`	`string`
`destinations`	repeated `CreateJobDestination`

`CreateJobDestinationConnectionsResponse`

Name	Type	Description
`job`	`Job`

`CreateJobRequest`

Name	Type	Description
`account_id`	`string`
`job_name`	`string`
`cron_schedule`	optional `string`
`mappings`	repeated `JobMapping`
`source`	`JobSource`
`destinations`	repeated `CreateJobDestination`
`initiate_job_run`	`bool`

`CreateJobResponse`

Name	Type	Description
`job`	`Job`

`CreateJobRunRequest`

Name	Type	Description
`job_id`	`string`

`CreateJobRunResponse`

Name	Type	Description

`DeleteJobDestinationConnectionRequest`

Name	Type	Description
`destination_id`	`string`

`DeleteJobDestinationConnectionResponse`

Name	Type	Description

`DeleteJobRequest`

Name	Type	Description
`id`	`string`

`DeleteJobResponse`

Name	Type	Description

`DeleteJobRunRequest`

Name	Type	Description
`job_run_id`	`string`
`account_id`	`string`

`DeleteJobRunResponse`

Name	Type	Description

`GenerateSourceOptions`

Name	Type	Description
`schemas`	repeated `GenerateSourceSchemaOption`
`fk_source_connection_id`	optional `string`

`GenerateSourceSchemaOption`

Name	Type	Description
`schema`	`string`
`tables`	repeated `GenerateSourceTableOption`

`GenerateSourceTableOption`

Name	Type	Description
`table`	`string`
`row_count`	`int64`

`GetJobNextRunsRequest`

Name	Type	Description
`job_id`	`string`

`GetJobNextRunsResponse`

Name	Type	Description
`next_runs`	`JobNextRuns`

`GetJobRecentRunsRequest`

Name	Type	Description
`job_id`	`string`

`GetJobRecentRunsResponse`

Name	Type	Description
`recent_runs`	repeated `JobRecentRun`

`GetJobRequest`

Name	Type	Description
`id`	`string`

`GetJobResponse`

Name	Type	Description
`job`	`Job`

`GetJobRunEventsRequest`

Name	Type	Description
`job_run_id`	`string`
`account_id`	`string`

`GetJobRunEventsResponse`

Name	Type	Description
`events`	repeated `JobRunEvent`
`is_run_complete`	`bool`

`GetJobRunRequest`

Name	Type	Description
`job_run_id`	`string`
`account_id`	`string`

`GetJobRunResponse`

Name	Type	Description
`job_run`	`JobRun`

`GetJobRunsRequest`

Name	Type	Description
`job_id`	`string`
`account_id`	`string`

`GetJobRunsResponse`

Name	Type	Description
`job_runs`	repeated `JobRun`

`GetJobStatusRequest`

Name	Type	Description
`job_id`	`string`

`GetJobStatusResponse`

Name	Type	Description
`status`	`JobStatus`

`GetJobStatusesRequest`

Name	Type	Description
`account_id`	`string`

`GetJobStatusesResponse`

Name	Type	Description
`statuses`	repeated `JobStatusRecord`

`GetJobsRequest`

Name	Type	Description
`account_id`	`string`

`GetJobsResponse`

Name	Type	Description
`jobs`	repeated `Job`

`IsJobNameAvailableRequest`

Name	Type	Description
`name`	`string`
`account_id`	`string`

`IsJobNameAvailableResponse`

Name	Type	Description
`is_available`	`bool`

`Job`

Name	Type	Description
`id`	`string`
`created_by_user_id`	`string`
`created_at`	`google.protobuf.Timestamp`
`updated_by_user_id`	`string`
`updated_at`	`google.protobuf.Timestamp`
`name`	`string`
`source`	`JobSource`
`destinations`	repeated `JobDestination`
`mappings`	repeated `JobMapping`
`cron_schedule`	optional `string`
`account_id`	`string`

`JobDestination`

Name	Type	Description
`connection_id`	`string`
`options`	`JobDestinationOptions`
`id`	`string`

`JobDestinationOptions`

Name	Type	Description
`postgres_options`	`PostgresDestinationConnectionOptions`
`aws_s3_options`	`AwsS3DestinationConnectionOptions`
`mysql_options`	`MysqlDestinationConnectionOptions`

`JobMapping`

Name	Type	Description
`schema`	`string`
`table`	`string`
`column`	`string`
`transformer`	`JobMappingTransformer`

`JobMappingTransformer`

Name	Type	Description
`source`	`string`
`config`	`TransformerConfig`

`JobNextRuns`

Name	Type	Description
`next_run_times`	repeated `google.protobuf.Timestamp`

`JobRecentRun`

Name	Type	Description
`start_time`	`google.protobuf.Timestamp`
`job_run_id`	`string`

`JobRun`

Name	Type	Description
`id`	`string`
`job_id`	`string`
`name`	`string`
`status`	`JobRunStatus`
`started_at`	`google.protobuf.Timestamp`
`completed_at`	optional `google.protobuf.Timestamp`
`pending_activities`	repeated `PendingActivity`

`JobRunEvent`

Name	Type	Description
`id`	`int64`
`type`	`string`
`start_time`	`google.protobuf.Timestamp`
`close_time`	`google.protobuf.Timestamp`
`metadata`	`JobRunEventMetadata`
`tasks`	repeated `JobRunEventTask`

`JobRunEventMetadata`

Name	Type	Description
`sync_metadata`	`JobRunSyncMetadata`

`JobRunEventTask`

Name	Type	Description
`id`	`int64`
`type`	`string`
`event_time`	`google.protobuf.Timestamp`
`error`	`JobRunEventTaskError`

`JobRunEventTaskError`

Name	Type	Description
`message`	`string`
`retry_state`	`string`

`JobRunSyncMetadata`

Name	Type	Description
`schema`	`string`
`table`	`string`

`JobSource`

Name	Type	Description
`options`	`JobSourceOptions`

`JobSourceOptions`

Name	Type	Description
`postgres`	`PostgresSourceConnectionOptions`
`aws_s3`	`AwsS3SourceConnectionOptions`
`mysql`	`MysqlSourceConnectionOptions`
`generate`	`GenerateSourceOptions`

`JobSourceSqlSubetSchemas`

Name	Type	Description
`postgres_subset`	`PostgresSourceSchemaSubset`
`mysql_subset`	`MysqlSourceSchemaSubset`

`JobStatusRecord`

Name	Type	Description
`job_id`	`string`
`status`	`JobStatus`

`MysqlDestinationConnectionOptions`

Name	Type	Description
`truncate_table`	`MysqlTruncateTableConfig`
`init_table_schema`	`bool`

`MysqlSourceConnectionOptions`

Name	Type	Description
`halt_on_new_column_addition`	`bool`
`schemas`	repeated `MysqlSourceSchemaOption`
`connection_id`	`string`

`MysqlSourceSchemaOption`

Name	Type	Description
`schema`	`string`
`tables`	repeated `MysqlSourceTableOption`

`MysqlSourceSchemaSubset`

Name	Type	Description
`mysql_schemas`	repeated `MysqlSourceSchemaOption`

`MysqlSourceTableOption`

Name	Type	Description
`table`	`string`
`where_clause`	optional `string`

`MysqlTruncateTableConfig`

Name	Type	Description
`truncate_before_insert`	`bool`

`PauseJobRequest`

Name	Type	Description
`id`	`string`
`pause`	`bool`
`note`	optional `string`

`PauseJobResponse`

Name	Type	Description
`job`	`Job`

`PendingActivity`

Name	Type	Description
`status`	`ActivityStatus`
`activity_name`	`string`
`last_failure`	optional `ActivityFailure`

`PostgresDestinationConnectionOptions`

Name	Type	Description
`truncate_table`	`PostgresTruncateTableConfig`
`init_table_schema`	`bool`

`PostgresSourceConnectionOptions`

Name	Type	Description
`halt_on_new_column_addition`	`bool`
`schemas`	repeated `PostgresSourceSchemaOption`
`connection_id`	`string`

`PostgresSourceSchemaOption`

Name	Type	Description
`schema`	`string`
`tables`	repeated `PostgresSourceTableOption`

`PostgresSourceSchemaSubset`

Name	Type	Description
`postgres_schemas`	repeated `PostgresSourceSchemaOption`

`PostgresSourceTableOption`

Name	Type	Description
`table`	`string`
`where_clause`	optional `string`

`PostgresTruncateTableConfig`

Name	Type	Description
`truncate_before_insert`	`bool`
`cascade`	`bool`

`SetJobSourceSqlConnectionSubsetsRequest`

Name	Type	Description
`id`	`string`
`schemas`	`JobSourceSqlSubetSchemas`

`SetJobSourceSqlConnectionSubsetsResponse`

Name	Type	Description
`job`	`Job`

`TerminateJobRunRequest`

Name	Type	Description
`job_run_id`	`string`
`account_id`	`string`

`TerminateJobRunResponse`

Name	Type	Description

`UpdateJobDestinationConnectionRequest`

Name	Type	Description
`job_id`	`string`
`connection_id`	`string`
`options`	`JobDestinationOptions`
`destination_id`	`string`

`UpdateJobDestinationConnectionResponse`

Name	Type	Description
`job`	`Job`

`UpdateJobScheduleRequest`

Name	Type	Description
`id`	`string`
`cron_schedule`	optional `string`

`UpdateJobScheduleResponse`

Name	Type	Description
`job`	`Job`

`UpdateJobSourceConnectionRequest`

Name	Type	Description
`id`	`string`
`source`	`JobSource`
`mappings`	repeated `JobMapping`

`UpdateJobSourceConnectionResponse`

Name	Type	Description
`job`	`Job`

Enums

`ActivityStatus`

Name	Number	Description
`ACTIVITY_STATUS_UNSPECIFIED`	`0`
`ACTIVITY_STATUS_SCHEDULED`	`1`
`ACTIVITY_STATUS_STARTED`	`2`
`ACTIVITY_STATUS_CANCELED`	`3`
`ACTIVITY_STATUS_FAILED`	`4`

`JobRunStatus`

Name	Number	Description
`JOB_RUN_STATUS_UNSPECIFIED`	`0`
`JOB_RUN_STATUS_PENDING`	`1`
`JOB_RUN_STATUS_RUNNING`	`2`
`JOB_RUN_STATUS_COMPLETE`	`3`
`JOB_RUN_STATUS_ERROR`	`4`
`JOB_RUN_STATUS_CANCELED`	`5`
`JOB_RUN_STATUS_TERMINATED`	`6`
`JOB_RUN_STATUS_FAILED`	`7`

`JobStatus`

Name	Number	Description
`JOB_STATUS_UNSPECIFIED`	`0`
`JOB_STATUS_ENABLED`	`1`
`JOB_STATUS_PAUSED`	`3`
`JOB_STATUS_DISABLED`	`4`

Services

`JobService`

`GetJobs`

Method	`GetJobs`
Request	`GetJobsRequest`
Response	`GetJobsResponse`
Description

`GetJob`

Method	`GetJob`
Request	`GetJobRequest`
Response	`GetJobResponse`
Description

`CreateJob`

Method	`CreateJob`
Request	`CreateJobRequest`
Response	`CreateJobResponse`
Description

`DeleteJob`

Method	`DeleteJob`
Request	`DeleteJobRequest`
Response	`DeleteJobResponse`
Description

`IsJobNameAvailable`

Method	`IsJobNameAvailable`
Request	`IsJobNameAvailableRequest`
Response	`IsJobNameAvailableResponse`
Description

`UpdateJobSchedule`

Method	`UpdateJobSchedule`
Request	`UpdateJobScheduleRequest`
Response	`UpdateJobScheduleResponse`
Description

`UpdateJobSourceConnection`

Method	`UpdateJobSourceConnection`
Request	`UpdateJobSourceConnectionRequest`
Response	`UpdateJobSourceConnectionResponse`
Description

`SetJobSourceSqlConnectionSubsets`

Method	`SetJobSourceSqlConnectionSubsets`
Request	`SetJobSourceSqlConnectionSubsetsRequest`
Response	`SetJobSourceSqlConnectionSubsetsResponse`
Description

`UpdateJobDestinationConnection`

Method	`UpdateJobDestinationConnection`
Request	`UpdateJobDestinationConnectionRequest`
Response	`UpdateJobDestinationConnectionResponse`
Description

`DeleteJobDestinationConnection`

Method	`DeleteJobDestinationConnection`
Request	`DeleteJobDestinationConnectionRequest`
Response	`DeleteJobDestinationConnectionResponse`
Description

`CreateJobDestinationConnections`

Method	`CreateJobDestinationConnections`
Request	`CreateJobDestinationConnectionsRequest`
Response	`CreateJobDestinationConnectionsResponse`
Description

`PauseJob`

Method	`PauseJob`
Request	`PauseJobRequest`
Response	`PauseJobResponse`
Description

`GetJobRecentRuns`

Method	`GetJobRecentRuns`
Request	`GetJobRecentRunsRequest`
Response	`GetJobRecentRunsResponse`
Description

`GetJobNextRuns`

Method	`GetJobNextRuns`
Request	`GetJobNextRunsRequest`
Response	`GetJobNextRunsResponse`
Description

`GetJobStatus`

Method	`GetJobStatus`
Request	`GetJobStatusRequest`
Response	`GetJobStatusResponse`
Description

`GetJobStatuses`

Method	`GetJobStatuses`
Request	`GetJobStatusesRequest`
Response	`GetJobStatusesResponse`
Description

`GetJobRuns`

Method	`GetJobRuns`
Request	`GetJobRunsRequest`
Response	`GetJobRunsResponse`
Description

`GetJobRunEvents`

Method	`GetJobRunEvents`
Request	`GetJobRunEventsRequest`
Response	`GetJobRunEventsResponse`
Description

`GetJobRun`

Method	`GetJobRun`
Request	`GetJobRunRequest`
Response	`GetJobRunResponse`
Description

`DeleteJobRun`

Method	`DeleteJobRun`
Request	`DeleteJobRunRequest`
Response	`DeleteJobRunResponse`
Description

`CreateJobRun`

Method	`CreateJobRun`
Request	`CreateJobRunRequest`
Response	`CreateJobRunResponse`
Description

`CancelJobRun`

Method	`CancelJobRun`
Request	`CancelJobRunRequest`
Response	`CancelJobRunResponse`
Description

`TerminateJobRun`

Method	`TerminateJobRun`
Request	`TerminateJobRunRequest`
Response	`TerminateJobRunResponse`
Description

Messages
Enums
Services
- JobService