Class: Rafflesia::DatabaseJoinCandidates

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DatabaseJoinCandidates

Returns a new instance of DatabaseJoinCandidates.



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

def initialize(client)
  @client = client
end

Instance Method Details

#create(from_database:, from_release:, to_database:, to_release:, budget: nil, budget_profile: nil, from_relations: nil, max_candidates: nil, ontology_digest: nil, to_relations: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCandidateRunData

POST /v1/database_join_candidates

Parameters:

  • budget (Rafflesia::QueryBudget, nil) (defaults to: nil)
  • budget_profile (Rafflesia::Types::DatabaseJoinCandidateMeasureRequestBudgetProfile, nil) (defaults to: nil)
  • from_database (String)
  • from_relations (Array<String>, nil) (defaults to: nil)
  • from_release (String)
  • max_candidates (Integer, nil) (defaults to: nil)
  • ontology_digest (String, nil) (defaults to: nil)
  • to_database (String)
  • to_relations (Array<String>, nil) (defaults to: nil)
  • to_release (String)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



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

def create(
  from_database:,
  from_release:,
  to_database:,
  to_release:,
  budget: nil,
  budget_profile: nil,
  from_relations: nil,
  max_candidates: nil,
  ontology_digest: nil,
  to_relations: nil,
  request_options: {}
)
  body = {
    'budget' => budget,
    'budget_profile' => budget_profile,
    'from_database' => from_database,
    'from_relations' => from_relations,
    'from_release' => from_release,
    'max_candidates' => max_candidates,
    'ontology_digest' => ontology_digest,
    'to_database' => to_database,
    'to_relations' => to_relations,
    'to_release' => to_release
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/database_join_candidates',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinCandidateRunData.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

#get(candidate_id:, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCandidateData

GET /v1/database_join_candidates/candidate_id

Parameters:

  • candidate_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/rafflesia/database_join_candidates.rb', line 114

def get(
  candidate_id:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/database_join_candidates/#{Rafflesia::Util.encode_path(candidate_id)}",
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinCandidateData.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

#list(from_database:, from_release:, to_database:, to_release:, from_relation: nil, to_relation: nil, key_overlap_status: nil, limit: 100, cursor: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinCandidateListData

GET /v1/database_join_candidates

Parameters:

  • from_database (String)
  • from_release (String)
  • to_database (String)
  • to_release (String)
  • from_relation (String, nil) (defaults to: nil)
  • to_relation (String, nil) (defaults to: nil)
  • key_overlap_status (Rafflesia::Types::DatabaseJoinCandidatesKeyOverlapStatus, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: 100)
  • cursor (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



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

def list(
  from_database:,
  from_release:,
  to_database:,
  to_release:,
  from_relation: nil,
  to_relation: nil,
  key_overlap_status: nil,
  limit: 100,
  cursor: nil,
  request_options: {}
)
  params = {
    'from_database' => from_database,
    'from_release' => from_release,
    'to_database' => to_database,
    'to_release' => to_release,
    'from_relation' => from_relation,
    'to_relation' => to_relation,
    'key_overlap_status' => key_overlap_status,
    'limit' => limit,
    'cursor' => cursor
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/database_join_candidates',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinCandidateListData.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