Class: OCI::LustreFileStorage::Models::ObjectStorageLink

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/lustre_file_storage/models/object_storage_link.rb

Overview

Object Storage links create the relationship between a directory in an File Storage with Lustre file system and a path within an Object Storage bucket. For more information, see Syncing Lustre file systems with Object Storage.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectStorageLink

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :lustre_file_system_id (String) —

    The value to assign to the #lustre_file_system_id property

  • :file_system_path (String) —

    The value to assign to the #file_system_path property

  • :object_storage_prefix (String) —

    The value to assign to the #object_storage_prefix property

  • :current_job_id (String) —

    The value to assign to the #current_job_id property

  • :last_job_id (String) —

    The value to assign to the #last_job_id property

  • :is_overwrite (BOOLEAN) —

    The value to assign to the #is_overwrite property



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 207

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.id = attributes[:'id'] if attributes[:'id']

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

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

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

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

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

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

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

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

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

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

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

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

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

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

  self.lustre_file_system_id = attributes[:'lustreFileSystemId'] if attributes[:'lustreFileSystemId']

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

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

  self.file_system_path = attributes[:'fileSystemPath'] if attributes[:'fileSystemPath']

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

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

  self.object_storage_prefix = attributes[:'objectStoragePrefix'] if attributes[:'objectStoragePrefix']

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

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

  self.current_job_id = attributes[:'currentJobId'] if attributes[:'currentJobId']

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

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

  self.last_job_id = attributes[:'lastJobId'] if attributes[:'lastJobId']

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

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

  self.is_overwrite = attributes[:'isOverwrite'] unless attributes[:'isOverwrite'].nil?

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

  self.is_overwrite = attributes[:'is_overwrite'] unless attributes[:'is_overwrite'].nil?
end

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain the file system is in. May be unset as a blank or NULL value.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 41

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the Lustre file system.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 33

def compartment_id
  @compartment_id
end

#current_job_id ⇒ String

The OCID of currently running sync job. If no sync job is running, then this will be empty.

Returns:

  • (String) 


121
122
123
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 121

def current_job_id
  @current_job_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


91
92
93
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 91

def defined_tags
  @defined_tags
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 Object Storage Link

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 50

def display_name
  @display_name
end

#file_system_path ⇒ String

[Required] The path in the Lustre file system used for this Object Storage link.

Example: myFileSystem/mount/myDirectory

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 110

def file_system_path
  @file_system_path
end

#freeform_tags ⇒ Hash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


83
84
85
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the ObjectStorageLink.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 29

def id
  @id
end

#is_overwrite ⇒ BOOLEAN

[Required] The flag is an identifier to tell whether the job run has overwrite enabled. If isOverwrite is false, the file to be imported or exported will be skipped if it already exists. If isOverwrite is true, the file to be imported or exported will be overwritten if it already exists.

Returns:

  • (BOOLEAN) 


132
133
134
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 132

def is_overwrite
  @is_overwrite
end

#last_job_id ⇒ String

The OCID of last succeeded sync job. If no sync job has previously run, then this will be empty.

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 125

def last_job_id
  @last_job_id
end

#lifecycle_details ⇒ String

A message that describes the current state of the Object Storage link in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 75

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Object Storage link.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 69

def lifecycle_state
  @lifecycle_state
end

#lustre_file_system_id ⇒ String

[Required] The OCID of the associated Lustre file system.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 103

def lustre_file_system_id
  @lustre_file_system_id
end

#object_storage_prefix ⇒ String

[Required] The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports.

Example: objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix

Returns:

  • (String) 


117
118
119
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 117

def object_storage_prefix
  @object_storage_prefix
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

[Required] System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


98
99
100
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 98

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the Lustre file system was created, expressed in RFC 3339 timestamp format.

Example: 2024-04-25T21:10:29.600Z

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 58

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the Object Storage link was updated, in the format defined by RFC 3339.

Example: 2024-04-25T21:10:29.600Z

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 65

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'availability_domain': :'availabilityDomain',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lustre_file_system_id': :'lustreFileSystemId',
    'file_system_path': :'fileSystemPath',
    'object_storage_prefix': :'objectStoragePrefix',
    'current_job_id': :'currentJobId',
    'last_job_id': :'lastJobId',
    'is_overwrite': :'isOverwrite'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 160

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'availability_domain': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lustre_file_system_id': :'String',
    'file_system_path': :'String',
    'object_storage_prefix': :'String',
    'current_job_id': :'String',
    'last_job_id': :'String',
    'is_overwrite': :'BOOLEAN'
    # 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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 332

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    availability_domain == other.availability_domain &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lustre_file_system_id == other.lustre_file_system_id &&
    file_system_path == other.file_system_path &&
    object_storage_prefix == other.object_storage_prefix &&
    current_job_id == other.current_job_id &&
    last_job_id == other.last_job_id &&
    is_overwrite == other.is_overwrite
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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 378

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


358
359
360
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 358

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



367
368
369
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 367

def hash
  [id, compartment_id, availability_domain, display_name, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags, lustre_file_system_id, file_system_path, object_storage_prefix, current_job_id, last_job_id, is_overwrite].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



411
412
413
414
415
416
417
418
419
420
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 411

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



405
406
407
 
# File 'lib/oci/lustre_file_storage/models/object_storage_link.rb', line 405

def to_s
  to_hash.to_s
end