package apsara.odps.cupid.protocol

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetSplits (GetSplitsRequest, GetSplitsResponse)

  cupid_subprocess_service.proto:13

  Get Splits Detail

  message GetSplitsRequest

  cupid_subprocess_service.proto:56

  • optional string inputTableHandle = 1

  message GetSplitsResponse

  cupid_subprocess_service.proto:61

  • repeated InputSplit inputSplits = 1

• rpc RegisterTableReader (RegisterTableReaderRequest, RegisterTableReaderResponse)

  cupid_subprocess_service.proto:16

  Subprocess Reader return

  message RegisterTableReaderRequest

  cupid_subprocess_service.proto:66

  • optional string inputTableHandle = 1

  • optional InputSplit inputSplit = 2

  message RegisterTableReaderResponse

  cupid_subprocess_service.proto:72

  • optional string schema = 1

  • optional string readIterator = 2

  • optional string partitionSchema = 3

• rpc RegisterTableWriter (RegisterTableWriterRequest, RegisterTableWriterResponse)

  cupid_subprocess_service.proto:19

  Subprocess Writer return

  message RegisterTableWriterRequest

  cupid_subprocess_service.proto:79

  • optional string outputTableHandle = 1

  • optional string projectName = 2

  • optional string tableName = 3

  • optional string attemptFileName = 4

  • optional string partSpec = 5

  • optional string schema = 6

  • optional string tableMetaFileName = 7

  message RegisterTableWriterResponse

  cupid_subprocess_service.proto:90

  • optional string subprocessWriteTableLabel = 1

• rpc CommitTableFiles (CommitTableFilesRequest, CommitTableFilesResponse)

  cupid_subprocess_service.proto:22

  Moving the open&close TMP files into staging Directory for further ddl action

  message CommitTableFilesRequest

  cupid_subprocess_service.proto:102

  • optional string outputTableHandle = 1

  • optional string projectName = 2

  • optional string tableName = 3

  • repeated CommitActionInfo commitActionInfos = 4

  message CommitTableFilesResponse

  cupid_subprocess_service.proto:110

  (message has no fields)

• rpc GetSplitsMeta (GetSplitsMetaRequest, GetSplitsMetaResponse)

  cupid_subprocess_service.proto:25

  Get Splits Meta

  message GetSplitsMetaRequest

  cupid_subprocess_service.proto:46

  • optional string inputTableHandle = 1

  message GetSplitsMetaResponse

  cupid_subprocess_service.proto:51

  • repeated InputSplitMeta inputSplitsMeta = 1

• rpc SplitTables (SplitTablesRequest, SplitTablesResponse)

  cupid_task_service.proto:15

  Split input tables into partitions for parallel read

  message SplitTablesRequest

  cupid_task_service.proto:53

  • optional string lookupName = 1

  • optional int32 splitSize = 2

  • optional int32 splitCount = 3

  • repeated TableInputInfo tableInputInfos = 4

  • optional string type = 5

  • optional bool allowNoColumns = 6

  • optional bool requireSplitMeta = 7

  message SplitTablesResponse

  cupid_task_service.proto:64

  • optional string inputTableHandle = 1

• rpc WriteTable (WriteTableRequest, WriteTableResponse)

  cupid_task_service.proto:19

  Prepare enviroment for write table, like direcotry creation and cap file preparation More like a openFile operation in FileSystem

  message WriteTableRequest

  cupid_task_service.proto:69

  • optional string lookupName = 1

    need to provide a running instanceId and the target project/table to WRITE

  • optional string projectName = 2

  • optional string tableName = 3

  • optional string type = 4

  message WriteTableResponse

  cupid_task_service.proto:78

  • optional string outputTableHandle = 1

