Class: Riveter::Resources::Enrichments

Inherits:
Object
  • Object
show all
Defined in:
lib/riveter/resources.rb

Overview

Saved enrichment configurations.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Enrichments

Returns a new instance of Enrichments.



56
57
58
 
# File 'lib/riveter/resources.rb', line 56

def initialize(client)
  @client = client
end

Instance Method Details

#build_dataset(enrichment_id, **params) ⇒ Object

Build a dataset shaped for this enrichment. (operationId: buildDatasetForEnrichment)



82
83
84
 
# File 'lib/riveter/resources.rb', line 82

def build_dataset(enrichment_id, **params)
  Run.new(@client.request(:post, "/enrichments/#{enrichment_id}/datasets", body: params))
end

#create(dataset_id:) ⇒ Object

Create an enrichment (no run) from a completed dataset build. (operationId: createEnrichment)



67
68
69
 
# File 'lib/riveter/resources.rb', line 67

def create(dataset_id:)
  Enrichment.new(@client.request(:post, "/enrichments", body: { dataset_id: dataset_id }))
end

#get(enrichment_id) ⇒ Object

The enrichment's input columns and output column configuration. (operationId: getEnrichment)



72
73
74
 
# File 'lib/riveter/resources.rb', line 72

def get(enrichment_id)
  Enrichment.new(@client.request(:get, "/enrichments/#{enrichment_id}"))
end

#list ⇒ Object

List enrichments with their output column configuration. (operationId: listEnrichments)



61
62
63
64
 
# File 'lib/riveter/resources.rb', line 61

def list
  response = @client.request(:get, "/enrichments")
  (response["enrichments"] || []).map { |item| EnrichmentSummary.new(item) }
end

#update(enrichment_id, **params) ⇒ Object

Add, update, rename, delete, or reorder output columns. (operationId: updateEnrichment)



77
78
79
 
# File 'lib/riveter/resources.rb', line 77

def update(enrichment_id, **params)
  @client.request(:patch, "/enrichments/#{enrichment_id}", body: params)
end