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

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

Overview

CreateSnapshotDetails model.

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

  • :file_system_id (String) —

    The value to assign to the #file_system_id property

  • :name (String) —

    The value to assign to the #name property



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

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

Instance Attribute Details

#file_system_id ⇒ String

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

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 11

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


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

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'file_system_id': :'fileSystemId',
    'name': :'name'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'file_system_id': :'String',
    'name': :'String'
    # 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



74
75
76
77
78
79
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 74

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



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/create_snapshot_details.rb', line 104

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


84
85
86
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 84

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



93
94
95
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 93

def hash
  [file_system_id, name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 136

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



130
131
132
 
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 130

def to_s
  to_hash.to_s
end