QuotaRule¶

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

Bases: object

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

Attributes

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

Methods

__init__(**kwargs) Initializes a new QuotaRule 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 QuotaRule. 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 QuotaRule. 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 QuotaRule. 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 QuotaRule. 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 QuotaRule. This constant has a value of “INDIVIDUAL_USER”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this QuotaRule.
file_system_id (str) – The value to assign to the file_system_id property of this QuotaRule.
principal_type (str) – The value to assign to the principal_type property of this QuotaRule. Allowed values for this property are: “FILE_SYSTEM_LEVEL”, “DEFAULT_GROUP”, “DEFAULT_USER”, “INDIVIDUAL_GROUP”, “INDIVIDUAL_USER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
principal_id (int) – The value to assign to the principal_id property of this QuotaRule.
is_hard_quota (bool) – The value to assign to the is_hard_quota property of this QuotaRule.
display_name (str) – The value to assign to the display_name property of this QuotaRule.
quota_limit_in_gigabytes (int) – The value to assign to the quota_limit_in_gigabytes property of this QuotaRule.
time_created (datetime) – The value to assign to the time_created property of this QuotaRule.
time_updated (datetime) – The value to assign to the time_updated property of this QuotaRule.

display_name¶

[Required] Gets the display_name of this QuotaRule. 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 QuotaRule.
Return type:	str

file_system_id¶

[Required] Gets the file_system_id of this QuotaRule. The OCID of the file System.

Returns:	The file_system_id of this QuotaRule.
Return type:	str

id¶

[Required] Gets the id of this QuotaRule. The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.

Returns:	The id of this QuotaRule.
Return type:	str

is_hard_quota¶

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

principal_id¶

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

principal_type¶

Gets the principal_type of this QuotaRule. 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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

quota_limit_in_gigabytes¶

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

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

time_created¶

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

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

Returns:	The time_created of this QuotaRule.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this QuotaRule. The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format.

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

Returns:	The time_updated of this QuotaRule.
Return type:	datetime