Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

# 

# AIS ObjectIDs 

# 

from ion.core.object import object_utils 

 

# AIS GPBs from ion-object-definitions/net/ooici/integration/ais/ais_request_response.proto 

AIS_REQUEST_MSG_TYPE = object_utils.create_type_identifier(object_id=9001, version=1) 

AIS_RESPONSE_MSG_TYPE = object_utils.create_type_identifier(object_id=9002, version=1) 

AIS_RESPONSE_ERROR_TYPE = object_utils.create_type_identifier(object_id=9003, version=1) 

 

 

VALIDATE_DATASOURCE_REQ = object_utils.create_type_identifier(object_id=9010, version=1) 

VALIDATE_DATASOURCE_RSP = object_utils.create_type_identifier(object_id=9011, version=1) 

 

# AisDataResourceMetadata GPBs from ion-object-definitions/net/ooici/integration/ais/ais_data_resource_metadata.proto 

AIS_DATASET_METADATA_TYPE = object_utils.create_type_identifier(object_id=9021, version=1) 

""" 

message AisDatasetMetadata { 

   enum _MessageTypeIdentifier { 

       _ID = 9021; 

       _VERSION = 1; 

   } 

 

   optional string user_ooi_id      = 1; 

   optional string data_resource_id = 2; 

   optional string title            = 3; 

   optional string institution      = 4; 

   optional string source           = 5; 

   optional string references       = 6; 

   optional string conventions      = 7; 

   optional string summary          = 8; 

   optional string comment          = 9; 

   optional string ion_time_coverage_start = 10; 

   optional string ion_time_coverage_end   = 11; 

   optional double ion_geospatial_lat_min  = 12; 

   optional double ion_geospatial_lat_max  = 13; 

   optional double ion_geospatial_lon_min  = 14; 

   optional double ion_geospatial_lon_max  = 15; 

   optional double ion_geospatial_vertical_min      = 16; 

   optional double ion_geospatial_vertical_max      = 17; 

   optional string ion_geospatial_vertical_positive = 18; 

 

} 

""" 

 

AIS_DATASOURCE_METADATA_TYPE = object_utils.create_type_identifier(object_id=9022, version=1) 

""" 

message AisDatasourceMetadata { 

   enum _MessageTypeIdentifier { 

       _ID = 9022; 

       _VERSION = 1; 

   } 

 

   optional net.ooici.services.sa.SourceType source_type = 1; 

   repeated string property   = 2; 

   repeated string station_id = 3; 

 

   optional net.ooici.services.sa.RequestType request_type = 4; 

   optional double top    = 5; 

   optional double bottom = 6; 

   optional double left   = 7; 

   optional double right  = 8; 

   optional string base_url    = 9; 

   optional string dataset_url = 10; 

   optional string ncml_mask   = 11; 

   optional uint64 max_ingest_millis = 12; 

 

   //'start_time' and 'end_time' are expected to be in the 

   // ISO8601 Date Format (yyyy-MM-dd'T'HH:mm:ss'Z') 

   optional string start_time = 13; 

   optional string end_time   = 14; 

   optional string institution_id = 15; 

 

} 

""" 

 

# AisDataVariable GPBs from ion-object-definitions/net/ooici/integration/ais/ais_data_variable.proto 

AIS_DATA_VARIABLE_TYPE = object_utils.create_type_identifier(object_id=9023, version=1) 

""" 

message AisDataVariableType { 

   enum _MessageTypeIdentifier { 

       _ID = 9023; 

       _VERSION = 1; 

   } 

 

   optional string units         = 1; 

   optional string standard_name = 2; 

   optional string long_name     = 3; 

   repeated string other_attributes = 4; 

 

} 

""" 

 

# FindDataResources GPBs from ion-object-definitions/net/ooici/integration/ais/findDataResources/find_data_resources.proto 

FIND_DATA_RESOURCES_REQ_MSG_TYPE = object_utils.create_type_identifier(object_id=9031, version=1) 

