Class: TriglavClient::JobMessagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/triglav_client/api/job_messages_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ JobMessagesApi

Returns a new instance of JobMessagesApi.



30
31
32
 
# File 'lib/triglav_client/api/job_messages_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/triglav_client/api/job_messages_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#fetch_job_messages(offset, job_id, opts = {}) ⇒ Array<JobMessageEachResponse>

Fetch Job messages

Parameters:

  • offset —

    Offset (Greater than or equal to) ID for Messages to fetch from

  • job_id —

    Job ID

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of limits

Returns:



41
42
43
44
 
# File 'lib/triglav_client/api/job_messages_api.rb', line 41

def fetch_job_messages(offset, job_id, opts = {})
  data, _status_code, _headers = fetch_job_messages_with_http_info(offset, job_id, opts)
  return data
end

#fetch_job_messages_with_http_info(offset, job_id, opts = {}) ⇒ Array<(Array<JobMessageEachResponse>, Fixnum, Hash)>

Fetch Job messages

Parameters:

  • offset —

    Offset (Greater than or equal to) ID for Messages to fetch from

  • job_id —

    Job ID

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of limits

Returns:

  • (Array<(Array<JobMessageEachResponse>, Fixnum, Hash)>) —

    Array<JobMessageEachResponse> data, response status code and response headers



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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/triglav_client/api/job_messages_api.rb', line 53

def fetch_job_messages_with_http_info(offset, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobMessagesApi.fetch_job_messages ..."
  end
  # verify the required parameter 'offset' is set
  fail ArgumentError, "Missing the required parameter 'offset' when calling JobMessagesApi.fetch_job_messages" if offset.nil?
  # verify the required parameter 'job_id' is set
  fail ArgumentError, "Missing the required parameter 'job_id' when calling JobMessagesApi.fetch_job_messages" if job_id.nil?
  # resource path
  local_var_path = "/job_messages".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'offset'] = offset
  query_params[:'job_id'] = job_id
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<JobMessageEachResponse>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobMessagesApi#fetch_job_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_last_job_message_id(opts = {}) ⇒ LastJobMessageIdResponse

Get the current last message id which would be used as a first offset to fetch messages

Parameters:

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

    the optional parameters

Returns:



104
105
106
107
 
# File 'lib/triglav_client/api/job_messages_api.rb', line 104

def get_last_job_message_id(opts = {})
  data, _status_code, _headers = get_last_job_message_id_with_http_info(opts)
  return data
end

#get_last_job_message_id_with_http_info(opts = {}) ⇒ Array<(LastJobMessageIdResponse, Fixnum, Hash)>

Get the current last message id which would be used as a first offset to fetch messages

Parameters:

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

    the optional parameters

Returns:

  • (Array<(LastJobMessageIdResponse, Fixnum, Hash)>) —

    LastJobMessageIdResponse data, response status code and response headers



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/triglav_client/api/job_messages_api.rb', line 113

def get_last_job_message_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: JobMessagesApi.get_last_job_message_id ..."
  end
  # resource path
  local_var_path = "/job_messages/last_id".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LastJobMessageIdResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobMessagesApi#get_last_job_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end