• rpc CommitTable (CommitTableRequest, CommitTableResponse)

  cupid_task_service.proto:22

  Commit Table and do DDL

  message CommitTableRequest

  cupid_task_service.proto:83

  • optional string lookupName = 1

  • optional string outputTableHandle = 2

  • optional string projectName = 3

  • optional string tableName = 4

  • optional bool isOverWrite = 5

  • repeated string partSpecs = 6

  • repeated CommitFileList commitFileLists = 7

  message CommitTableResponse

  cupid_task_service.proto:94

  (message has no fields)

• rpc CloseOutputHandle (CloseOutputHandleRequest, CloseOutputHandleResponse)

  cupid_task_service.proto:25

  Close and clean up

  message CloseOutputHandleRequest

  cupid_task_service.proto:119

  • optional string lookupName = 1

  • optional string outputTableHandle = 2

  message CloseOutputHandleResponse

  cupid_task_service.proto:125

  (message has no fields)

• rpc PutOrCreateClusterKv (PutOrCreateClusterKvRequest, PutOrCreateClusterKvResponse)

  cupid_task_service.proto:28

  CLusterKV meta Ops

  message PutOrCreateClusterKvRequest

  cupid_task_service.proto:135

  • optional string projectName = 1

  • optional string key = 2

  • optional string value = 3

  message PutOrCreateClusterKvResponse

  cupid_task_service.proto:142

  (message has no fields)

• rpc DeleteClusterKv (DeleteClusterKvRequest, DeleteClusterKvResponse)

  cupid_task_service.proto:29

  message DeleteClusterKvRequest

  cupid_task_service.proto:147

  • optional string projectName = 1

  • optional string key = 2

  message DeleteClusterKvResponse

  cupid_task_service.proto:153

  (message has no fields)

• rpc GetClusterKv (GetClusterKvRequest, GetClusterKvResponse)

  cupid_task_service.proto:30

  message GetClusterKvRequest

  cupid_task_service.proto:158

  • optional string projectName = 1

  • optional string key = 2

  message GetClusterKvResponse

  cupid_task_service.proto:164

  • optional string value = 1

• rpc ListByPrefixClusterKv (ListByPrefixClusterKvRequest, ListByPrefixClusterKvResponse)

  cupid_task_service.proto:31

  message ListByPrefixClusterKvRequest

  cupid_task_service.proto:169

  • optional string projectName = 1

  • optional string prefix = 2

  message ListByPrefixClusterKvResponse

  cupid_task_service.proto:175

  • repeated ClusterKv clusterKv = 1

• rpc GetTableMeta (GetTableMetaRequest, GetTableMetaResponse)

  cupid_task_service.proto:34

  Get Table Meta

  message GetTableMetaRequest

  cupid_task_service.proto:105

  • optional string lookupName = 1

  • optional TableInfo tableInfo = 2

  • optional bool needContent = 3

  • optional string uploadFile = 4

  message GetTableMetaResponse

  cupid_task_service.proto:113

  • optional string getTableMetaHandle = 1

  • optional string getTableMetaContent = 2

• rpc GetCupidProxyToken (CupidProxyTokenRequest, CupidProxyTokenResponse)

  cupid_task_service.proto:37

  Get proxy infos

  message CupidProxyTokenResponse

  cupid_task_service.proto:180

  • optional string token = 1

• rpc GetCupidProxyAppNames (CupidProxyAppNamesRequest, CupidProxyAppNamesResponse)

  cupid_task_service.proto:38

  message CupidProxyAppNamesRequest

  cupid_task_service.proto:185

  • optional string instanceId = 1

  message CupidProxyAppNamesResponse

  cupid_task_service.proto:190

  • repeated string names = 1

• rpc Put (PutRequest, PutResponse)

  kv_store_service.proto:10

  message PutRequest

  kv_store_service.proto:15

  • optional string key = 1

  • optional bytes value = 2

  message PutResponse

  kv_store_service.proto:21

  (message has no fields)

• rpc Get (GetRequest, GetResponse)

  kv_store_service.proto:12

  message GetRequest

  kv_store_service.proto:25

  • optional string value = 1

  message GetResponse

  kv_store_service.proto:30

  • optional bytes value = 1

• rpc Prepare (ChildEnv, ChildEnv)

  cupid_process_service.proto:23

  message ChildEnv

  cupid_process_service.proto:16

  • repeated EnvEntry entries = 1

Used in: ApplicationMetaList, UpdateApplicationMetaInfo

• optional string project = 1

• optional string instanceId = 2

• optional string applicationId = 3

• optional string applicationTags = 4

• optional string runningMode = 5

• optional string applicationType = 6

• optional int64 yarnApplicationState = 7

• optional int64 finalApplicationStatus = 8

• optional string originalTrackingUrl = 9

• optional string trackingUrl = 10

• optional string diagnostics = 11

• optional string applicationName = 12

• optional uint64 startedTime = 13

• optional uint64 finishedTime = 14

• repeated SubApplicationMeta subAppMetas = 15

• repeated ApplicationMeta applicationMetaList = 1

Used in: Failed

• required string bizFailedMsg = 1

Used in: CupidTaskDetailResultParam

(message has no fields)

Used in: ListByPrefixClusterKvResponse

• optional string key = 1

• optional string value = 2

Used in: CommitTableFilesRequest

• optional string partSpec = 1

• optional string attemptFileName = 2

• optional string commitFileName = 3

Used in: CommitFileList

• optional string fileName = 1

• optional int32 bucketId = 2

Used in: CommitTableRequest, DDLMultiTableInfoItem

• repeated CommitFile fileEntries = 1

Used in: CupidTaskParam

• optional string applicationId = 1

• optional string instanceId = 2

• optional string applicationTags = 3

• optional string applicationType = 4

• optional string runningMode = 5

• optional string applicationName = 6

Used as request type in: CupidTaskService.GetCupidProxyToken

Used as field type in: CupidTaskParam

• optional string instanceId = 1

• optional string appName = 2

• optional int32 expiredInHours = 3

Used in: CupidTaskParam

• optional string instanceId = 1

• optional string key = 2

• optional string value = 3

• optional Ready ready = 1

• optional Waiting waiting = 2

• optional Running running = 3

• optional Success success = 4

• optional Failed failed = 5

• optional Cancelled cancelled = 6

• optional WaitForReRun waitForReRun = 7

Used in: Failed

• required string cupidTaskFailedMsg = 1

Used in: CupidTaskParam

• required string moperator = 1

• optional string mlookupName = 2

• optional string menginetype = 3

• required CupidTaskOperator mcupidtaskoperator = 1

• optional JobConf jobconf = 2

• optional OdpsLocalResource localresource = 3

• optional PartitionSizeInfo partitionsizeinfo = 4

• optional DDLInfo ddlInfo = 5

• optional SaveTableInfo saveTableInfo = 6

• optional GenVolumePanguPathInfo genVolumePanguPathInfo = 7

• optional DDLMultiTableInfos ddlMultiTableInfos = 8

• optional MultiTablesInputInfos multiTablesInputInfos = 9

• optional GetApplicationMetaInfo getApplicationMetaInfo = 10

• optional CreateApplicationMetaInfo createApplicationMetaInfo = 11

• optional ListApplicationMetaInfo listApplicationMetaInfo = 12

• optional UpdateApplicationMetaInfo updateApplicationMetaInfo = 13

• optional CupidSetInformation cupidSetInformation = 14

• optional CupidProxyTokenRequest cupidProxyTokenRequest = 15

• optional TaskServiceRequest taskServiceRequest = 16

Used in: CupidTaskParam

• required string saveTableName = 1

• required string saveTableProject = 2

• optional bool isOverWrite = 3

• repeated DDLInfoIterm ddlInfoIterms = 4

Used in: DDLInfo

• required string partSpec = 1

• required string panguTempDirPath = 2

Used in: DDLMultiTableInfos

• required string saveTableName = 1

• required string saveTableProject = 2

• optional string panguTempDirSuffix = 3

• optional string partSpec = 4

• optional bool isOverWrite = 5

• optional CommitFileList fileList = 6

