Package com.oracle.bmc.databasemanagement.model

Class Datafile

java.lang.Object

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

com.oracle.bmc.databasemanagement.model.Datafile

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

The details of a data file.
Note: Objects should always be created or deserialized using the Datafile.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 Datafile.Builder, which maintain a set of all explicitly set fields called Datafile.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	Datafile.Builder
static class	Datafile.LostWriteProtect	The lost write protection status of the file.
static class	Datafile.OnlineStatus	The online status of the file.
static class	Datafile.Shared	Type of tablespace this file belongs to.
static class	Datafile.Status	The status of the file.

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

Datafile(String name, Datafile.Status status, Datafile.OnlineStatus onlineStatus, Boolean isAutoExtensible, Datafile.LostWriteProtect lostWriteProtect, Datafile.Shared shared, BigDecimal instanceId, BigDecimal maxSizeKB, BigDecimal allocatedSizeKB, BigDecimal userSizeKB, BigDecimal incrementBy, BigDecimal freeSpaceKB, BigDecimal usedSpaceKB, Double usedPercentAvailable, Double usedPercentAllocated)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static Datafile.Builder	builder()	Create a new builder.
boolean	equals(Object o)
BigDecimal	getAllocatedSizeKB()	The allocated file size in KB.
BigDecimal	getFreeSpaceKB()	The free space available in the data file in KB.
BigDecimal	getIncrementBy()	The number of blocks used as auto-extension increment.
BigDecimal	getInstanceId()	Instance ID of the instance to which the temp file belongs.
Boolean	getIsAutoExtensible()	Indicates whether the data file is auto-extensible.
Datafile.LostWriteProtect	getLostWriteProtect()	The lost write protection status of the file.
BigDecimal	getMaxSizeKB()	The maximum file size in KB.
String	getName()	The filename (including the path) of the data file or temp file.
Datafile.OnlineStatus	getOnlineStatus()	The online status of the file.
Datafile.Shared	getShared()	Type of tablespace this file belongs to.
Datafile.Status	getStatus()	The status of the file.
Double	getUsedPercentAllocated()	The percentage of used space out of the total allocated space in the file.
Double	getUsedPercentAvailable()	The percentage of used space out of the maximum available space in the file.
BigDecimal	getUsedSpaceKB()	The total space used in the data file in KB.
BigDecimal	getUserSizeKB()	The size of the file available for user data in KB.
int	hashCode()
Datafile.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

Datafile

@Deprecated
@ConstructorProperties({"name","status","onlineStatus","isAutoExtensible","lostWriteProtect","shared","instanceId","maxSizeKB","allocatedSizeKB","userSizeKB","incrementBy","freeSpaceKB","usedSpaceKB","usedPercentAvailable","usedPercentAllocated"})
public Datafile(String name,
                Datafile.Status status,
                Datafile.OnlineStatus onlineStatus,
                Boolean isAutoExtensible,
                Datafile.LostWriteProtect lostWriteProtect,
                Datafile.Shared shared,
                BigDecimal instanceId,
                BigDecimal maxSizeKB,
                BigDecimal allocatedSizeKB,
                BigDecimal userSizeKB,
                BigDecimal incrementBy,
                BigDecimal freeSpaceKB,
                BigDecimal usedSpaceKB,
                Double usedPercentAvailable,
                Double usedPercentAllocated)

Deprecated.

Method Detail

builder

public static Datafile.Builder builder()

Create a new builder.

toBuilder

public Datafile.Builder toBuilder()

getName

public String getName()

The filename (including the path) of the data file or temp file.

Returns:

the value

getStatus

public Datafile.Status getStatus()

The status of the file.

INVALID status is used when the file number is not in use, for example, a file in a tablespace that was removed.

Returns:

the value

getOnlineStatus

public Datafile.OnlineStatus getOnlineStatus()

The online status of the file.

Returns:

the value

getIsAutoExtensible

public Boolean getIsAutoExtensible()

Indicates whether the data file is auto-extensible.

Returns:

the value

getLostWriteProtect

public Datafile.LostWriteProtect getLostWriteProtect()

The lost write protection status of the file.

Returns:

the value

getShared

public Datafile.Shared getShared()

Type of tablespace this file belongs to.

If it’s for a shared tablespace, for a local temporary tablespace for RIM (read-only) instances, or for local temporary tablespace for all instance types.

Returns:

the value

getInstanceId

public BigDecimal getInstanceId()

Instance ID of the instance to which the temp file belongs.

This column has a NULL value for temp files that belong to shared tablespaces.

Returns:

the value

getMaxSizeKB

public BigDecimal getMaxSizeKB()

The maximum file size in KB.

Returns:

the value

getAllocatedSizeKB

public BigDecimal getAllocatedSizeKB()

The allocated file size in KB.

Returns:

the value

getUserSizeKB

public BigDecimal getUserSizeKB()

The size of the file available for user data in KB.

The actual size of the file minus the USER_BYTES value is used to store file-related metadata.

Returns:

the value

getIncrementBy

public BigDecimal getIncrementBy()

The number of blocks used as auto-extension increment.

Returns:

the value

getFreeSpaceKB

public BigDecimal getFreeSpaceKB()

The free space available in the data file in KB.

Returns:

the value

getUsedSpaceKB

public BigDecimal getUsedSpaceKB()

The total space used in the data file in KB.

Returns:

the value

getUsedPercentAvailable

public Double getUsedPercentAvailable()

The percentage of used space out of the maximum available space in the file.

Returns:

the value

getUsedPercentAllocated

public Double getUsedPercentAllocated()

The percentage of used space out of the total allocated space in the file.

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