Class: OCI::FileStorage::Models::FilesystemSnapshotPolicySummary

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

Overview

Summary information for a file system snapshot policy.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilesystemSnapshotPolicySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :locks (Array<OCI::FileStorage::Models::ResourceLock>) —

    The value to assign to the #locks property

  • :policy_prefix (String) —

    The value to assign to the #policy_prefix property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 144

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

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

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

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

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

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

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_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) 


27
28
29
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 27

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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


81
82
83
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 81

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: My Filesystem Snapshot Policy

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 48

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


74
75
76
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 74

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of this file system snapshot policy.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 40

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



59
60
61
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 59

def locks
  @locks
end

#policy_prefix ⇒ String

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

Example: acme

Returns:

  • (String) 


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

def policy_prefix
  @policy_prefix
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. System tags are applied to resources by internal OCI services.

Returns:

  • (Hash<String, Hash<String, Object>>) 


87
88
89
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 87

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time that the file system snapshot policy was created in RFC 3339 timestamp format. Example: 2020-02-04T21:10:29.600Z

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 55

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 90

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'locks': :'locks',
    'policy_prefix': :'policyPrefix',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'locks': :'Array<OCI::FileStorage::Models::ResourceLock>',
    'policy_prefix': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 229

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    locks == other.locks &&
    policy_prefix == other.policy_prefix &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 269

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


249
250
251
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 249

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



258
259
260
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 258

def hash
  [availability_domain, compartment_id, id, lifecycle_state, display_name, time_created, locks, policy_prefix, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 302

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



296
297
298
 
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy_summary.rb', line 296

def to_s
  to_hash.to_s
end