Class: LosantRest::InstanceCustomNode

Inherits:
Object
  • Object
show all
Defined in:
lib/losant_rest/instance_custom_node.rb

Overview

Class containing all the actions for the Instance Custom Node Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ InstanceCustomNode

Returns a new instance of InstanceCustomNode.



30
31
32
 
# File 'lib/losant_rest/instance_custom_node.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#delete(params = {}) ⇒ Object

Deletes a Custom Node

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceCustomNode.*, or instanceCustomNode.delete.

Parameters:

  • string instanceId - ID associated with the instance

  • string instanceCustomNodeId - ID associated with the Custom Node

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/losant_rest/instance_custom_node.rb', line 56

def delete(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)

  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}"

  @client.request(
    method: :delete,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#errors(params = {}) ⇒ Object

Get information about errors that occurred during runs of this Custom Node

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceCustomNode.*, or instanceCustomNode.errors.

Parameters:

  • string instanceId - ID associated with the instance

  • string instanceCustomNodeId - ID associated with the Custom Node

  • string duration - Duration of time range in milliseconds

  • string end - End of time range in milliseconds since epoch

  • string limit - Maximum number of errors to return

  • string sortDirection - Direction to sort the results by. Accepted values are: asc, desc

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


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
 
# File 'lib/losant_rest/instance_custom_node.rb', line 106

def errors(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)

  query_params[:duration] = params[:duration] if params.has_key?(:duration)
  query_params[:end] = params[:end] if params.has_key?(:end)
  query_params[:limit] = params[:limit] if params.has_key?(:limit)
  query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}/errors"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get(params = {}) ⇒ Object

Retrieves information on a Custom Node

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceCustomNode.*, or instanceCustomNode.get.

Parameters:

  • string instanceId - ID associated with the instance

  • string instanceCustomNodeId - ID associated with the Custom Node

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/losant_rest/instance_custom_node.rb', line 156

def get(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)

  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#patch(params = {}) ⇒ Object

Updates information about a Custom Node

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceCustomNode.*, or instanceCustomNode.patch.

Parameters:

  • string instanceId - ID associated with the instance

  • string instanceCustomNodeId - ID associated with the Custom Node

  • hash instanceCustomNode - Object containing new properties of the Custom Node (api.losant.com/#/definitions/instanceCustomNodePatch)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/losant_rest/instance_custom_node.rb', line 203

def patch(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)
  raise ArgumentError.new("instanceCustomNode is required") unless params.has_key?(:instanceCustomNode)

  body = params[:instanceCustomNode] if params.has_key?(:instanceCustomNode)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}"

  @client.request(
    method: :patch,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#stats(params = {}) ⇒ Object

Get statistics about runs for this Custom Node

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceCustomNode.*, or instanceCustomNode.stats.

Parameters:

  • string instanceId - ID associated with the instance

  • string instanceCustomNodeId - ID associated with the Custom Node

  • string duration - Duration of time range in milliseconds

  • string end - End of time range in milliseconds since epoch

  • string resolution - Resolution in milliseconds

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/losant_rest/instance_custom_node.rb', line 254

def stats(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
  raise ArgumentError.new("instanceCustomNodeId is required") unless params.has_key?(:instanceCustomNodeId)

  query_params[:duration] = params[:duration] if params.has_key?(:duration)
  query_params[:end] = params[:end] if params.has_key?(:end)
  query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/instances/#{params[:instanceId]}/nodes/#{params[:instanceCustomNodeId]}/stats"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end