Used in: CupidTaskParam

• repeated DDLMultiTableInfoItem ddlMultiTableInfoItems = 1

Used in: ChildEnv

• optional string name = 1

• optional string value = 2

Used in: CupidTaskDetailResultParam

• optional BizFailed bizFailed = 1

• optional CupidTaskFailed cupidTaskFailed = 2

Used in: CupidTaskParam

• optional string odpsvolumepath = 1

Used in: CupidTaskParam

• optional string applicationId = 1

• optional string instanceId = 2

• optional int64 size = 1

• optional string splitTempDir = 2

• repeated SplitItem split_item = 3

Used in: GetSplitsResponse, RegisterTableReaderRequest

• optional uint32 splitIndexId = 1

• optional uint64 splitFileStart = 2

• optional uint64 splitFileEnd = 3

• optional uint64 schemaFileStart = 4

• optional uint64 schemaFileEnd = 5

• optional string project = 6

• optional string table = 7

• optional string partitionSpec = 8

Used in: GetSplitsMetaResponse

• optional uint64 rowCount = 1

• optional uint64 rawSize = 2

Used in: CupidTaskParam

• repeated JobConfItem jobconfitem = 1

Used in: JobConf

• required string key = 1

• required string value = 2

Used in: CupidTaskParam

• optional string applicationTypes = 1

• optional string yarnApplicationStates = 2

Used in: OdpsLocalResourceItem

• TempResource = 1

• Volume = 2

• Resource = 3

Used in: MultiTablesInputInfos

• required string projName = 1

• required string tblName = 2

• optional string cols = 3

• optional string schema = 4

• optional string partSpecs = 5

Used in: CupidTaskParam

• optional int32 splitSize = 1

• optional int32 splitCount = 2

• repeated MultiTablesInputInfoItem multiTablesInputInfoItem = 3

• optional string splitTempDir = 4

• optional bool require_split_info = 5

• optional int32 inputId = 6

Used in: CupidTaskParam

• repeated OdpsLocalResourceItem localresourceitem = 1

Used in: OdpsLocalResource

• optional string projectname = 1

• required string relativefilepath = 2

• required LocalResourceType type = 3

Used in: CupidTaskParam

• required string projName = 1

• required string tblName = 2

• repeated string cols = 3

• optional string schema = 4

• optional int32 splitSize = 5

• optional int32 splitCount = 6

• repeated string partSpecs = 7

• optional int32 odpsRdtId = 8

• optional string splitTempDir = 9

Used in: CupidTaskDetailResultParam

(message has no fields)

Used in: CupidTaskDetailResultParam

• required string runningMsg = 1

Used in: CupidTaskParam

• required string projectname = 1

• required string saveid = 2

• optional string tablename = 3

Used in: GetPartitionSizeResult

• optional uint32 partitionid = 1

• optional uint64 splitfilestart = 2

• optional uint64 splitfileend = 3

• optional uint64 schemafilestart = 4

• optional uint64 schemafileend = 5

Used in: ApplicationMeta

• optional string appName = 1

  might be more field to store appName must be unique within a cupid instance

• optional string trackingUrl = 2

Used in: CupidTaskDetailResultParam

• required string successMsg = 1

Used in: GetTableMetaRequest

• optional string projectName = 1

• optional string tableName = 2

Used in: SplitTablesRequest

• optional string projectName = 1

  InputDef represent a InputSplit query unit PartitionTable: (project, table, partitionSpec) NonPartitionTable: (project, table)

• optional string tableName = 2

• optional string columns = 3

• optional string partSpec = 4

• optional int32 bucketId = 5

Used in: CupidTaskParam

• optional string methodName = 1

• optional bytes requestInBytes = 2

Used in: CupidTaskParam

• optional string applicationId = 1

• optional ApplicationMeta applicationMeta = 2

• optional string instanceId = 3

Used in: CupidTaskDetailResultParam

• optional string waitMsg = 1

Used in: CupidTaskDetailResultParam

(message has no fields)