Class: DockerEngineRuby::Models::Service::Endpoint::Spec::Port

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• DockerEngineRuby::Models::Service::Endpoint::Spec::Port

Defined in:

lib/docker_engine_ruby/models/service.rb

Defined Under Namespace

Modules: Protocol, PublishMode

Instance Attribute Summary

• #name ⇒ String^?
• #protocol ⇒ Symbol, ...
• #publish_mode ⇒ Symbol, ...

  The mode in which port is published.

• #published_port ⇒ Integer^?

  The port on the swarm hosts.

• #target_port ⇒ Integer^?

  The port inside the container.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(name: nil, protocol: nil, published_port: nil, publish_mode: nil, target_port: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Port for more details.

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(name: nil, protocol: nil, published_port: nil, publish_mode: nil, target_port: nil) ⇒ Object

Some parameter documentations has been truncated, see DockerEngineRuby::Models::Service::Endpoint::Spec::Port for more details.

Parameters:

• name (String) (defaults to: nil)
• protocol (Symbol, DockerEngineRuby::Models::Service::Endpoint::Spec::Port::Protocol) (defaults to: nil)
• published_port (Integer) (defaults to: nil) —

  The port on the swarm hosts.

• publish_mode (Symbol, DockerEngineRuby::Models::Service::Endpoint::Spec::Port::PublishMode) (defaults to: nil) —

  The mode in which port is published.

• target_port (Integer) (defaults to: nil) —

  The port inside the container.

# File 'lib/docker_engine_ruby/models/service.rb', line 293

Instance Attribute Details

#name ⇒ String^?

Returns:

• (String, nil)

# File 'lib/docker_engine_ruby/models/service.rb', line 257

optional :name, String, api_name: :Name

#protocol ⇒ Symbol, ...

Returns:

• (Symbol, DockerEngineRuby::Models::Service::Endpoint::Spec::Port::Protocol, nil)

# File 'lib/docker_engine_ruby/models/service.rb', line 262

optional :protocol,
enum: -> { DockerEngineRuby::Service::Endpoint::Spec::Port::Protocol },
api_name: :Protocol

#publish_mode ⇒ Symbol, ...

The mode in which port is published.

<p><br /></p>

• “ingress” makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not.

• “host” bypasses the routing mesh and publish the port directly on the swarm node where that service is running.

Returns:

• (Symbol, DockerEngineRuby::Models::Service::Endpoint::Spec::Port::PublishMode, nil)

# File 'lib/docker_engine_ruby/models/service.rb', line 283

optional :publish_mode,
enum: -> { DockerEngineRuby::Service::Endpoint::Spec::Port::PublishMode },
api_name: :PublishMode

#published_port ⇒ Integer^?

The port on the swarm hosts.

Returns:

• (Integer, nil)

# File 'lib/docker_engine_ruby/models/service.rb', line 270

optional :published_port, Integer, api_name: :PublishedPort

#target_port ⇒ Integer^?

The port inside the container.

Returns:

• (Integer, nil)

# File 'lib/docker_engine_ruby/models/service.rb', line 291

optional :target_port, Integer, api_name: :TargetPort

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/docker_engine_ruby/models/service.rb', line 315