Class: OCI::ContainerInstances::Models::VolumeMount

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/container_instances/models/volume_mount.rb

Overview

Define the mapping from volume to a mount path in container.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeMount

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :mount_path (String) —

    The value to assign to the #mount_path property

  • :volume_name (String) —

    The value to assign to the #volume_name property

  • :sub_path (String) —

    The value to assign to the #sub_path property

  • :is_read_only (BOOLEAN) —

    The value to assign to the #is_read_only property

  • :partition (Integer) —

    The value to assign to the #partition property



75
76
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
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 75

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.mount_path = attributes[:'mountPath'] if attributes[:'mountPath']

  raise 'You cannot provide both :mountPath and :mount_path' if attributes.key?(:'mountPath') && attributes.key?(:'mount_path')

  self.mount_path = attributes[:'mount_path'] if attributes[:'mount_path']

  self.volume_name = attributes[:'volumeName'] if attributes[:'volumeName']

  raise 'You cannot provide both :volumeName and :volume_name' if attributes.key?(:'volumeName') && attributes.key?(:'volume_name')

  self.volume_name = attributes[:'volume_name'] if attributes[:'volume_name']

  self.sub_path = attributes[:'subPath'] if attributes[:'subPath']
  self.sub_path = "null" if sub_path.nil? && !attributes.key?(:'subPath') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :subPath and :sub_path' if attributes.key?(:'subPath') && attributes.key?(:'sub_path')

  self.sub_path = attributes[:'sub_path'] if attributes[:'sub_path']
  self.sub_path = "null" if sub_path.nil? && !attributes.key?(:'subPath') && !attributes.key?(:'sub_path') # rubocop:disable Style/StringLiterals

  self.is_read_only = attributes[:'isReadOnly'] unless attributes[:'isReadOnly'].nil?
  self.is_read_only = false if is_read_only.nil? && !attributes.key?(:'isReadOnly') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isReadOnly and :is_read_only' if attributes.key?(:'isReadOnly') && attributes.key?(:'is_read_only')

  self.is_read_only = attributes[:'is_read_only'] unless attributes[:'is_read_only'].nil?
  self.is_read_only = false if is_read_only.nil? && !attributes.key?(:'isReadOnly') && !attributes.key?(:'is_read_only') # rubocop:disable Style/StringLiterals

  self.partition = attributes[:'partition'] if attributes[:'partition']
  self.partition = 1 if partition.nil? && !attributes.key?(:'partition') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#is_read_only ⇒ BOOLEAN

Whether the volume was mounted in read-only mode. By default, the volume is mounted with write access.

Returns:

  • (BOOLEAN) 


26
27
28
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 26

def is_read_only
  @is_read_only
end

#mount_path ⇒ String

[Required] Describes the volume access path.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 14

def mount_path
  @mount_path
end

#partition ⇒ Integer

If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 36

def partition
  @partition
end

#sub_path ⇒ String

A sub-path inside the referenced volume.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 22

def sub_path
  @sub_path
end

#volume_name ⇒ String

[Required] The name of the volume.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 18

def volume_name
  @volume_name
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'mount_path': :'mountPath',
    'volume_name': :'volumeName',
    'sub_path': :'subPath',
    'is_read_only': :'isReadOnly',
    'partition': :'partition'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'mount_path': :'String',
    'volume_name': :'String',
    'sub_path': :'String',
    'is_read_only': :'BOOLEAN',
    'partition': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 120

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

  self.class == other.class &&
    mount_path == other.mount_path &&
    volume_name == other.volume_name &&
    sub_path == other.sub_path &&
    is_read_only == other.is_read_only &&
    partition == other.partition
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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 154

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

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


134
135
136
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 143

def hash
  [mount_path, volume_name, sub_path, is_read_only, partition].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 187

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



181
182
183
 
# File 'lib/oci/container_instances/models/volume_mount.rb', line 181

def to_s
  to_hash.to_s
end