Class: DockerEngineRuby::Models::ConfigObject

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• DockerEngineRuby::Models::ConfigObject

Defined in:

lib/docker_engine_ruby/models/config_object.rb

Overview

See Also:

• Resources::Configs#inspect_

Defined Under Namespace

Classes: Version

Instance Attribute Summary

• #created_at ⇒ Time^?
• #id ⇒ String^?
• #spec ⇒ DockerEngineRuby::Models::ConfigSpec^?
• #updated_at ⇒ Time^?
• #version ⇒ DockerEngineRuby::Models::ConfigObject::Version^?

  The version number of the object such as node, service, etc.

Instance Method Summary

• #initialize(created_at: nil, id: nil, spec: nil, updated_at: nil, version: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see ConfigObject 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(created_at: nil, id: nil, spec: nil, updated_at: nil, version: nil) ⇒ Object

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

Parameters:

• created_at (Time) (defaults to: nil)
• id (String) (defaults to: nil)
• spec (DockerEngineRuby::Models::ConfigSpec) (defaults to: nil)
• updated_at (Time) (defaults to: nil)
• version (DockerEngineRuby::Models::ConfigObject::Version) (defaults to: nil) —

  The version number of the object such as node, service, etc. This is needed

# File 'lib/docker_engine_ruby/models/config_object.rb', line 41

Instance Attribute Details

#created_at ⇒ Time^?

Returns:

• (Time, nil)

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

optional :created_at, Time, api_name: :CreatedAt

#id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/docker_engine_ruby/models/config_object.rb', line 15

optional :id, String, api_name: :ID

#spec ⇒ DockerEngineRuby::Models::ConfigSpec^?

Returns:

• (DockerEngineRuby::Models::ConfigSpec, nil)

# File 'lib/docker_engine_ruby/models/config_object.rb', line 20

optional :spec, -> { DockerEngineRuby::ConfigSpec }, api_name: :Spec

#updated_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/docker_engine_ruby/models/config_object.rb', line 25

optional :updated_at, Time, api_name: :UpdatedAt

#version ⇒ DockerEngineRuby::Models::ConfigObject::Version^?

The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects.

This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other.

Returns:

• (DockerEngineRuby::Models::ConfigObject::Version, nil)

# File 'lib/docker_engine_ruby/models/config_object.rb', line 39

optional :version, -> { DockerEngineRuby::ConfigObject::Version }, api_name: :Version