Package org.apache.hadoop.hdfs.protocol

Class CachePoolInfo

java.lang.Object

org.apache.hadoop.hdfs.protocol.CachePoolInfo

@Public
@Evolving
public class CachePoolInfo
extends java.lang.Object

CachePoolInfo describes a cache pool. This class is used in RPCs to create and modify cache pools. It is serializable and can be stored in the edit log.

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_LIMIT
static long	DEFAULT_MAX_RELATIVE_EXPIRY	Default max relative expiry for cache pools.
static short	DEFAULT_REPLICATION_NUM
static long	LIMIT_UNLIMITED
static long	RELATIVE_EXPIRY_NEVER	Indicates that the pool does not have a maximum relative expiry.

Constructor Summary

Constructors

Constructor	Description
CachePoolInfo(java.lang.String poolName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.Short	getDefaultReplication()
java.lang.String	getGroupName()
java.lang.Long	getLimit()
java.lang.Long	getMaxRelativeExpiryMs()
org.apache.hadoop.fs.permission.FsPermission	getMode()
java.lang.String	getOwnerName()
java.lang.String	getPoolName()
int	hashCode()
CachePoolInfo	setDefaultReplication(java.lang.Short repl)
CachePoolInfo	setGroupName(java.lang.String groupName)
CachePoolInfo	setLimit(java.lang.Long bytes)
CachePoolInfo	setMaxRelativeExpiryMs(java.lang.Long ms)	Set the maximum relative expiration of directives of this pool in milliseconds.
CachePoolInfo	setMode(org.apache.hadoop.fs.permission.FsPermission mode)
CachePoolInfo	setOwnerName(java.lang.String ownerName)
java.lang.String	toString()
static void	validate(CachePoolInfo info)
static void	validateName(java.lang.String poolName)

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE_EXPIRY_NEVER

public static final long RELATIVE_EXPIRY_NEVER

Indicates that the pool does not have a maximum relative expiry.

See Also:

Constant Field Values

DEFAULT_MAX_RELATIVE_EXPIRY

public static final long DEFAULT_MAX_RELATIVE_EXPIRY

Default max relative expiry for cache pools.

See Also:

Constant Field Values

LIMIT_UNLIMITED

public static final long LIMIT_UNLIMITED

See Also:

Constant Field Values

DEFAULT_LIMIT

public static final long DEFAULT_LIMIT

See Also:

Constant Field Values

DEFAULT_REPLICATION_NUM

public static final short DEFAULT_REPLICATION_NUM

See Also:

Constant Field Values

Constructor Detail

CachePoolInfo

public CachePoolInfo(java.lang.String poolName)

Method Detail

getPoolName

public java.lang.String getPoolName()

Returns:

Name of the pool.

getOwnerName

public java.lang.String getOwnerName()

Returns:

The owner of the pool. Along with the group and mode, determines who has access to view and modify the pool.

setOwnerName

public CachePoolInfo setOwnerName(java.lang.String ownerName)

getGroupName

public java.lang.String getGroupName()

Returns:

The group of the pool. Along with the owner and mode, determines who has access to view and modify the pool.

setGroupName

public CachePoolInfo setGroupName(java.lang.String groupName)

getMode

public org.apache.hadoop.fs.permission.FsPermission getMode()

Returns:

Unix-style permissions of the pool. Along with the owner and group, determines who has access to view and modify the pool.

setMode

public CachePoolInfo setMode(org.apache.hadoop.fs.permission.FsPermission mode)

getLimit

public java.lang.Long getLimit()

Returns:

The maximum aggregate number of bytes that can be cached by directives in this pool.

setLimit

public CachePoolInfo setLimit(java.lang.Long bytes)

getDefaultReplication

public java.lang.Short getDefaultReplication()

Returns:

The default replication num for CacheDirective in this pool

setDefaultReplication

public CachePoolInfo setDefaultReplication(java.lang.Short repl)

getMaxRelativeExpiryMs

public java.lang.Long getMaxRelativeExpiryMs()

Returns:

The maximum relative expiration of directives of this pool in milliseconds

setMaxRelativeExpiryMs

public CachePoolInfo setMaxRelativeExpiryMs(java.lang.Long ms)

Set the maximum relative expiration of directives of this pool in milliseconds.

Parameters:

ms - in milliseconds

Returns:

This builder, for call chaining.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

validate

public static void validate(CachePoolInfo info)
                     throws java.io.IOException

Throws:

java.io.IOException

validateName

public static void validateName(java.lang.String poolName)
                         throws java.io.IOException

Throws:

java.io.IOException