Package com.oracle.bmc.nosql.model

Class TableUsageSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.nosql.model.TableUsageSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190828")
public final class TableUsageSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

TableUsageSummary represents a single usage record, or slice, that includes information about read and write throughput consumed during that period as well as the current information regarding storage capacity.

In addition the count of throttling exceptions for the period is reported.
Note: Objects should always be created or deserialized using the TableUsageSummary.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 TableUsageSummary.Builder, which maintain a set of all explicitly set fields called TableUsageSummary.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableUsageSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
TableUsageSummary(Integer secondsInPeriod, Integer readUnits, Integer writeUnits, Integer storageInGBs, Integer readThrottleCount, Integer writeThrottleCount, Integer storageThrottleCount, Integer maxShardSizeUsageInPercent, Date timeStarted)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static TableUsageSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getMaxShardSizeUsageInPercent()	The percentage of allowed per-shard usage for the table shard with the highest usage.
Integer	getReadThrottleCount()	The number of times reads were throttled due to exceeding the read throughput limit.
Integer	getReadUnits()	Read throughput during the sampling period.
Integer	getSecondsInPeriod()	The length of the sampling period.
Integer	getStorageInGBs()	The size of the table, in GB.
Integer	getStorageThrottleCount()	The number of times writes were throttled because the table exceeded its size limit.
Date	getTimeStarted()	The time stamp of this usage record.
Integer	getWriteThrottleCount()	The number of times writes were throttled due to exceeding the write throughput limit.
Integer	getWriteUnits()	Write throughput during the sampling period.
int	hashCode()
TableUsageSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableUsageSummary

@Deprecated
@ConstructorProperties({"secondsInPeriod","readUnits","writeUnits","storageInGBs","readThrottleCount","writeThrottleCount","storageThrottleCount","maxShardSizeUsageInPercent","timeStarted"})
public TableUsageSummary(Integer secondsInPeriod,
                         Integer readUnits,
                         Integer writeUnits,
                         Integer storageInGBs,
                         Integer readThrottleCount,
                         Integer writeThrottleCount,
                         Integer storageThrottleCount,
                         Integer maxShardSizeUsageInPercent,
                         Date timeStarted)

Deprecated.

Method Detail

builder

public static TableUsageSummary.Builder builder()

Create a new builder.

toBuilder

public TableUsageSummary.Builder toBuilder()

getSecondsInPeriod

public Integer getSecondsInPeriod()

The length of the sampling period.

Returns:

the value

getReadUnits

public Integer getReadUnits()

Read throughput during the sampling period.

Returns:

the value

getWriteUnits

public Integer getWriteUnits()

Write throughput during the sampling period.

Returns:

the value

getStorageInGBs

public Integer getStorageInGBs()

The size of the table, in GB.

Returns:

the value

getReadThrottleCount

public Integer getReadThrottleCount()

The number of times reads were throttled due to exceeding the read throughput limit.

Returns:

the value

getWriteThrottleCount

public Integer getWriteThrottleCount()

The number of times writes were throttled due to exceeding the write throughput limit.

Returns:

the value

getStorageThrottleCount

public Integer getStorageThrottleCount()

The number of times writes were throttled because the table exceeded its size limit.

Returns:

the value

getMaxShardSizeUsageInPercent

public Integer getMaxShardSizeUsageInPercent()

The percentage of allowed per-shard usage for the table shard with the highest usage.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

The time stamp of this usage record.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel