com.google.cloud.hadoop.gcsio

Class CachedBucket

java.lang.Object

com.google.cloud.hadoop.gcsio.CacheEntry

com.google.cloud.hadoop.gcsio.CachedBucket

public class CachedBucket
extends CacheEntry

A cache entry for the relevant metadata of a single GCS Bucket, used by DirectoryListCache to supplement "list" operations with buckets known locally, as well as serving as the container for retrieving CachedObjects from their respective cached buckets. Other than direct Bucket creation, a CachedBucket may also come into existence when generating a CachedObject which inherently implies the existence of its parent bucket. Such an entry may not have associated GoogleCloudStorageItemInfo available. The caller is responsible for fetching or updating such stale/nonexistent metadata if it is desired; for name-listing operations, cached bucket/object names may be used directly without lazily populating associated metadata.

Constructor Summary

Constructors

Constructor and Description
CachedBucket(GoogleCloudStorageItemInfo bucketItemInfo) Constructs a CachedBucket with the provided GoogleCloudStorageItemInfo for the bucket.
CachedBucket(String bucketName) Constructs a CachedBucket which has no associated GoogleCloudStorageItemInfo for the bucket.

Method Summary

Methods

Modifier and Type	Method and Description
CacheEntry	get(StorageResourceId resourceId) Returns the CacheEntry entry corresponding to resourceId which must be a StorageObject residing inside this CachedBucket, or null if one doesn't exist.
String	getName() Returns the name of the Bucket associated with this CachedBucket.
int	getNumObjects()
List<CacheEntry>	getObjectList()
CacheEntry	put(StorageResourceId resourceId) Adds a CacheEntry entry to this bucket corresponding to the StorageObject for resourceId.
void	remove(StorageResourceId resourceId) Removes the CacheEntry entry corresponding to resourceId which must be a StorageObject residing inside this CachedBucket, if it exists.

Methods inherited from class com.google.cloud.hadoop.gcsio.CacheEntry

clearItemInfo, getCreationTimeMillis, getItemInfo, getItemInfoUpdateTimeMillis, getResourceId, setClock, setItemInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CachedBucket

public CachedBucket(String bucketName)

Constructs a CachedBucket which has no associated GoogleCloudStorageItemInfo for the bucket.

Parameters:

bucketName - Must be non-null and non-empty.

CachedBucket

public CachedBucket(GoogleCloudStorageItemInfo bucketItemInfo)

Constructs a CachedBucket with the provided GoogleCloudStorageItemInfo for the bucket.

Parameters:

bucketItemInfo - Must be non-null and must correspond to a Bucket.

Method Detail

getName

public String getName()

Returns the name of the Bucket associated with this CachedBucket.

get

public CacheEntry get(StorageResourceId resourceId)

Returns the CacheEntry entry corresponding to resourceId which must be a StorageObject residing inside this CachedBucket, or null if one doesn't exist. The CacheEntry is the shared reference, so that any mutations to the CacheEntry made by the caller will be reflected for future callers retrieving the same CacheEntry.

Parameters:

resourceId - identifies a StorageObject. Bucket must match this CachedBucket's name.

remove

public void remove(StorageResourceId resourceId)

Removes the CacheEntry entry corresponding to resourceId which must be a StorageObject residing inside this CachedBucket, if it exists.

Parameters:

resourceId - identifies a StorageObject. Bucket must match this CachedBucket's name.

put

public CacheEntry put(StorageResourceId resourceId)

Adds a CacheEntry entry to this bucket corresponding to the StorageObject for resourceId.

Parameters:

resourceId - identifies a StorageObject. Bucket must match this CachedBucket's name.

Returns:

The CacheEntry which got added, *or* the pre-existing entry.

getObjectList

public List<CacheEntry> getObjectList()

Returns:

List of CacheEntrys for StorageObjects residing in this bucket. May be empty. The list is a copy, so any later additions/removals of StorageObjects to this bucket will not be reflected in the returned list instance.

getNumObjects

public int getNumObjects()

Returns:

The number of StorageObjects residing within this CachedBucket.