Exception: DockerEngine::Errors::APIStatusError

Inherits:
APIError
  • Object
show all
Defined in:
lib/docker_engine/errors.rb

Instance Attribute Summary collapse

Attributes inherited from APIError

#body, #headers, #url

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url:, status:, headers:, body:, request:, response:, message: nil) ⇒ APIStatusError

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of APIStatusError.

Parameters:

  • url (URI::Generic)
  • status (Integer)
  • headers (Hash{String=>String}, nil)
  • body (Object, nil)
  • request (nil)
  • response (nil)
  • message (String, nil) (defaults to: nil)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/docker_engine/errors.rb', line 182

def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
  message ||= {url: url.to_s, status: status, body: body}
  super(
    url: url,
    status: status,
    headers: headers,
    body: body,
    request: request,
    response: response,
    message: message&.to_s
  )
end

Instance Attribute Details

#status ⇒ Integer

Returns:

  • (Integer)


2
3
4
# File 'lib/docker_engine/errors.rb', line 2

def status
  @status
end

Class Method Details

.for(url:, status:, headers:, body:, request:, response:, message: nil) ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • url (URI::Generic)
  • status (Integer)
  • headers (Hash{String=>String}, nil)
  • body (Object, nil)
  • request (nil)
  • response (nil)
  • message (String, nil) (defaults to: nil)

Returns:

  • (self)


135
136
137
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
# File 'lib/docker_engine/errors.rb', line 135

def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
  kwargs =
    {
      url: url,
      status: status,
      headers: headers,
      body: body,
      request: request,
      response: response,
      message: message
    }

  case status
  in 400
    DockerEngine::Errors::BadRequestError.new(**kwargs)
  in 401
    DockerEngine::Errors::AuthenticationError.new(**kwargs)
  in 403
    DockerEngine::Errors::PermissionDeniedError.new(**kwargs)
  in 404
    DockerEngine::Errors::NotFoundError.new(**kwargs)
  in 409
    DockerEngine::Errors::ConflictError.new(**kwargs)
  in 422
    DockerEngine::Errors::UnprocessableEntityError.new(**kwargs)
  in 429
    DockerEngine::Errors::RateLimitError.new(**kwargs)
  in (500..)
    DockerEngine::Errors::InternalServerError.new(**kwargs)
  else
    DockerEngine::Errors::APIStatusError.new(**kwargs)
  end
end