""" 

message FindDataResourcesReqMsg { 

   enum _MessageTypeIdentifier { 

       _ID = 9031; 

       _VERSION = 1; 

   } 

 

   optional string user_ooi_id = 1; 

   optional double minLatitude = 2; 

   optional double maxLatitude = 3; 

   optional double minLongitude = 4; 

   optional double maxLongitude = 5; 

   optional double minDepth = 6; 

   optional double maxDepth = 7; 

   optional double minTime = 8; 

   optional double maxTime = 9; 

   optional string identity = 10; // THIS FIELD IS TEMPORARY!! 

   } 

""" 

 

FIND_DATA_RESOURCES_RSP_MSG_TYPE = object_utils.create_type_identifier(object_id=9032, version=1) 

""" 

message FindDataResourcesRspMsg { 

   enum _MessageTypeIdentifier { 

       _ID = 9032; 

       _VERSION = 1; 

   } 

 

   repeated net.ooici.integration.ais.aisDataResourceMetadata.AisDatasetMetadata dataResourceSummary = 1; 

} 

""" 

 

FIND_DATA_RESOURCES_BY_OWNER_RSP_MSG_TYPE = object_utils.create_type_identifier(object_id=9038, version=1) 

""" 

message FindDataResourcesByOwnerRspMsg { 

   enum _MessageTypeIdentifier { 

       _ID = 9038; 

       _VERSION = 1;     

   } 

 

   repeated net.ooici.integration.ais.common.aisDataResourceMetadata.AisDatasetByOwnerMetadataType datasetByOwnerMetadata = 1; 

 

} 

""" 

 

# GetDataResourceDetail GPBs from ion-object-definitions/net/ooici/integration/ais/getDataResourceDetail/get_data_resource_detail.proto 

GET_DATA_RESOURCE_DETAIL_REQ_MSG_TYPE = object_utils.create_type_identifier(object_id=9033, version=1) 

""" 

message GetDataResourceDetailReqMsg { 

   enum _MessageTypeIdentifier { 

       _ID = 9033; 

       _VERSION = 1; 

   } 

 

   optional string data_resource_id  = 1; 

} 

""" 

 

GET_DATA_RESOURCE_DETAIL_RSP_MSG_TYPE = object_utils.create_type_identifier(object_id=9034, version=1) 

""" 

message GetDataResourceDetailRspMsg { 

   enum _MessageTypeIdentifier { 

       _ID = 9034; 

       _VERSION = 1; 

   } 

   optional string data_resource_id = 1; 

   optional net.ooici.integration.ais.common.aisDataResourceMetadata.AisDatasetMetadataType dataResourceSummary = 2; 

   optional net.ooici.integration.ais.common.aisDataResourceMetadata.AisDatasourceMetadataType source = 3; 

   repeated net.ooici.integration.ais.common.aisDataVariable.AisDataVariableType variable = 4; 

} 

 

""" 

 

# CreateDownloadURL GPB from ion-object-definitions/net/ooici/integration/ais/createDownloadURL/create_download_url.proto 

CREATE_DOWNLOAD_URL_REQ_MSG_TYPE = object_utils.create_type_identifier(object_id=9035, version=1) 

""" 

message CreateDownloadURLReqMsg { 

   enum _MessageTypeIdentifier { 

       _ID = 9035; 

       _VERSION = 1; 

   } 

 

   optional string user_ooi_id  = 1; 

 

} 

""" 

 

CREATE_DOWNLOAD_URL_RSP_MSG_TYPE = object_utils.create_type_identifier(object_id=9036, version=1) 

""" 

message CreateDownloadURLRspMsg { 

   enum _MessageTypeIdentifier { 

       _ID = 9036; 

       _VERSION = 1; 

   } 

 

   optional string download_url = 1; 

 

} 

""" 

 

