Class: Zilla::IoK8sApiCoreV1Secret

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/models/io_k8s_api_core_v1_secret.rb

Overview

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiCoreV1Secret

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 77

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiCoreV1Secret` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `Zilla::IoK8sApiCoreV1Secret`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end

    h[k.to_sym] = v
  end

  self.api_version = attributes[:api_version] if attributes.key?(:api_version)

  if attributes.key?(:data) && (value = attributes[:data]).is_a?(Hash)
    self.data = value
  end

  self.immutable = attributes[:immutable] if attributes.key?(:immutable)

  self.kind = attributes[:kind] if attributes.key?(:kind)

  self.metadata = attributes[:metadata] if attributes.key?(:metadata)

  if attributes.key?(:string_data) && (value = attributes[:string_data]).is_a?(Hash)
    self.string_data = value
  end

  return unless attributes.key?(:type)

  self.type = attributes[:type]
end

Instance Attribute Details

#api_version ⇒ Object

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources



20
21
22
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 20

def api_version
  @api_version
end

#data ⇒ Object

Data contains the secret data. Each key must consist of alphanumeric characters, ‘-’, ‘_’ or ‘.’. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in tools.ietf.org/html/rfc4648#section-4



23
24
25
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 23

def data
  @data
end

#immutable ⇒ Object

Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.



26
27
28
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 26

def immutable
  @immutable
end

#kind ⇒ Object

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds



29
30
31
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 29

def kind
  @kind
end

#metadata ⇒ Object

Returns the value of attribute metadata.



31
32
33
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 31

def metadata
  @metadata
end

#string_data ⇒ Object

stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 34

def string_data
  @string_data
end

#type ⇒ Object

Used to facilitate programmatic handling of secret data. More info: kubernetes.io/docs/concepts/configuration/secret/#secret-types



37
38
39
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 37

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 40

def self.attribute_map
  {
    api_version: :apiVersion,
    data: :data,
    immutable: :immutable,
    kind: :kind,
    metadata: :metadata,
    string_data: :stringData,
    type: :type
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



156
157
158
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 156

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 71

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 58

def self.openapi_types
  {
    api_version: :String,
    data: :'Hash<String, String>',
    immutable: :Boolean,
    kind: :String,
    metadata: :IoK8sApimachineryPkgApisMetaV1ObjectMeta,
    string_data: :'Hash<String, String>',
    type: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 128

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    api_version == other.api_version &&
    data == other.data &&
    immutable == other.immutable &&
    kind == other.kind &&
    metadata == other.metadata &&
    string_data == other.string_data &&
    type == other.type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



190
191
192
193
194
195
196
197
198
199
200
201
202
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
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 190

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Zilla.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 261

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 163

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(::Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


143
144
145
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



149
150
151
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 149

def hash
  [api_version, data, immutable, kind, metadata, string_data, type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



116
117
118
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 116

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 237

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 243

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



231
232
233
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 231

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



122
123
124
 
# File 'lib/zilla/models/io_k8s_api_core_v1_secret.rb', line 122

def valid?
  true
end