Class: OCI::FileStorage::Models::MountTarget

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/file_storage/models/mount_target.rb

Overview

Provides access to a collection of file systems through one or more VNICs on a specified subnet. The set of file systems is controlled through the referenced export set.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_FAILED = 'FAILED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MountTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :export_set_id (String) —

    The value to assign to the #export_set_id property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :private_ip_ids (Array<String>) —

    The value to assign to the #private_ip_ids property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 87

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}

  if attributes[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end

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

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

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

  if attributes[:'exportSetId']
    self.export_set_id = attributes[:'exportSetId']
  end

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

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

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

  if attributes[:'lifecycleDetails']
    self.lifecycle_details = attributes[:'lifecycleDetails']
  end

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

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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

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

  if attributes[:'privateIpIds']
    self.private_ip_ids = attributes[:'privateIpIds']
  end

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

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

  if attributes[:'subnetId']
    self.subnet_id = attributes[:'subnetId']
  end

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

end

Instance Attribute Details

#availability_domain ⇒ String

The availability domain the mount target is in. May be unset as a blank or NULL value.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 25

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the mount target.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 29

def compartment_id
  @compartment_id
end

#display_name ⇒ String

[Required] A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: ‘My mount target`

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 37

def display_name
  @display_name
end

#export_set_id ⇒ String

The OCID of the associated export set. Controls what file systems will be exported through Network File System (NFS) protocol on this mount target.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 44

def export_set_id
  @export_set_id
end

#id ⇒ String

[Required] The OCID of the mount target.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 48

def id
  @id
end

#lifecycle_details ⇒ String

[Required] Additional information about the current ‘lifecycleState’.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 52

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the mount target.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 56

def lifecycle_state
  @lifecycle_state
end

#private_ip_ids ⇒ Array<String>

[Required] The OCIDs of the private IP addresses associated with this mount target.

Returns:

  • (Array<String>) 


60
61
62
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 60

def private_ip_ids
  @private_ip_ids
end

#subnet_id ⇒ String

[Required] The OCID of the subnet the mount target is in.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 64

def subnet_id
  @subnet_id
end

#time_created ⇒ DateTime

[Required] The date and time the mount target was created, expressed in [RFC 3339](tools.ietf.org/rfc/rfc3339) timestamp format.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 72

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 201

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      export_set_id == other_object.export_set_id &&
      id == other_object.id &&
      lifecycle_details == other_object.lifecycle_details &&
      lifecycle_state == other_object.lifecycle_state &&
      private_ip_ids == other_object.private_ip_ids &&
      subnet_id == other_object.subnet_id &&
      time_created == other_object.time_created
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 231

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 218

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



224
225
226
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 224

def hash
  [availability_domain, compartment_id, display_name, export_set_id, id, lifecycle_details, lifecycle_state, private_ip_ids, subnet_id, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 256

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



250
251
252
 
# File 'lib/oci/file_storage/models/mount_target.rb', line 250

def to_s
  to_hash.to_s
end