Class: OCI::LustreFileStorage::Models::CreateObjectStorageLinkDetails

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

Overview

The details to create a Object Storage link.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateObjectStorageLinkDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

  • :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

  • :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

  • :is_overwrite (BOOLEAN) —

    The value to assign to the #is_overwrite property



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
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 122

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.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.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.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.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 that the Lustre file system is in. May be unset as a blank or NULL value.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 21

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the Object Storage link.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 13

def compartment_id
  @compartment_id
end

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

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>>) 


45
46
47
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 45

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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) 


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

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) 


57
58
59
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 57

def file_system_path
  @file_system_path
end

#freeform_tags ⇒ Hash<String, String>

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>) 


37
38
39
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 37

def freeform_tags
  @freeform_tags
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) 


71
72
73
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 71

def is_overwrite
  @is_overwrite
end

#lustre_file_system_id ⇒ String

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

Returns:

  • (String) 


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

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) 


64
65
66
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 64

def object_storage_prefix
  @object_storage_prefix
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 74

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'availability_domain': :'availabilityDomain',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lustre_file_system_id': :'lustreFileSystemId',
    'file_system_path': :'fileSystemPath',
    'object_storage_prefix': :'objectStoragePrefix',
    'is_overwrite': :'isOverwrite'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 91

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'availability_domain': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lustre_file_system_id': :'String',
    'file_system_path': :'String',
    'object_storage_prefix': :'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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 190

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    availability_domain == other.availability_domain &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lustre_file_system_id == other.lustre_file_system_id &&
    file_system_path == other.file_system_path &&
    object_storage_prefix == other.object_storage_prefix &&
    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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 228

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


208
209
210
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 208

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 217

def hash
  [compartment_id, availability_domain, display_name, freeform_tags, defined_tags, lustre_file_system_id, file_system_path, object_storage_prefix, 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



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 261

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



255
256
257
 
# File 'lib/oci/lustre_file_storage/models/create_object_storage_link_details.rb', line 255

def to_s
  to_hash.to_s
end