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 =
[
  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



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

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_idString

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

Returns:

  • (String)


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

def export_set_id
  @export_set_id
end

#file_system_idString

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

Returns:

  • (String)


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

def file_system_id
  @file_system_id
end

#idString

[Required] The OCID of this export.

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_stateString

[Required] The current state of this export.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#pathString

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

Avoid entering confidential information.

Example: /mediafiles

Returns:

  • (String)


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

def path
  @path
end

#time_createdDateTime

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

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

Class Method Details

.attribute_mapObject

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



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

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_typesObject

Attribute type mapping.



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

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



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

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



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

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


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

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



172
173
174
# File 'lib/oci/file_storage/models/export_summary.rb', line 172

def hash
  [export_set_id, file_system_id, id, lifecycle_state, path, time_created].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



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

def to_s
  to_hash.to_s
end