class LosantRest::EdgeDeployments
Class containing all the actions for the Edge Deployments Resource
Public Class Methods
# File lib/losant_rest/edge_deployments.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Returns the edge deployments for an application
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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, edgeDeployments.*, or edgeDeployments.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} sortField - Field to sort the results by. Accepted values are: id, deviceId, flowId, desiredVersion, currentVersion, creationDate, lastUpdated
-
{string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
-
{string} page - Which page of results to return
-
{string} perPage - How many items to return per page
-
{string} deviceId - Filter deployments to the given
Device
ID -
{string} version - Filter deployments to the given Workflow Version (matches against both current and desired)
-
{undefined} filterEmpty - Filter out deployments where both the current and desired version are null.
-
{string} flowId - Filter deployments to the given Workflow ID
-
{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:
-
200 - Collection of edge deployments (api.losant.com/#/definitions/edgeDeployments)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/edge_deployments.rb, line 63 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) query_params[:sortField] = params[:sortField] if params.has_key?(:sortField) query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection) query_params[:page] = params[:page] if params.has_key?(:page) query_params[:perPage] = params[:perPage] if params.has_key?(:perPage) query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId) query_params[:version] = params[:version] if params.has_key?(:version) query_params[:filterEmpty] = params[:filterEmpty] if params.has_key?(:filterEmpty) query_params[:flowId] = params[:flowId] if params.has_key?(:flowId) 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 = "/applications/#{params[:applicationId]}/edge/deployments" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Deploy an edge workflow version to one or more edge devices. Version can be blank, if removal is desired.
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.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeployments.release.
Parameters:
-
{string} applicationId - ID associated with the application
-
{hash} deployment - Deployment release information (api.losant.com/#/definitions/edgeDeploymentRelease)
-
{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:
-
201 - If deployment release has been initiated successfully (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/edge_deployments.rb, line 116 def release(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment) body = params[:deployment] if params.has_key?(:deployment) 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 = "/applications/#{params[:applicationId]}/edge/deployments/release" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end
Remove all edge deployments from a device, remove all edge deployments of a workflow, or remove a specific workflow from a specific device
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.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeployments.remove.
Parameters:
-
{string} applicationId - ID associated with the application
-
{hash} deployment - Deployment removal information (api.losant.com/#/definitions/edgeDeploymentRemove)
-
{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:
-
201 - If deployment removal has been initiated successfully (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/edge_deployments.rb, line 163 def remove(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment) body = params[:deployment] if params.has_key?(:deployment) 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 = "/applications/#{params[:applicationId]}/edge/deployments/remove" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end
Replace deployments of an edge workflow version with a new version. New version can be blank, if removal is desired.
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.Application, all.Organization, all.User, edgeDeployments.*, or edgeDeployments.replace.
Parameters:
-
{string} applicationId - ID associated with the application
-
{hash} deployment - Deployment replacement information (api.losant.com/#/definitions/edgeDeploymentReplace)
-
{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:
-
201 - If deployment replacement has been initiated successfully (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/edge_deployments.rb, line 210 def replace(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId) raise ArgumentError.new("deployment is required") unless params.has_key?(:deployment) body = params[:deployment] if params.has_key?(:deployment) 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 = "/applications/#{params[:applicationId]}/edge/deployments/replace" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end