Class: PulpcoreClient::WorkersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/workers_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkersApi

Returns a new instance of WorkersApi.



19
20
21
 
# File 'lib/pulpcore_client/api/workers_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pulpcore_client/api/workers_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ InlineResponse2009

List workers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :name (String)
  • :name__in (String) —

    Filter results where name is in a comma-separated list of values

  • :last_heartbeat__lt (String) —

    Filter results where last_heartbeat is less than value

  • :last_heartbeat__lte (String) —

    Filter results where last_heartbeat is less than or equal to value

  • :last_heartbeat__gt (String) —

    Filter results where last_heartbeat is greater than value

  • :last_heartbeat__gte (String) —

    Filter results where last_heartbeat is greater than or equal to value

  • :last_heartbeat__range (String) —

    Filter results where last_heartbeat is between two comma separated values

  • :online (String)
  • :missing (String)
  • :last_heartbeat (String) —

    ISO 8601 formatted dates are supported

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



40
41
42
43
 
# File 'lib/pulpcore_client/api/workers_api.rb', line 40

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2009, Integer, Hash)>

List workers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :name (String)
  • :name__in (String) —

    Filter results where name is in a comma-separated list of values

  • :last_heartbeat__lt (String) —

    Filter results where last_heartbeat is less than value

  • :last_heartbeat__lte (String) —

    Filter results where last_heartbeat is less than or equal to value

  • :last_heartbeat__gt (String) —

    Filter results where last_heartbeat is greater than value

  • :last_heartbeat__gte (String) —

    Filter results where last_heartbeat is greater than or equal to value

  • :last_heartbeat__range (String) —

    Filter results where last_heartbeat is between two comma separated values

  • :online (String)
  • :missing (String)
  • :last_heartbeat (String) —

    ISO 8601 formatted dates are supported

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    InlineResponse2009 data, response status code and response headers



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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/pulpcore_client/api/workers_api.rb', line 63

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkersApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/workers/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'last_heartbeat__lt'] = opts[:'last_heartbeat__lt'] if !opts[:'last_heartbeat__lt'].nil?
  query_params[:'last_heartbeat__lte'] = opts[:'last_heartbeat__lte'] if !opts[:'last_heartbeat__lte'].nil?
  query_params[:'last_heartbeat__gt'] = opts[:'last_heartbeat__gt'] if !opts[:'last_heartbeat__gt'].nil?
  query_params[:'last_heartbeat__gte'] = opts[:'last_heartbeat__gte'] if !opts[:'last_heartbeat__gte'].nil?
  query_params[:'last_heartbeat__range'] = opts[:'last_heartbeat__range'] if !opts[:'last_heartbeat__range'].nil?
  query_params[:'online'] = opts[:'online'] if !opts[:'online'].nil?
  query_params[:'missing'] = opts[:'missing'] if !opts[:'missing'].nil?
  query_params[:'last_heartbeat'] = opts[:'last_heartbeat'] if !opts[:'last_heartbeat'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2009' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :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: WorkersApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(worker_href, opts = {}) ⇒ WorkerRead

Inspect a worker

Parameters:

  • worker_href (String) —

    URI of Worker. e.g.: /pulp/api/v3/workers/1/

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



127
128
129
130
 
# File 'lib/pulpcore_client/api/workers_api.rb', line 127

def read(worker_href, opts = {})
  data, _status_code, _headers = read_with_http_info(worker_href, opts)
  data
end

#read_with_http_info(worker_href, opts = {}) ⇒ Array<(WorkerRead, Integer, Hash)>

Inspect a worker

Parameters:

  • worker_href (String) —

    URI of Worker. e.g.: /pulp/api/v3/workers/1/

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    WorkerRead data, response status code and response headers



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/pulpcore_client/api/workers_api.rb', line 138

def read_with_http_info(worker_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkersApi.read ...'
  end
  # verify the required parameter 'worker_href' is set
  if @api_client.config.client_side_validation && worker_href.nil?
    fail ArgumentError, "Missing the required parameter 'worker_href' when calling WorkersApi.read"
  end
  # resource path
  local_var_path = '{worker_href}'.sub('{' + 'worker_href' + '}', CGI.escape(worker_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'WorkerRead' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :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: WorkersApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end