Class: DockerEngineRuby::Models::SecretSpec

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/docker_engine_ruby/models/secret_spec.rb

Defined Under Namespace

Classes: Driver, Templating

Instance Attribute Summary

• #data ⇒ String^?

  Data is the data to store as a secret, formatted as a standard base64-encoded ([RFC 4648](tools.ietf.org/html/rfc4648#section-4)) string.

• #driver ⇒ DockerEngineRuby::Models::SecretSpec::Driver^?

  Driver represents a driver (network, logging, secrets).

• #labels ⇒ Hash{Symbol=>String}^?

  User-defined key/value metadata.

• #name ⇒ String^?

  User-defined name of the secret.

• #templating ⇒ DockerEngineRuby::Models::SecretSpec::Templating^?

  Driver represents a driver (network, logging, secrets).

Instance Method Summary

• #initialize(name:, options: nil) ⇒ Object constructor

  Driver represents a driver (network, logging, secrets).

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

Driver represents a driver (network, logging, secrets).

Parameters:

• name (String) —

  Name of the driver.

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

  Key/value map of driver-specific options.

# File 'lib/docker_engine_ruby/models/secret_spec.rb', line 40

Instance Attribute Details

#data ⇒ String^?

Data is the data to store as a secret, formatted as a standard base64-encoded ([RFC 4648](tools.ietf.org/html/rfc4648#section-4)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](pkg.go.dev/github.com/moby/swarmkit/v2

Returns:

• (String, nil)

# File 'lib/docker_engine_ruby/models/secret_spec.rb', line 14

optional :data, String, api_name: :Data

#driver ⇒ DockerEngineRuby::Models::SecretSpec::Driver^?

Driver represents a driver (network, logging, secrets).

Returns:

• (DockerEngineRuby::Models::SecretSpec::Driver, nil)

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

optional :driver, -> { DockerEngineRuby::SecretSpec::Driver }, api_name: :Driver

#labels ⇒ Hash{Symbol=>String}^?

User-defined key/value metadata.

Returns:

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

# File 'lib/docker_engine_ruby/models/secret_spec.rb', line 26

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

#name ⇒ String^?

User-defined name of the secret.

Returns:

• (String, nil)

# File 'lib/docker_engine_ruby/models/secret_spec.rb', line 32

optional :name, String, api_name: :Name

#templating ⇒ DockerEngineRuby::Models::SecretSpec::Templating^?

Driver represents a driver (network, logging, secrets).

Returns:

• (DockerEngineRuby::Models::SecretSpec::Templating, nil)

# File 'lib/docker_engine_ruby/models/secret_spec.rb', line 38

optional :templating, -> { DockerEngineRuby::SecretSpec::Templating }, api_name: :Templating