Class: OCI::FileStorage::Models::UpdateFilesystemSnapshotPolicyDetails

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

Overview

Details for updating the file system snapshot policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateFilesystemSnapshotPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



89
90
91
92
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
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 89

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

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

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

  self.policy_prefix = attributes[:'policyPrefix'] if attributes[:'policyPrefix']

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

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

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

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: policy1

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 17

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


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

def freeform_tags
  @freeform_tags
end

#policy_prefix ⇒ String

The prefix to apply to all snapshots created by this policy.

Example: acme

Returns:

  • (String) 


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

def policy_prefix
  @policy_prefix
end

#schedules ⇒ Array<OCI::FileStorage::Models::SnapshotSchedule>

The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.

If using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in quotation marks, i.e. --schedules '[{\"timeZone\":\"UTC\",\"period\":\"DAILY\",\"hourOfDay\":18},{\"timeZone\":\"UTC\",\"period\":\"HOURLY\"}]'

Returns:



35
36
37
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 35

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'policy_prefix': :'policyPrefix',
    'schedules': :'schedules',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 66

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'policy_prefix': :'String',
    'schedules': :'Array<OCI::FileStorage::Models::SnapshotSchedule>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 129

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

  self.class == other.class &&
    display_name == other.display_name &&
    policy_prefix == other.policy_prefix &&
    schedules == other.schedules &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 163

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


143
144
145
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 152

def hash
  [display_name, policy_prefix, schedules, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 196

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



190
191
192
 
# File 'lib/oci/file_storage/models/update_filesystem_snapshot_policy_details.rb', line 190

def to_s
  to_hash.to_s
end