Get Containerized Extractor

1 curl https://api.gov.nominal.io/api/extractors/v1/container/extractorRid \ 2 -H "Authorization: Bearer <token>"

1 { 2 "rid": "rid", 3 "name": "name", 4 "image": { 5 "registry": "registry", 6 "repository": "repository", 7 "tagDetails": { 8 "tags": [ 9 "tags" 10 ], 11 "defaultTag": "defaultTag" 12 }, 13 "authentication": { 14 "type": "userAndPassword", 15 "userAndPassword": { 16 "username": "username", 17 "passwordSecretRid": "passwordSecretRid" 18 } 19 }, 20 "command": "command" 21 }, 22 "inputs": [ 23 { 24 "environmentVariable": "environmentVariable", 25 "name": "name", 26 "fileFilters": [ 27 { 28 "type": "suffix", 29 "suffix": "fileFilters" 30 }, 31 { 32 "type": "suffix", 33 "suffix": "fileFilters" 34 } 35 ], 36 "description": "description", 37 "required": true 38 }, 39 { 40 "environmentVariable": "environmentVariable", 41 "name": "name", 42 "fileFilters": [ 43 { 44 "type": "suffix", 45 "suffix": "fileFilters" 46 }, 47 { 48 "type": "suffix", 49 "suffix": "fileFilters" 50 } 51 ], 52 "description": "description", 53 "required": true 54 } 55 ], 56 "properties": { 57 "properties": "properties" 58 }, 59 "labels": [ 60 "labels" 61 ], 62 "createdAt": "2024-01-15T09:30:00Z", 63 "isArchived": true, 64 "timestampMetadata": { 65 "seriesName": "seriesName", 66 "timestampType": { 67 "type": "relative", 68 "relative": { 69 "timeUnit": "DAYS", 70 "offset": "2024-01-15T09:30:00Z" 71 } 72 } 73 }, 74 "description": "description" 75 }

Get a containerized extractor by its RID.

Path parameters

extractorRidstringRequired

Response

This endpoint returns an object.

ridstring

Unique resource identifier for the extractor.

namestring

The name of the extractor as defined by the user.

imageobject

Container image used to run the extractor.

inputslist of objects

The input files that this extractor requires, mapped to environment variables that store the path to the file.

propertiesmap from strings to strings

Additional properties associated with this extractor.

labelsset of strings

Set of labels applied to this extractor.

createdAtdatetime

Timestamp when this extractor was created.

isArchivedboolean

Whether this extractor is archived.

timestampMetadataobject

Metadata about the intermediate parquet this extractor will produce

descriptionstringOptional

Optional description of the extractor.

Path parameters

Headers

Response