Class: OCI::FileStorage::Models::QuotaRuleSummary

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

Overview

Summary information for a principal's usage and quota rule.

Constant Summary collapse

PRINCIPAL_TYPE_ENUM = 
[
  PRINCIPAL_TYPE_FILE_SYSTEM_LEVEL = 'FILE_SYSTEM_LEVEL'.freeze,
  PRINCIPAL_TYPE_DEFAULT_GROUP = 'DEFAULT_GROUP'.freeze,
  PRINCIPAL_TYPE_DEFAULT_USER = 'DEFAULT_USER'.freeze,
  PRINCIPAL_TYPE_INDIVIDUAL_GROUP = 'INDIVIDUAL_GROUP'.freeze,
  PRINCIPAL_TYPE_INDIVIDUAL_USER = 'INDIVIDUAL_USER'.freeze,
  PRINCIPAL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QuotaRuleSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :file_system_id (String) —

    The value to assign to the #file_system_id property

  • :principal_type (String) —

    The value to assign to the #principal_type property

  • :principal_id (Integer) —

    The value to assign to the #principal_id property

  • :is_hard_quota (BOOLEAN) —

    The value to assign to the #is_hard_quota property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :usage_in_bytes (Integer) —

    The value to assign to the #usage_in_bytes property

  • :quota_limit_in_gigabytes (Integer) —

    The value to assign to the #quota_limit_in_gigabytes property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :are_violators_only (BOOLEAN) —

    The value to assign to the #are_violators_only property



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
208
209
210
211
212
213
214
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 145

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

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

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

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

  self.principal_id = attributes[:'principalId'] if attributes[:'principalId']

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

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

  self.is_hard_quota = attributes[:'isHardQuota'] unless attributes[:'isHardQuota'].nil?

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

  self.is_hard_quota = attributes[:'is_hard_quota'] unless attributes[:'is_hard_quota'].nil?

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

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

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

  self.quota_limit_in_gigabytes = attributes[:'quotaLimitInGigabytes'] if attributes[:'quotaLimitInGigabytes']

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

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

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

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

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

  self.are_violators_only = attributes[:'areViolatorsOnly'] unless attributes[:'areViolatorsOnly'].nil?
  self.are_violators_only = false if are_violators_only.nil? && !attributes.key?(:'areViolatorsOnly') # rubocop:disable Style/StringLiterals

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

  self.are_violators_only = attributes[:'are_violators_only'] unless attributes[:'are_violators_only'].nil?
  self.are_violators_only = false if are_violators_only.nil? && !attributes.key?(:'areViolatorsOnly') && !attributes.key?(:'are_violators_only') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#are_violators_only ⇒ BOOLEAN

An option to display only the users or groups that violate their quota rules. If areViolatorsOnly is false, results report all the quota and usage. If areViolatorsOnly is true, results only report the quota and usage for the users or groups that violate their quota rules.

Returns:

  • (BOOLEAN) 


88
89
90
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 88

def are_violators_only
  @are_violators_only
end

#display_name ⇒ String

A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ's quota

Returns:

  • (String) 


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

def display_name
  @display_name
end

#file_system_id ⇒ String

[Required] The OCID of the file system.

Returns:

  • (String) 


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

def file_system_id
  @file_system_id
end

#id ⇒ String

The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.

Returns:

  • (String) 


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

def id
  @id
end

#is_hard_quota ⇒ BOOLEAN

Whether the quota rule will be enforced. If isHardQuota is true, the quota rule is enforced so that the write is blocked if usage exceeds the hard quota limit. If isHardQuota is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.

Returns:

  • (BOOLEAN) 


47
48
49
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 47

def is_hard_quota
  @is_hard_quota
end

#principal_id ⇒ Integer

[Required] An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to identify a user or group to manage access control.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 39

def principal_id
  @principal_id
end

#principal_type ⇒ String

[Required] The type of the owner of this quota rule and usage.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 33

def principal_type
  @principal_type
end

#quota_limit_in_gigabytes ⇒ Integer

The value of the quota rule in gigabytes.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 64

def quota_limit_in_gigabytes
  @quota_limit_in_gigabytes
end

#time_created ⇒ DateTime

The date and time the quota rule was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 72

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 80

def time_updated
  @time_updated
end

#usage_in_bytes ⇒ Integer

[Required] The usage value corresponding to this principal in bytes.

Returns:

  • (Integer) 


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

def usage_in_bytes
  @usage_in_bytes
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'file_system_id': :'fileSystemId',
    'principal_type': :'principalType',
    'principal_id': :'principalId',
    'is_hard_quota': :'isHardQuota',
    'display_name': :'displayName',
    'usage_in_bytes': :'usageInBytes',
    'quota_limit_in_gigabytes': :'quotaLimitInGigabytes',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'are_violators_only': :'areViolatorsOnly'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'file_system_id': :'String',
    'principal_type': :'String',
    'principal_id': :'Integer',
    'is_hard_quota': :'BOOLEAN',
    'display_name': :'String',
    'usage_in_bytes': :'Integer',
    'quota_limit_in_gigabytes': :'Integer',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'are_violators_only': :'BOOLEAN'
    # 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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 236

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

  self.class == other.class &&
    id == other.id &&
    file_system_id == other.file_system_id &&
    principal_type == other.principal_type &&
    principal_id == other.principal_id &&
    is_hard_quota == other.is_hard_quota &&
    display_name == other.display_name &&
    usage_in_bytes == other.usage_in_bytes &&
    quota_limit_in_gigabytes == other.quota_limit_in_gigabytes &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    are_violators_only == other.are_violators_only
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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 276

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


256
257
258
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 256

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



265
266
267
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 265

def hash
  [id, file_system_id, principal_type, principal_id, is_hard_quota, display_name, usage_in_bytes, quota_limit_in_gigabytes, time_created, time_updated, are_violators_only].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 309

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



303
304
305
 
# File 'lib/oci/file_storage/models/quota_rule_summary.rb', line 303

def to_s
  to_hash.to_s
end