Class: DockerEngineRuby::Models::ServiceSpec

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

Defined Under Namespace

Classes: EndpointSpec, Mode, Network, RollbackConfig, UpdateConfig

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(aliases: nil, driver_opts: nil, target: nil) ⇒ Object

Specifies how a service should be attached to a particular network.

Parameters:

  • aliases (Array<String>) (defaults to: nil) —

    Discoverable alternate names for the service on this network.

  • driver_opts (Hash{Symbol=>String}) (defaults to: nil) —

    Driver attachment options for the network target.

  • target (String) (defaults to: nil) —

    The target network for attachment. Must be a network name or ID.




# File 'lib/docker_engine_ruby/models/service_spec.rb', line 63

Instance Attribute Details

#endpoint_spec ⇒ DockerEngineRuby::Models::ServiceSpec::EndpointSpec?

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

Returns:



10
 
# File 'lib/docker_engine_ruby/models/service_spec.rb', line 10

optional :endpoint_spec, -> { DockerEngineRuby::ServiceSpec::EndpointSpec }, api_name: :EndpointSpec

#labels ⇒ Hash{Symbol=>String}?

User-defined key/value metadata.

Returns:

  • (Hash{Symbol=>String}, nil) 


16
 
# File 'lib/docker_engine_ruby/models/service_spec.rb', line 16

optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels

#mode ⇒ DockerEngineRuby::Models::ServiceSpec::Mode?

Scheduling mode for the service.

Returns:



22
 
# File 'lib/docker_engine_ruby/models/service_spec.rb', line 22

optional :mode, -> { DockerEngineRuby::ServiceSpec::Mode }, api_name: :Mode

#name ⇒ String?

Name of the service.

Returns:

  • (String, nil) 


28
 
# File 'lib/docker_engine_ruby/models/service_spec.rb', line 28

optional :name, String, api_name: :Name

#networks ⇒ Array<DockerEngineRuby::Models::ServiceSpec::Network>?

Specifies which networks the service should attach to.

Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead.

Returns:



37
38
39
 
# File 'lib/docker_engine_ruby/models/service_spec.rb', line 37

optional :networks,
-> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ServiceSpec::Network] },
api_name: :Networks

#rollback_config ⇒ DockerEngineRuby::Models::ServiceSpec::RollbackConfig?

Specification for the rollback strategy of the service.

Returns:



45
46
47
48
49
 
# File 'lib/docker_engine_ruby/models/service_spec.rb', line 45

optional :rollback_config,
-> {
  DockerEngineRuby::ServiceSpec::RollbackConfig
},
api_name: :RollbackConfig

#task_template ⇒ DockerEngineRuby::Models::TaskSpec?

User modifiable task configuration.

Returns:



55
 
# File 'lib/docker_engine_ruby/models/service_spec.rb', line 55

optional :task_template, -> { DockerEngineRuby::TaskSpec }, api_name: :TaskTemplate

#update_config ⇒ DockerEngineRuby::Models::ServiceSpec::UpdateConfig?

Specification for the update strategy of the service.

Returns:



61
 
# File 'lib/docker_engine_ruby/models/service_spec.rb', line 61

optional :update_config, -> { DockerEngineRuby::ServiceSpec::UpdateConfig }, api_name: :UpdateConfig

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/docker_engine_ruby/models/service_spec.rb', line 209