Class: OCI::FileStorage::Models::SnapshotSummary

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

Overview

Summary information for a snapshot.

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 = {}) ⇒ SnapshotSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

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

  • :name (String) —

    The value to assign to the #name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 55

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

#file_system_id ⇒ String

[Required] The OCID of the file system from which the snapshot was created.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 20

def file_system_id
  @file_system_id
end

#id ⇒ String

[Required] The OCID of the snapshot.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 24

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the snapshot.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 28

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] Name of the snapshot. This value is immutable.

Avoid entering confidential information.

Example: ‘Sunday`

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 37

def name
  @name
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 45

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



113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 113

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 138

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


125
126
127
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 125

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 131

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



163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 163

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



157
158
159
 
# File 'lib/oci/file_storage/models/snapshot_summary.rb', line 157

def to_s
  to_hash.to_s
end