Class: OCI::FileStorage::Models::CreateFilesystemSnapshotPolicyDetails

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

Overview

Details for creating the file system snapshot policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFilesystemSnapshotPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 106

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  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

#availability_domain ⇒ String

[Required] The availability domain that the file system snapshot policy is in.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 16

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the file system snapshot policy.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

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


61
62
63
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 61

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) 


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

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


54
55
56
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 54

def freeform_tags
  @freeform_tags
end

#policy_prefix ⇒ String

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

Example: acme

Returns:

  • (String) 


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

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:



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

def schedules
  @schedules
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    '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.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 79

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



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 158

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 194

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


174
175
176
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 174

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



183
184
185
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 183

def hash
  [availability_domain, compartment_id, 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



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 227

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



221
222
223
 
# File 'lib/oci/file_storage/models/create_filesystem_snapshot_policy_details.rb', line 221

def to_s
  to_hash.to_s
end