Class: DockerEngineAPI::Models::SwarmUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• DockerEngineAPI::Models::SwarmUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/docker_engine_api/models/swarm_update_params.rb

Overview

See Also:

• Resources::Swarm#update

Instance Attribute Summary

• #rotate_manager_token ⇒ Boolean^?

  Rotate the manager join token.

• #rotate_manager_unlock_key ⇒ Boolean^?

  Rotate the manager unlock key.

• #rotate_worker_token ⇒ Boolean^?

  Rotate the worker join token.

• #version ⇒ Integer

  The version number of the swarm object being updated.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(version:, rotate_manager_token: nil, rotate_manager_unlock_key: nil, rotate_worker_token: nil, request_options: {}) ⇒ Object constructor

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

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(version:, rotate_manager_token: nil, rotate_manager_unlock_key: nil, rotate_worker_token: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see DockerEngineAPI::Models::SwarmUpdateParams for more details.

Parameters:

• version (Integer) —

  The version number of the swarm object being updated. This is

• rotate_manager_token (Boolean) (defaults to: nil) —

  Rotate the manager join token.

• rotate_manager_unlock_key (Boolean) (defaults to: nil) —

  Rotate the manager unlock key.

• rotate_worker_token (Boolean) (defaults to: nil) —

  Rotate the worker join token.

• request_options (DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/docker_engine_api/models/swarm_update_params.rb', line 35

Instance Attribute Details

#rotate_manager_token ⇒ Boolean^?

Rotate the manager join token.

Returns:

• (Boolean, nil)

# File 'lib/docker_engine_api/models/swarm_update_params.rb', line 21

optional :rotate_manager_token, DockerEngineAPI::Internal::Type::Boolean

#rotate_manager_unlock_key ⇒ Boolean^?

Rotate the manager unlock key.

Returns:

• (Boolean, nil)

# File 'lib/docker_engine_api/models/swarm_update_params.rb', line 27

optional :rotate_manager_unlock_key, DockerEngineAPI::Internal::Type::Boolean

#rotate_worker_token ⇒ Boolean^?

Rotate the worker join token.

Returns:

• (Boolean, nil)

# File 'lib/docker_engine_api/models/swarm_update_params.rb', line 33

optional :rotate_worker_token, DockerEngineAPI::Internal::Type::Boolean

#version ⇒ Integer

The version number of the swarm object being updated. This is required to avoid conflicting writes.

Returns:

• (Integer)

# File 'lib/docker_engine_api/models/swarm_update_params.rb', line 15

required :version, Integer