Class: OCI::FileStorage::Models::CreateQuotaRuleDetails

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

Overview

Details for creating a quota rule in the 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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateQuotaRuleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

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



87
88
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
121
122
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 87

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

Instance Attribute Details

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


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

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


36
37
38
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 36

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) 


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

def principal_id
  @principal_id
end

#principal_type ⇒ String

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 22

def principal_type
  @principal_type
end

#quota_limit_in_gigabytes ⇒ Integer

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

Returns:

  • (Integer) 


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

def quota_limit_in_gigabytes
  @quota_limit_in_gigabytes
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'principal_type': :'principalType',
    'principal_id': :'principalId',
    'is_hard_quota': :'isHardQuota',
    'display_name': :'displayName',
    'quota_limit_in_gigabytes': :'quotaLimitInGigabytes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 139

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

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 173

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


153
154
155
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 162

def hash
  [principal_type, principal_id, is_hard_quota, display_name, quota_limit_in_gigabytes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 206

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



200
201
202
 
# File 'lib/oci/file_storage/models/create_quota_rule_details.rb', line 200

def to_s
  to_hash.to_s
end