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

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

Overview

See Also:

Defined Under Namespace

Modules: Mode Classes: Port

Instance Attribute Summary collapse

Class Method 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(mode: nil, ports: nil) ⇒ Object

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

Properties that can be configured to access and load balance a service.

Parameters:




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

Instance Attribute Details

#mode ⇒ Symbol, ...

The mode of resolution to use for internal load balancing between tasks.

Returns:



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

optional :mode, enum: -> { DockerEngineRuby::Service::Endpoint::Spec::Mode }, api_name: :Mode

#ports ⇒ Array<DockerEngineRuby::Models::Service::Endpoint::Spec::Port>?

List of exposed ports that this service is accessible on from the outside. Ports can only be provided if vip resolution mode is used.

Returns:



224
225
226
227
228
 
# File 'lib/docker_engine_ruby/models/service.rb', line 224

optional :ports,
-> {
  DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Service::Endpoint::Spec::Port]
},
api_name: :Ports

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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