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

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

Instance Attribute 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



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 27

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

end

Instance Attribute Details

#file_system_idString

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

Returns:

  • (String)


9
10
11
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 9

def file_system_id
  @file_system_id
end

#nameString

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


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

def name
  @name
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object)

    to be compared



51
52
53
54
55
56
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 51

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 73

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


60
61
62
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 60

def eql?(other_object)
  self == other_object
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



66
67
68
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 66

def hash
  [file_system_id, name].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



98
99
100
101
102
103
104
105
106
# File 'lib/oci/file_storage/models/create_snapshot_details.rb', line 98

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



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

def to_s
  to_hash.to_s
end