Class: DockerEngineRuby::Models::Summary::Port

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/docker_engine_ruby/models/summary.rb

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(private_port:, type:, ip: nil, public_port: nil) ⇒ Object

Describes a port-mapping between the container and the host.

Parameters:

  • private_port (Integer)

    Port on the container

  • type (Symbol, DockerEngineRuby::Models::Summary::Port::Type)
  • ip (String) (defaults to: nil)

    Host IP address that the container’s port is mapped to

  • public_port (Integer) (defaults to: nil)

    Port exposed on the host



# File 'lib/docker_engine_ruby/models/summary.rb', line 708


Instance Attribute Details

#ipString?

Host IP address that the container’s port is mapped to

Returns:

  • (String, nil)


700
# File 'lib/docker_engine_ruby/models/summary.rb', line 700

optional :ip, String, api_name: :IP

#private_portInteger

Port on the container

Returns:

  • (Integer)


689
# File 'lib/docker_engine_ruby/models/summary.rb', line 689

required :private_port, Integer, api_name: :PrivatePort

#public_portInteger?

Port exposed on the host

Returns:

  • (Integer, nil)


706
# File 'lib/docker_engine_ruby/models/summary.rb', line 706

optional :public_port, Integer, api_name: :PublicPort

#typeSymbol, DockerEngineRuby::Models::Summary::Port::Type



694
# File 'lib/docker_engine_ruby/models/summary.rb', line 694

required :type, enum: -> { DockerEngineRuby::Summary::Port::Type }, api_name: :Type