Class: OCI::FileStorage::Models::QuotaRule

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

Overview

A rule that can restrict the logical space that a user or group can consume in a file system.

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 = {}) ⇒ QuotaRule

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

  • :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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 126

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.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']
end

Instance Attribute Details

#display_name ⇒ String

[Required] 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.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.rb', line 28

def file_system_id
  @file_system_id
end

#id ⇒ String

[Required] 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.rb', line 24

def id
  @id
end

#is_hard_quota ⇒ BOOLEAN

[Required] 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.rb', line 47

def is_hard_quota
  @is_hard_quota
end

#principal_id ⇒ Integer

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.rb', line 39

def principal_id
  @principal_id
end

#principal_type ⇒ String

The type of the owner of this quota rule and usage.

Returns:

  • (String) 


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

def principal_type
  @principal_type
end

#quota_limit_in_gigabytes ⇒ Integer

[Required] The value of the quota rule in gigabytes.

Returns:

  • (Integer) 


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

def quota_limit_in_gigabytes
  @quota_limit_in_gigabytes
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 67

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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


75
76
77
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 75

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'quota_limit_in_gigabytes': :'quotaLimitInGigabytes',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 95

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',
    'quota_limit_in_gigabytes': :'Integer',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 203

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 &&
    quota_limit_in_gigabytes == other.quota_limit_in_gigabytes &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 241

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 230

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
283
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 274

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



268
269
270
 
# File 'lib/oci/file_storage/models/quota_rule.rb', line 268

def to_s
  to_hash.to_s
end