# NameValuePairType GPB from ion-object-definitions/net/ooici/integration/ais/common/name_value_pair_type.proto 

NAME_VALUE_PAIR_TYPE = object_utils.create_type_identifier(object_id=9125, version=1) 

""" 

message NameValuePairType { 

   enum _MessageTypeIdentifier { 

       _ID = 9125; 

       _VERSION = 1; 

   } 

 

   optional string name = 1; 

   optional string value = 2; 

} 

""" 

 

# RegisterUser GPBs from ion-object-definitions/net/ooici/integration/ais/registerUser/register_user.proto 

REGISTER_USER_REQUEST_TYPE = object_utils.create_type_identifier(object_id=9101, version=1) 

""" 

message RegisterIonUserRequest { 

   enum _MessageTypeIdentifier { 

       _ID = 9101; 

       _VERSION = 1; 

   } 

   // objects in a protofile are called messages 

   optional string certificate=1; 

   optional string rsa_private_key=2; 

} 

""" 

 

UPDATE_USER_PROFILE_REQUEST_TYPE = object_utils.create_type_identifier(object_id=9102, version=1) 

""" 

message UpdateUserProfileRequest { 

   enum _MessageTypeIdentifier { 

       _ID = 9102; 

       _VERSION = 1; 

   } 

   // objects in a protofile are called messages 

   optional string user_ooi_id=1; 

   optional string name=2; 

   optional string institution=3; 

   optional string email_address=4; 

   repeated net.ooici.integration.ais.common.aisNameValuePairType.NameValuePairType profile=5; 

} 

""" 

 

REGISTER_USER_RESPONSE_TYPE = object_utils.create_type_identifier(object_id=9103, version=1) 

""" 

message RegisterIonUserResponse { 

   enum _MessageTypeIdentifier { 

       _ID = 9103; 

       _VERSION = 1; 

   } 

 

   optional string ooi_id=1; 

   optional bool user_is_admin=2; 

   optional bool user_already_registered=3; 

   optional bool user_is_early_adopter=4; 

   optional bool user_is_data_provider=5; 

   optional bool user_is_marine_operator=6; 

} 

""" 

 

GET_USER_PROFILE_REQUEST_TYPE = object_utils.create_type_identifier(object_id=9104, version=1) 

""" 

message GetUserProfileRequest { 

   enum _MessageTypeIdentifier { 

       _ID = 9104; 

       _VERSION = 1; 

   } 

 

   optional string user_ooi_id=1; 

} 

""" 

 

GET_USER_PROFILE_RESPONSE_TYPE = object_utils.create_type_identifier(object_id=9105, version=1) 

""" 

message GetUserProfileResponse { 

   enum _MessageTypeIdentifier { 

       _ID = 9105; 

       _VERSION = 1; 

   } 

 

   optional string email_address=1; 

   repeated net.ooici.integration.ais.common.aisNameValuePairType.NameValuePairType profile=2; 

} 

""" 

 

MANAGE_USER_ROLE_REQUEST_TYPE = object_utils.create_type_identifier(object_id=9106, version=1) 

""" 

message ManageUserRoleRequest { 

   enum _MessageTypeIdentifier { 

       _ID = 9106; 

       _VERSION = 1; 

   } 

 

   optional string user_ooi_id=1; 

   optional string role=2; 

} 

""" 

 

# ManageResources GPBs from ion-object-definitions/net/ooici/integration/ais/manageResources/manage_resources.proto 

GET_RESOURCE_TYPES_RESPONSE_TYPE = object_utils.create_type_identifier(object_id=9120, version=1) 

""" 

message GetResourceTypesResponse { 

   enum _MessageTypeIdentifier { 

       _ID = 9120; 

       _VERSION = 1; 

   } 

 

   repeated net.ooici.core.link.CASRef resource_types_list = 1; 

} 

""" 

 

GET_RESOURCES_OF_TYPE_REQUEST_TYPE = object_utils.create_type_identifier(object_id=9121, version=1) 

