Class: RecombeeApiClient::GetSegmentation

Inherits:
ApiRequest
  • Object
show all
Defined in:
lib/recombee_api_client/api/get_segmentation.rb

Overview

Get existing Segmentation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_optional

Constructor Details

#initialize(segmentation_id) ⇒ GetSegmentation

  • *Required arguments*

    • segmentation_id -> ID of the Segmentation that should be returned



21
22
23
24
25
 
# File 'lib/recombee_api_client/api/get_segmentation.rb', line 21

def initialize(segmentation_id)
  @segmentation_id = segmentation_id
  @timeout = 10000
  @ensure_https = false
end

Instance Attribute Details

#ensure_https ⇒ Object

Returns the value of attribute ensure_https.



15
16
17
 
# File 'lib/recombee_api_client/api/get_segmentation.rb', line 15

def ensure_https
  @ensure_https
end

#segmentation_id ⇒ Object (readonly)

Returns the value of attribute segmentation_id.



13
14
15
 
# File 'lib/recombee_api_client/api/get_segmentation.rb', line 13

def segmentation_id
  @segmentation_id
end

#timeout ⇒ Object

Returns the value of attribute timeout.



14
15
16
 
# File 'lib/recombee_api_client/api/get_segmentation.rb', line 14

def timeout
  @timeout
end

Instance Method Details

#body_parameters ⇒ Object

Values of body parameters as a Hash



33
34
35
36
 
# File 'lib/recombee_api_client/api/get_segmentation.rb', line 33

def body_parameters
  p = Hash.new
  p
end

#method ⇒ Object

HTTP method



28
29
30
 
# File 'lib/recombee_api_client/api/get_segmentation.rb', line 28

def method
  :get
end

#path ⇒ Object

Relative path to the endpoint



46
47
48
 
# File 'lib/recombee_api_client/api/get_segmentation.rb', line 46

def path
  "/{databaseId}/segmentations/list/#{@segmentation_id}"
end

#query_parameters ⇒ Object

Values of query parameters as a Hash. name of parameter => value of the parameter



40
41
42
43
 
# File 'lib/recombee_api_client/api/get_segmentation.rb', line 40

def query_parameters
  params = {}
  params
end