QuotaRuleSummary¶

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

Bases: object

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

Attributes

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

Methods

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

__init__(**kwargs)¶

Initializes a new QuotaRuleSummary 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 QuotaRuleSummary.
file_system_id (str) – The value to assign to the file_system_id property of this QuotaRuleSummary.
principal_type (str) – The value to assign to the principal_type property of this QuotaRuleSummary. 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 QuotaRuleSummary.
is_hard_quota (bool) – The value to assign to the is_hard_quota property of this QuotaRuleSummary.
display_name (str) – The value to assign to the display_name property of this QuotaRuleSummary.
usage_in_bytes (int) – The value to assign to the usage_in_bytes property of this QuotaRuleSummary.
quota_limit_in_gigabytes (int) – The value to assign to the quota_limit_in_gigabytes property of this QuotaRuleSummary.
time_created (datetime) – The value to assign to the time_created property of this QuotaRuleSummary.
time_updated (datetime) – The value to assign to the time_updated property of this QuotaRuleSummary.
are_violators_only (bool) – The value to assign to the are_violators_only property of this QuotaRuleSummary.

are_violators_only¶

Gets the are_violators_only of this QuotaRuleSummary. 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:	The are_violators_only of this QuotaRuleSummary.
Return type:	bool

display_name¶

Gets the display_name of this QuotaRuleSummary. 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 QuotaRuleSummary.
Return type:	str

file_system_id¶

[Required] Gets the file_system_id of this QuotaRuleSummary. The OCID of the file system.

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

id¶

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

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

is_hard_quota¶

Gets the is_hard_quota of this QuotaRuleSummary. 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 QuotaRuleSummary.
Return type:	bool

principal_id¶

[Required] Gets the principal_id of this QuotaRuleSummary. 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 QuotaRuleSummary.
Return type:	int

principal_type¶

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

quota_limit_in_gigabytes¶

Gets the quota_limit_in_gigabytes of this QuotaRuleSummary. The value of the quota rule in gigabytes.

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

time_created¶

Gets the time_created of this QuotaRuleSummary. 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 QuotaRuleSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this QuotaRuleSummary. 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 QuotaRuleSummary.
Return type:	datetime

usage_in_bytes¶

[Required] Gets the usage_in_bytes of this QuotaRuleSummary. The usage value corresponding to this principal in bytes.

Returns:	The usage_in_bytes of this QuotaRuleSummary.
Return type:	int