class Docr::Endpoints::Exec

Overview

The Exec class provides functionality related to executing commands within containers.

Defined in:

docr/endpoints/exec.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(client : Docr::Client) #

Initializes the Exec endpoint with a specific client instance.

  • client: The client instance used for making API calls.

[View source]

Instance Method Detail

def client : Docr::Client #

Returns the associated client instance.


[View source]
def container(id : String, config : Docr::Types::ExecConfig) : Docr::Types::IdResponseIdResponse #

Creates an exec instance for a container with a given configuration.

  • id: The ID of the container to create the exec instance for.
  • config: Configuration details for creating the exec instance.

Returns the ID of the created exec instance.


[View source]
def inspect(id : String) #

Inspects details about a specific exec instance.

  • id: The ID of the exec instance to inspect.

Returns a structured response after inspecting the exec instance.


[View source]
def start(id : String, config : Docr::Types::ExecStartConfig) : IO #

Starts an exec command with a given configuration.

  • id: The ID of the exec instance to start.
  • config: Configuration details for starting the exec command.

Returns the IO stream of the started command.


[View source]