Class: OCI::FileStorage::Models::ExportSummary

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

Overview

Summary information for an export.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =

rubocop:disable Metrics/LineLength

[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ ExportSummary

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



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

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

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

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

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

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

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

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

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

  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']
end

Instance Attribute Details

#export_set_id ⇒ String

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

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 21

def export_set_id
  @export_set_id
end

#file_system_id ⇒ String

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

Returns:

  • (String) 


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

def file_system_id
  @file_system_id
end

#id ⇒ String

[Required] The OCID of this export.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of this export.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 33

def lifecycle_state
  @lifecycle_state
end

#path ⇒ String

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

Avoid entering confidential information.

Example: ‘/mediafiles`

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 42

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) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'export_set_id': :'exportSetId',
    'file_system_id': :'fileSystemId',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'path': :'path',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 67

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'export_set_id': :'String',
    'file_system_id': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'path': :'String',
    'time_created': :'DateTime'
    # 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



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 149

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

  self.class == other.class &&
    export_set_id == other.export_set_id &&
    file_system_id == other.file_system_id &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    path == other.path &&
    time_created == other.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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 184

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


164
165
166
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 164

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/oci/file_storage/models/export_summary.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



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 217

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



211
212
213
 
# File 'lib/oci/file_storage/models/export_summary.rb', line 211

def to_s
  to_hash.to_s
end