Class: Fastly::RealtimeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/realtime_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RealtimeApi

Returns a new instance of RealtimeApi.



17
18
19
 
# File 'lib/fastly/api/realtime_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/realtime_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_stats_last120_seconds(opts = {}) ⇒ Realtime

Get real-time data for the last 120 seconds Get data for the 120 seconds preceding the latest timestamp available for a service.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

Returns:



24
25
26
27
 
# File 'lib/fastly/api/realtime_api.rb', line 24

def get_stats_last120_seconds(opts = {})
  data, _status_code, _headers = get_stats_last120_seconds_with_http_info(opts)
  data
end

#get_stats_last120_seconds_limit_entries(opts = {}) ⇒ Realtime

Get a limited number of real-time data entries Get data for the 120 seconds preceding the latest timestamp available for a service, up to a maximum of ‘max_entries` entries.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :max_entries (Integer) —

    Maximum number of results to show. (required)

Returns:



88
89
90
91
 
# File 'lib/fastly/api/realtime_api.rb', line 88

def get_stats_last120_seconds_limit_entries(opts = {})
  data, _status_code, _headers = get_stats_last120_seconds_limit_entries_with_http_info(opts)
  data
end

#get_stats_last120_seconds_limit_entries_with_http_info(opts = {}) ⇒ Array<(Realtime, Integer, Hash)>

Get a limited number of real-time data entries Get data for the 120 seconds preceding the latest timestamp available for a service, up to a maximum of &#x60;max_entries&#x60; entries.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :max_entries (Integer) —

    Maximum number of results to show. (required)

Returns:

  • (Array<(Realtime, Integer, Hash)>) —

    Realtime data, response status code and response headers



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/fastly/api/realtime_api.rb', line 98

def get_stats_last120_seconds_limit_entries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealtimeApi.get_stats_last120_seconds_limit_entries ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  max_entries = opts[:'max_entries']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling RealtimeApi.get_stats_last120_seconds_limit_entries"
  end
  # verify the required parameter 'max_entries' is set
  if @api_client.config.client_side_validation && max_entries.nil?
    fail ArgumentError, "Missing the required parameter 'max_entries' when calling RealtimeApi.get_stats_last120_seconds_limit_entries"
  end
  # resource path
  local_var_path = '/v1/channel/{service_id}/ts/h/limit/{max_entries}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'max_entries' + '}', CGI.escape(max_entries.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Realtime'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"RealtimeApi.get_stats_last120_seconds_limit_entries",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RealtimeApi#get_stats_last120_seconds_limit_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stats_last120_seconds_with_http_info(opts = {}) ⇒ Array<(Realtime, Integer, Hash)>

Get real-time data for the last 120 seconds Get data for the 120 seconds preceding the latest timestamp available for a service.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

Returns:

  • (Array<(Realtime, Integer, Hash)>) —

    Realtime data, response status code and response headers



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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/fastly/api/realtime_api.rb', line 33

def get_stats_last120_seconds_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealtimeApi.get_stats_last120_seconds ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling RealtimeApi.get_stats_last120_seconds"
  end
  # resource path
  local_var_path = '/v1/channel/{service_id}/ts/h'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Realtime'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"RealtimeApi.get_stats_last120_seconds",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RealtimeApi#get_stats_last120_seconds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stats_last_second(opts = {}) ⇒ Realtime

Get real-time data from specified time Get real-time data for the specified reporting period. Specify ‘0` to get a single entry for the last complete second. The `Timestamp` field included in the response provides the time index of the latest entry in the dataset and can be provided as the `start_timestamp` of the next request for a seamless continuation of the dataset from one request to the next.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :timestamp_in_seconds (Integer) —

    Timestamp in seconds (Unix epoch time). (required)

Returns:



158
159
160
161
 
# File 'lib/fastly/api/realtime_api.rb', line 158

def get_stats_last_second(opts = {})
  data, _status_code, _headers = get_stats_last_second_with_http_info(opts)
  data
end

#get_stats_last_second_with_http_info(opts = {}) ⇒ Array<(Realtime, Integer, Hash)>

Get real-time data from specified time Get real-time data for the specified reporting period. Specify &#x60;0&#x60; to get a single entry for the last complete second. The &#x60;Timestamp&#x60; field included in the response provides the time index of the latest entry in the dataset and can be provided as the &#x60;start_timestamp&#x60; of the next request for a seamless continuation of the dataset from one request to the next.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :timestamp_in_seconds (Integer) —

    Timestamp in seconds (Unix epoch time). (required)

Returns:

  • (Array<(Realtime, Integer, Hash)>) —

    Realtime data, response status code and response headers



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/fastly/api/realtime_api.rb', line 168

def get_stats_last_second_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealtimeApi.get_stats_last_second ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  timestamp_in_seconds = opts[:'timestamp_in_seconds']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling RealtimeApi.get_stats_last_second"
  end
  # verify the required parameter 'timestamp_in_seconds' is set
  if @api_client.config.client_side_validation && timestamp_in_seconds.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp_in_seconds' when calling RealtimeApi.get_stats_last_second"
  end
  # resource path
  local_var_path = '/v1/channel/{service_id}/ts/{timestamp_in_seconds}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'timestamp_in_seconds' + '}', CGI.escape(timestamp_in_seconds.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Realtime'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"RealtimeApi.get_stats_last_second",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RealtimeApi#get_stats_last_second\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end