@Generated(value="OracleSDKGenerator", comments="API Version: 20171215") public final class QuotaRuleSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Summary information for a principal’s usage and quota rule.
Note: Objects should always be created or deserialized using the QuotaRuleSummary.Builder
. This model
distinguishes fields that are null
because they are unset from fields that are explicitly
set to null
. This is done in the setter methods of the QuotaRuleSummary.Builder
, which maintain a
set of all explicitly set fields called QuotaRuleSummary.Builder.__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
QuotaRuleSummary.Builder |
static class |
QuotaRuleSummary.PrincipalType
The type of the owner of this quota rule and usage.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
QuotaRuleSummary(String id,
String fileSystemId,
QuotaRuleSummary.PrincipalType principalType,
Integer principalId,
Boolean isHardQuota,
String displayName,
Long usageInBytes,
Integer quotaLimitInGigabytes,
Date timeCreated,
Date timeUpdated,
Boolean areViolatorsOnly)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static QuotaRuleSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Boolean |
getAreViolatorsOnly()
An option to display only the users or groups that violate their quota rules.
|
String |
getDisplayName()
A user-friendly name.
|
String |
getFileSystemId()
The OCID of the file
system.
|
String |
getId()
The identifier of the quota rule.
|
Boolean |
getIsHardQuota()
Whether the quota rule will be enforced.
|
Integer |
getPrincipalId()
An identifier for the user or the group associated with quota rule and usage.
|
QuotaRuleSummary.PrincipalType |
getPrincipalType()
The type of the owner of this quota rule and usage.
|
Integer |
getQuotaLimitInGigabytes()
The value of the quota rule in gigabytes.
|
Date |
getTimeCreated()
The date and time the quota rule was created, expressed in RFC
3339 timestamp format.
|
Date |
getTimeUpdated()
The date and time the quota rule was last updated, expressed in RFC
3339 timestamp format.
|
Long |
getUsageInBytes()
The usage value corresponding to this principal in bytes.
|
int |
hashCode() |
QuotaRuleSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"id","fileSystemId","principalType","principalId","isHardQuota","displayName","usageInBytes","quotaLimitInGigabytes","timeCreated","timeUpdated","areViolatorsOnly"}) public QuotaRuleSummary(String id, String fileSystemId, QuotaRuleSummary.PrincipalType principalType, Integer principalId, Boolean isHardQuota, String displayName, Long usageInBytes, Integer quotaLimitInGigabytes, Date timeCreated, Date timeUpdated, Boolean areViolatorsOnly)
public static QuotaRuleSummary.Builder builder()
Create a new builder.
public QuotaRuleSummary.Builder toBuilder()
public String getId()
The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
public QuotaRuleSummary.PrincipalType getPrincipalType()
The type of the owner of this quota rule and usage.
public Integer getPrincipalId()
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.
public Boolean getIsHardQuota()
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.
public String getDisplayName()
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering
confidential information. Example: UserXYZ's quota
public Long getUsageInBytes()
The usage value corresponding to this principal in bytes.
public Integer getQuotaLimitInGigabytes()
The value of the quota rule in gigabytes.
public Date getTimeCreated()
The date and time the quota rule was created, expressed in RFC 3339 timestamp format.
Example: 2016-08-25T21:10:29.600Z
public Date getTimeUpdated()
The date and time the quota rule was last updated, expressed in RFC 3339 timestamp format.
Example: 2016-08-25T21:10:29.600Z
public Boolean getAreViolatorsOnly()
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.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2025. All rights reserved.