Class: DockerEngineAPI::Resources::Distribution

Inherits:

Object

• Object
• DockerEngineAPI::Resources::Distribution

Defined in:

lib/docker_engine_api/resources/distribution.rb

Instance Method Summary

• #initialize(client:) ⇒ Distribution constructor private

  A new instance of Distribution.

• #inspect_(name, request_options: {}) ⇒ DockerEngineAPI::Models::Inspect

  Return image digest and platform information by contacting the registry.

Constructor Details

#initialize(client:) ⇒ Distribution

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

Parameters:

• client (DockerEngineAPI::Client)

# File 'lib/docker_engine_api/resources/distribution.rb', line 29

def initialize(client:)
  @client = client
end

Instance Method Details

#inspect_(name, request_options: {}) ⇒ DockerEngineAPI::Models::Inspect

Return image digest and platform information by contacting the registry.

Parameters:

• name (String) —

  Image name or id

• request_options (DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (DockerEngineAPI::Models::Inspect)

See Also:

• Models::DistributionInspectParams

# File 'lib/docker_engine_api/resources/distribution.rb', line 17

def inspect_(name, params = {})
  @client.request(
    method: :get,
    path: ["distribution/%1$s/json", name],
    model: DockerEngineAPI::Inspect,
    options: params[:request_options]
  )
end