Class: OCI::Batch::Models::NfsVolume

Inherits:
BatchTaskEnvironmentVolume show all
Defined in:
lib/oci/batch/models/nfs_volume.rb

Overview

A description of a NFS type of batch task environment volume.

Constant Summary

Constants inherited from BatchTaskEnvironmentVolume

BatchTaskEnvironmentVolume::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from BatchTaskEnvironmentVolume

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BatchTaskEnvironmentVolume

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ NfsVolume

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
90
91
92
93
# File 'lib/oci/batch/models/nfs_volume.rb', line 64

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

  attributes['type'] = 'NFS'

  super(attributes)

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

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

  self.mount_target_fqdn = attributes[:'mountTargetFqdn'] if attributes[:'mountTargetFqdn']

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

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

  self.mount_target_export_path = attributes[:'mountTargetExportPath'] if attributes[:'mountTargetExportPath']

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

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

  self.local_mount_directory_path = attributes[:'localMountDirectoryPath'] if attributes[:'localMountDirectoryPath']

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

  self.local_mount_directory_path = attributes[:'local_mount_directory_path'] if attributes[:'local_mount_directory_path']
end

Instance Attribute Details

#local_mount_directory_pathString

[Required] The local path to mount the NFS share to.

Returns:

  • (String)


26
27
28
# File 'lib/oci/batch/models/nfs_volume.rb', line 26

def local_mount_directory_path
  @local_mount_directory_path
end

#mount_target_export_pathString

[Required] The path to the directory on the NFS server to be mounted.

Returns:

  • (String)


22
23
24
# File 'lib/oci/batch/models/nfs_volume.rb', line 22

def mount_target_export_path
  @mount_target_export_path
end

#mount_target_fqdnString

[Required] The FQDN of the NFS server to connect to.

Returns:

  • (String)


18
19
20
# File 'lib/oci/batch/models/nfs_volume.rb', line 18

def mount_target_fqdn
  @mount_target_fqdn
end

#nameString

[Required] The name of the NfsVolume.

Returns:

  • (String)


14
15
16
# File 'lib/oci/batch/models/nfs_volume.rb', line 14

def name
  @name
end

Class Method Details

.attribute_mapObject

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



29
30
31
32
33
34
35
36
37
38
39
# File 'lib/oci/batch/models/nfs_volume.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'name': :'name',
    'mount_target_fqdn': :'mountTargetFqdn',
    'mount_target_export_path': :'mountTargetExportPath',
    'local_mount_directory_path': :'localMountDirectoryPath'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
# File 'lib/oci/batch/models/nfs_volume.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'name': :'String',
    'mount_target_fqdn': :'String',
    'mount_target_export_path': :'String',
    'local_mount_directory_path': :'String'
    # 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



102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/batch/models/nfs_volume.rb', line 102

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

  self.class == other.class &&
    type == other.type &&
    name == other.name &&
    mount_target_fqdn == other.mount_target_fqdn &&
    mount_target_export_path == other.mount_target_export_path &&
    local_mount_directory_path == other.local_mount_directory_path
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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/oci/batch/models/nfs_volume.rb', line 136

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


116
117
118
# File 'lib/oci/batch/models/nfs_volume.rb', line 116

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



125
126
127
# File 'lib/oci/batch/models/nfs_volume.rb', line 125

def hash
  [type, name, mount_target_fqdn, mount_target_export_path, local_mount_directory_path].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
# File 'lib/oci/batch/models/nfs_volume.rb', line 169

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



163
164
165
# File 'lib/oci/batch/models/nfs_volume.rb', line 163

def to_s
  to_hash.to_s
end