Class: Rafflesia::DatabaseJoinNeighbors

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DatabaseJoinNeighbors

Returns a new instance of DatabaseJoinNeighbors.



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

def initialize(client)
  @client = client
end

Instance Method Details

#list(database:, release:, relation: nil, target_database: nil, safety: 'strict', evidence: 'cardinality_consistent', availability: 'all', include_same_database: false, limit: 100, cursor: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinNeighborListData

GET /v1/database_join_neighbors

Parameters:

Returns:



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

def list(
  database:,
  release:,
  relation: nil,
  target_database: nil,
  safety: 'strict',
  evidence: 'cardinality_consistent',
  availability: 'all',
  include_same_database: false,
  limit: 100,
  cursor: nil,
  request_options: {}
)
  params = {
    'database' => database,
    'release' => release,
    'relation' => relation,
    'target_database' => target_database,
    'safety' => safety,
    'evidence' => evidence,
    'availability' => availability,
    'include_same_database' => include_same_database,
    'limit' => limit,
    'cursor' => cursor
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/database_join_neighbors',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinNeighborListData.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