Class: PulpContainerClient::OCIBuildImage

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_container_client/models/oci_build_image.rb

Overview

Serializer for building an OCI container image from a Containerfile. The Containerfile can either be specified via an artifact url, or a new file can be uploaded. A repository must be specified, to which the container image content will be added.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OCIBuildImage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 59

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PulpContainerClient::OCIBuildImage` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PulpContainerClient::OCIBuildImage`. 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
  }

  if attributes.key?(:'containerfile_name')
    self.containerfile_name = attributes[:'containerfile_name']
  end

  if attributes.key?(:'containerfile')
    self.containerfile = attributes[:'containerfile']
  end

  if attributes.key?(:'tag')
    self.tag = attributes[:'tag']
  else
    self.tag = 'latest'
  end

  if attributes.key?(:'build_context')
    self.build_context = attributes[:'build_context']
  end
end

Instance Attribute Details

#build_contextObject

RepositoryVersion to be used as the build context for container images.



28
29
30
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 28

def build_context
  @build_context
end

#containerfileObject

An uploaded Containerfile that should be used to run podman-build.



22
23
24
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 22

def containerfile
  @containerfile
end

#containerfile_nameObject

Name of the Containerfile, from build_context, that should be used to run podman-build.



19
20
21
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 19

def containerfile_name
  @containerfile_name
end

#tagObject

A tag name for the new image being built.



25
26
27
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 25

def tag
  @tag
end

Class Method Details

.attribute_mapObject

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



31
32
33
34
35
36
37
38
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 31

def self.attribute_map
  {
    :'containerfile_name' => :'containerfile_name',
    :'containerfile' => :'containerfile',
    :'tag' => :'tag',
    :'build_context' => :'build_context'
  }
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



145
146
147
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 145

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

.openapi_nullableObject

List of attributes with nullable: true



51
52
53
54
55
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 51

def self.openapi_nullable
  Set.new([
    :'build_context'
  ])
end

.openapi_typesObject

Attribute type mapping.



41
42
43
44
45
46
47
48
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 41

def self.openapi_types
  {
    :'containerfile_name' => :'String',
    :'containerfile' => :'File',
    :'tag' => :'String',
    :'build_context' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



121
122
123
124
125
126
127
128
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      containerfile_name == o.containerfile_name &&
      containerfile == o.containerfile &&
      tag == o.tag &&
      build_context == o.build_context
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 173

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    PulpContainerClient.const_get(type).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



242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 242

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 152

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


132
133
134
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 132

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



138
139
140
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 138

def hash
  [containerfile_name, containerfile, tag, build_context].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



93
94
95
96
97
98
99
100
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 93

def list_invalid_properties
  invalid_properties = Array.new
  if !@tag.nil? && @tag.to_s.length < 1
    invalid_properties.push('invalid value for "tag", the character length must be great than or equal to 1.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



218
219
220
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 218

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 224

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



212
213
214
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 212

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



104
105
106
107
# File 'lib/pulp_container_client/models/oci_build_image.rb', line 104

def valid?
  return false if !@tag.nil? && @tag.to_s.length < 1
  true
end