""" 

message GetResourcesOfTypeRequest { 

   enum _MessageTypeIdentifier { 

       _ID = 9121; 

       _VERSION = 1; 

   } 

 

   optional string resource_type = 1; 

} 

""" 

 

RESOURCE_TYPE = object_utils.create_type_identifier(object_id=9122, version=1) 

""" 

message Resource { 

   enum _MessageTypeIdentifier { 

       _ID = 9122; 

       _VERSION = 1; 

   } 

 

   repeated string attribute = 1; 

} 

""" 

 

GET_RESOURCES_OF_TYPE_RESPONSE_TYPE = object_utils.create_type_identifier(object_id=9123, version=1) 

""" 

message GetResourcesOfTypeResponse { 

   enum _MessageTypeIdentifier { 

       _ID = 9123; 

       _VERSION = 1; 

   } 

 

   repeated string column_names = 1; 

   repeated net.ooici.integration.ais.manageResources.Resource resources = 2; 

} 

""" 

 

GET_RESOURCE_REQUEST_TYPE = object_utils.create_type_identifier(object_id=9124, version=1) 

""" 

message GetResourceRequest { 

   enum _MessageTypeIdentifier { 

       _ID = 9124; 

       _VERSION = 1; 

   } 

 

   optional string ooi_id = 1; 

} 

""" 

 

GET_RESOURCE_RESPONSE_TYPE = object_utils.create_type_identifier(object_id=9126, version=1) 

""" 

 

message GetResourceResponse { 

   enum _MessageTypeIdentifier { 

       _ID = 9126; 

       _VERSION = 1; 

   } 

 

   repeated net.ooici.integration.ais.common.aisNameValuePairType.NameValuePairType resource = 1; 

} 

""" 

 

SUBSCRIPTION_INFO_TYPE = object_utils.create_type_identifier(object_id=9201, version=1) 

""" 

message SubscriptionInfoType { 

    enum _MessageTypeIdentifier { 

      _ID = 9201; 

      _VERSION = 1; 

    } 

 

    // The message parameters object 

    optional string user_ooi_id = 1; 

    optional string data_src_id = 2; 

    enum SubscriptionType { 

         EMAIL = 0; 

         DISPATCHER = 1; 

         EMAILANDDISPATCHER = 2; 

     } 

     optional SubscriptionType subscription_type = 3 [default = EMAIL]; 

     enum AlertsFilter { 

          UPDATES = 0; 

          DATASOURCEOFFLINE = 1; 

          UPDATESANDDATASOURCEOFFLINE = 2; 

     } 

     optional AlertsFilter email_alerts_filter = 4; 

     optional AlertsFilter dispatcher_alerts_filter = 5; 

     optional string dispatcher_script_path = 6; 

} 

""" 

 

# ion-object-definitions/net/ooici/integration/ais/manageDataResource/manage_data_resource.proto 

# look there for the definitions 

CREATE_DATA_RESOURCE_REQ_TYPE = object_utils.create_type_identifier(object_id=9211, version=1) 

CREATE_DATA_RESOURCE_RSP_TYPE = object_utils.create_type_identifier(object_id=9212, version=1) 

DELETE_DATA_RESOURCE_REQ_TYPE = object_utils.create_type_identifier(object_id=9213, version=1) 

DELETE_DATA_RESOURCE_RSP_TYPE = object_utils.create_type_identifier(object_id=9214, version=1) 

UPDATE_DATA_RESOURCE_REQ_TYPE = object_utils.create_type_identifier(object_id=9215, version=1) 

UPDATE_DATA_RESOURCE_RSP_TYPE = object_utils.create_type_identifier(object_id=9216, version=1) 

DATA_RESOURCE_SCHEDULED_TASK_TYPE = object_utils.create_type_identifier(object_id=9217, version=1) 

 

 

 

