Class: DockerEngineRuby::Models::Network::Ipam::Config

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

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(config: nil, driver: nil, options: nil) ⇒ Object

Some parameter documentations has been truncated, see DockerEngineRuby::Models::Network::Ipam for more details.

The network’s IP Address Management.

Parameters:

  • config (Array<DockerEngineRuby::Models::Network::Ipam::Config>) (defaults to: nil) —

    List of IPAM configuration options, specified as a map:

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

    Name of the IPAM driver to use.

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

    Driver-specific options, specified as a map.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/docker_engine_ruby/models/network.rb', line 203

class Config < DockerEngineRuby::Internal::Type::BaseModel
  # @!attribute auxiliary_addresses
  #
  #   @return [Hash{Symbol=>String}, nil]
  optional :auxiliary_addresses,
           DockerEngineRuby::Internal::Type::HashOf[String],
           api_name: :AuxiliaryAddresses

  # @!attribute gateway
  #
  #   @return [String, nil]
  optional :gateway, String, api_name: :Gateway

  # @!attribute ip_range
  #
  #   @return [String, nil]
  optional :ip_range, String, api_name: :IPRange

  # @!attribute subnet
  #
  #   @return [String, nil]
  optional :subnet, String, api_name: :Subnet

  # @!method initialize(auxiliary_addresses: nil, gateway: nil, ip_range: nil, subnet: nil)
  #   @param auxiliary_addresses [Hash{Symbol=>String}]
  #   @param gateway [String]
  #   @param ip_range [String]
  #   @param subnet [String]
end

Instance Attribute Details

#auxiliary_addresses ⇒ Hash{Symbol=>String}?

Returns:

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


207
208
209
 
# File 'lib/docker_engine_ruby/models/network.rb', line 207

optional :auxiliary_addresses,
DockerEngineRuby::Internal::Type::HashOf[String],
api_name: :AuxiliaryAddresses

#gateway ⇒ String?

Returns:

  • (String, nil) 


214
 
# File 'lib/docker_engine_ruby/models/network.rb', line 214

optional :gateway, String, api_name: :Gateway

#ip_range ⇒ String?

Returns:

  • (String, nil) 


219
 
# File 'lib/docker_engine_ruby/models/network.rb', line 219

optional :ip_range, String, api_name: :IPRange

#subnet ⇒ String?

Returns:

  • (String, nil) 


224
 
# File 'lib/docker_engine_ruby/models/network.rb', line 224

optional :subnet, String, api_name: :Subnet