Class: OCI::FileStorage::Models::Export

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

Overview

A file system and the path that you can use to mount it. Each export resource belongs to exactly one export set.

The export’s path attribute is not a path in the referenced file system, but the value used by clients for the path component of the remotetarget argument when mounting the file system.

The path must start with a slash (/) followed by a sequence of zero or more slash-separated path elements. For any two export resources associated with the same export set, except those in a ‘DELETED’ state, the path element sequence for the first export resource can’t contain the complete path element sequence of the second export resource.

For example, the following are acceptable:

* /foo and /bar
* /foo1 and /foo2
* /foo and /foo1

The following examples are not acceptable:

* /foo and /foo/bar
* / and /foo

Paths may not end in a slash (/). No path element can be a period (.) or two periods in sequence (..). All path elements must be 255 bytes or less.

No two non-‘DELETED’ export resources in the same export set can reference the same file system.

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Export

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :export_set_id (String) —

    The value to assign to the #export_set_id property

  • :file_system_id (String) —

    The value to assign to the #file_system_id property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :path (String) —

    The value to assign to the #path property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



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
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
 
# File 'lib/oci/file_storage/models/export.rb', line 86

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[:'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[:'fileSystemId']
    self.file_system_id = attributes[:'fileSystemId']
  end

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

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

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

#export_set_id ⇒ String

[Required] The OCID of this export’s export set.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/file_storage/models/export.rb', line 46

def export_set_id
  @export_set_id
end

#file_system_id ⇒ String

[Required] The OCID of this export’s file system.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/file_storage/models/export.rb', line 50

def file_system_id
  @file_system_id
end

#id ⇒ String

[Required] The OCID of this export.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/file_storage/models/export.rb', line 54

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of this export.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/file_storage/models/export.rb', line 58

def lifecycle_state
  @lifecycle_state
end

#path ⇒ String

[Required] Path used to access the associated file system.

Avoid entering confidential information.

Example: ‘/accounting`

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/file_storage/models/export.rb', line 67

def path
  @path
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


75
76
77
 
# File 'lib/oci/file_storage/models/export.rb', line 75

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



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/file_storage/models/export.rb', line 154

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      export_set_id == other_object.export_set_id &&
      file_system_id == other_object.file_system_id &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      path == other_object.path &&
      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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/file_storage/models/export.rb', line 180

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


167
168
169
 
# File 'lib/oci/file_storage/models/export.rb', line 167

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/oci/file_storage/models/export.rb', line 173

def hash
  [export_set_id, file_system_id, id, lifecycle_state, path, 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



205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/file_storage/models/export.rb', line 205

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



199
200
201
 
# File 'lib/oci/file_storage/models/export.rb', line 199

def to_s
  to_hash.to_s
end