SUBSCRIBE_DATA_RESOURCE_REQ_TYPE = object_utils.create_type_identifier(object_id=9203, version=1) 

""" 

message SubscriptionCreateReqMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9203; 

      _VERSION = 1; 

    } 

     

    optional net.ooici.integration.ais.common.aisSubscriptionInfo.SubscriptionInfoType subscriptionInfo = 1; 

    optional net.ooici.integration.ais.common.aisDataResourceMetadata.AisDatasetMetadataType datasetMetadata = 2; 

} 

""" 

 

SUBSCRIBE_DATA_RESOURCE_RSP_TYPE = object_utils.create_type_identifier(object_id=9204, version=1) 

""" 

message SubscriptionCreateRspMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9204; 

      _VERSION = 1; 

    } 

 

    optional bool success = 1; 

} 

""" 

 

DELETE_SUBSCRIPTION_REQ_TYPE  = object_utils.create_type_identifier(object_id=9205, version=1) 

""" 

message SubscriptionDeleteReqMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9205; 

      _VERSION = 1; 

    } 

 

    repeated net.ooici.integration.ais.common.aisSubscriptionInfo.SubscriptionInfoType subscriptions = 1; 

} 

""" 

 

DELETE_SUBSCRIPTION_RSP_TYPE  = object_utils.create_type_identifier(object_id=9206, version=1) 

""" 

message SubscriptionDeleteRspMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9206; 

      _VERSION = 1; 

    } 

 

    optional bool success = 1; 

} 

""" 

 

 

GET_SUBSCRIPTION_LIST_REQ_TYPE = object_utils.create_type_identifier(object_id=9207, version=1) 

""" 

message SubscriptionInfoListReqMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9207; 

      _VERSION = 1; 

    } 

 

    optional string user_ooi_id = 1; 

 

} 

""" 

 

GET_SUBSCRIPTION_LIST_RESP_TYPE = object_utils.create_type_identifier(object_id=9208, version=1) 

""" 

message SubscriptionInfoListRspMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9208; 

      _VERSION = 1; 

    } 

 

    repeated SubscriptionInfoReqMsg subscription = 1; 

} 

""" 

 

UPDATE_SUBSCRIPTION_REQ_TYPE  = object_utils.create_type_identifier(object_id=9209, version=1) 

""" 

message SubscriptionUpdateReqMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9209; 

      _VERSION = 1; 

    } 

 

    optional net.ooici.integration.ais.common.aisSubscriptionInfo.SubscriptionInfoType subscriptionInfo = 1; 

    optional net.ooici.integration.ais.common.aisDataResourceMetadata.AisDatasetMetadataType datasetMetadata = 2; 

} 

""" 

 

UPDATE_SUBSCRIPTION_RSP_TYPE  = object_utils.create_type_identifier(object_id=9210, version=1) 

""" 

message SubscriptionUpdateRspMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9210; 

      _VERSION = 1; 

    } 

 

    optional bool success = 1; 

} 

""" 

 

FIND_DATA_SUBSCRIPTIONS_REQ_TYPE = object_utils.create_type_identifier(object_id=9218, version=1) 

""" 

message SubscriptionFindReqMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9217; 

      _VERSION = 1; 

    } 

 

    optional string user_ooi_id = 1; 

    optional net.ooici.integration.ais.common.aisDataBounds.AisDataBoundsType dataBounds = 2; 

} 

""" 

 

FIND_DATA_SUBSCRIPTIONS_RSP_TYPE = object_utils.create_type_identifier(object_id=9219, version=1) 

""" 

message SubscriptionFindRspMsg { 

    enum _MessageTypeIdentifier { 

      _ID = 9218; 

      _VERSION = 1; 

    } 

 

    repeated SubscriptionFindRspPayloadType data = 1; 

    //repeated net.ooici.integration.ais.common.aisSubscriptionInfo.SubscriptionInfoType subscriptionInfo = 1; 

} 

"""