Class: OCI::FileStorage::Models::CreateSnapshotDetails

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

Overview

Details for creating the snapshot.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSnapshotDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

  self.expiration_time = attributes[:'expirationTime'] if attributes[:'expirationTime']

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

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

  self.lock_duration_details = attributes[:'lockDurationDetails'] if attributes[:'lockDurationDetails']

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

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

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

Instance Attribute Details

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


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

def defined_tags
  @defined_tags
end

#expiration_time ⇒ DateTime

The time when this snapshot will be deleted.

Returns:

  • (DateTime) 


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

def expiration_time
  @expiration_time
end

#file_system_id ⇒ String

[Required] The OCID of the file system to take a snapshot of.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 13

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


39
40
41
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 39

def freeform_tags
  @freeform_tags
end

#lock_duration_details ⇒ OCI::FileStorage::Models::LockDurationDetails

Returns:



31
32
33
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 31

def lock_duration_details
  @lock_duration_details
end

#locks ⇒ Array<OCI::FileStorage::Models::ResourceLock>

Locks associated with this resource.

Returns:



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

def locks
  @locks
end

#name ⇒ String

[Required] Name of the snapshot. This value is immutable. It must also be unique with respect to all other non-DELETED snapshots on the associated file system.

Avoid entering confidential information.

Example: Sunday

Returns:

  • (String) 


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

def name
  @name
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
65
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'file_system_id': :'fileSystemId',
    'name': :'name',
    'expiration_time': :'expirationTime',
    'lock_duration_details': :'lockDurationDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'file_system_id': :'String',
    'name': :'String',
    'expiration_time': :'DateTime',
    'lock_duration_details': :'OCI::FileStorage::Models::LockDurationDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>'
    # 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



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 143

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

  self.class == other.class &&
    file_system_id == other.file_system_id &&
    name == other.name &&
    expiration_time == other.expiration_time &&
    lock_duration_details == other.lock_duration_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    locks == other.locks
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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 179

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


159
160
161
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 159

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 168

def hash
  [file_system_id, name, expiration_time, lock_duration_details, freeform_tags, defined_tags, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 212

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



206
207
208
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 206

def to_s
  to_hash.to_s
end