CreateQuotaRuleDetails¶

class oci.file_storage.models.CreateQuotaRuleDetails(**kwargs)¶

Bases: object

Details for creating a quota rule in the file system.

Attributes

`PRINCIPAL_TYPE_DEFAULT_GROUP`	A constant which can be used with the principal_type property of a CreateQuotaRuleDetails.
`PRINCIPAL_TYPE_DEFAULT_USER`	A constant which can be used with the principal_type property of a CreateQuotaRuleDetails.
`PRINCIPAL_TYPE_FILE_SYSTEM_LEVEL`	A constant which can be used with the principal_type property of a CreateQuotaRuleDetails.
`PRINCIPAL_TYPE_INDIVIDUAL_GROUP`	A constant which can be used with the principal_type property of a CreateQuotaRuleDetails.
`PRINCIPAL_TYPE_INDIVIDUAL_USER`	A constant which can be used with the principal_type property of a CreateQuotaRuleDetails.
`display_name`	Gets the display_name of this CreateQuotaRuleDetails.
`is_hard_quota`	[Required] Gets the is_hard_quota of this CreateQuotaRuleDetails.
`principal_id`	Gets the principal_id of this CreateQuotaRuleDetails.
`principal_type`	[Required] Gets the principal_type of this CreateQuotaRuleDetails.
`quota_limit_in_gigabytes`	[Required] Gets the quota_limit_in_gigabytes of this CreateQuotaRuleDetails.

Methods

__init__(**kwargs) Initializes a new CreateQuotaRuleDetails object with values from keyword arguments.

PRINCIPAL_TYPE_DEFAULT_GROUP = 'DEFAULT_GROUP'¶: A constant which can be used with the principal_type property of a CreateQuotaRuleDetails. This constant has a value of “DEFAULT_GROUP”

PRINCIPAL_TYPE_DEFAULT_USER = 'DEFAULT_USER'¶: A constant which can be used with the principal_type property of a CreateQuotaRuleDetails. This constant has a value of “DEFAULT_USER”

PRINCIPAL_TYPE_FILE_SYSTEM_LEVEL = 'FILE_SYSTEM_LEVEL'¶: A constant which can be used with the principal_type property of a CreateQuotaRuleDetails. This constant has a value of “FILE_SYSTEM_LEVEL”

PRINCIPAL_TYPE_INDIVIDUAL_GROUP = 'INDIVIDUAL_GROUP'¶: A constant which can be used with the principal_type property of a CreateQuotaRuleDetails. This constant has a value of “INDIVIDUAL_GROUP”

PRINCIPAL_TYPE_INDIVIDUAL_USER = 'INDIVIDUAL_USER'¶: A constant which can be used with the principal_type property of a CreateQuotaRuleDetails. This constant has a value of “INDIVIDUAL_USER”

__init__(**kwargs)¶

Initializes a new CreateQuotaRuleDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

principal_type (str) – The value to assign to the principal_type property of this CreateQuotaRuleDetails. Allowed values for this property are: “FILE_SYSTEM_LEVEL”, “DEFAULT_GROUP”, “DEFAULT_USER”, “INDIVIDUAL_GROUP”, “INDIVIDUAL_USER”
principal_id (int) – The value to assign to the principal_id property of this CreateQuotaRuleDetails.
is_hard_quota (bool) – The value to assign to the is_hard_quota property of this CreateQuotaRuleDetails.
display_name (str) – The value to assign to the display_name property of this CreateQuotaRuleDetails.
quota_limit_in_gigabytes (int) – The value to assign to the quota_limit_in_gigabytes property of this CreateQuotaRuleDetails.

display_name¶

Gets the display_name of this CreateQuotaRuleDetails. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: UserXYZ’s quota

Returns:	The display_name of this CreateQuotaRuleDetails.
Return type:	str

is_hard_quota¶

[Required] Gets the is_hard_quota of this CreateQuotaRuleDetails. 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:	The is_hard_quota of this CreateQuotaRuleDetails.
Return type:	bool

principal_id¶

Gets the principal_id of this CreateQuotaRuleDetails. 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:	The principal_id of this CreateQuotaRuleDetails.
Return type:	int

principal_type¶

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

Allowed values for this property are: “FILE_SYSTEM_LEVEL”, “DEFAULT_GROUP”, “DEFAULT_USER”, “INDIVIDUAL_GROUP”, “INDIVIDUAL_USER”

Returns:	The principal_type of this CreateQuotaRuleDetails.
Return type:	str

quota_limit_in_gigabytes¶

[Required] Gets the quota_limit_in_gigabytes of this CreateQuotaRuleDetails. The value of the quota rule in gigabytes.

Returns:	The quota_limit_in_gigabytes of this CreateQuotaRuleDetails.
Return type:	int