Class: Rafflesia::DatabaseJoinPathMeasurements

Inherits:
Object
  • Object
show all
Defined in:
lib/rafflesia/database_join_path_measurements.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DatabaseJoinPathMeasurements

Returns a new instance of DatabaseJoinPathMeasurements.



9
10
11
# File 'lib/rafflesia/database_join_path_measurements.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#create(edges:, sources:, budget: nil, dataset_name: nil, dataset_version: nil, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinPathMeasurementData

POST /v1/database_join_path_measurements

Parameters:

  • budget (Rafflesia::QueryBudget, nil) (defaults to: nil)
  • dataset_name (String, nil) (defaults to: nil)
  • dataset_version (String, nil) (defaults to: nil)
  • edges (Array<Rafflesia::DatabaseJoinPathEdge>, nil)

    Ordered acyclic path edges. Each edge after the first starts at the previous edge's to_source, and edge count must equal source count minus one.

  • ontology_digest (String, nil) (defaults to: nil)
  • sources (Array<Rafflesia::DatabaseJoinPathSource>, nil)
  • request_options (Hash) (defaults to: {})

    (see Rafflesia::Types::RequestOptions)

Returns:



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
# File 'lib/rafflesia/database_join_path_measurements.rb', line 22

def create(
  edges:,
  sources:,
  budget: nil,
  dataset_name: nil,
  dataset_version: nil,
  ontology_digest: nil,
  request_options: {}
)
  body = {
    'budget' => budget,
    'dataset_name' => dataset_name,
    'dataset_version' => dataset_version,
    'edges' => edges,
    'ontology_digest' => ontology_digest,
    'sources' => sources
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/database_join_path_measurements',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinPathMeasurementData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end