Class: Infrawrench::DockerNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.docker

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ DockerNamespace

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 DockerNamespace.

Parameters:



2470
2471
2472
 
# File 'lib/infrawrench/client.rb', line 2470

def initialize(transport)
  @transport = transport
end

Instance Method Details

#command(body:, org_id: nil, request_options: nil) ⇒ Hash

Run a Docker daemon operation

Requires permission: resources:execute.

POST /api/org/orgId/docker/command

Raises on 400: Bad request

Raises on 404: Not found

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • body (Hash) —

    Request body, shaped as DockerCommandRequest.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • body: (docker_command_request)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as DockerCommandResponse — see sig/infrawrench/sdk.rbs.

Raises:



2491
2492
2493
2494
2495
2496
2497
2498
2499
 
# File 'lib/infrawrench/client.rb', line 2491

def command(body:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/docker/command",
    path_params: { "orgId" => org_id },
    body: body,
    request_options: request_options
  )
end