com.google.cloud.hadoop.gcsio

Class StorageResourceId

java.lang.Object

com.google.cloud.hadoop.gcsio.StorageResourceId

public class StorageResourceId
extends Object

Data struct representing either a GCS StorageObject, a GCS Bucket or the GCS root (gs://). If both bucketName and objectName are null, the StorageResourceId refers to GCS root (gs://). If bucketName is non-null, and objectName is null, then this refers to a GCS Bucket. Otherwise, if bucketName and objectName are both non-null, this refers to a GCS StorageObject.

Field Summary

Fields

Modifier and Type	Field and Description
static StorageResourceId	ROOT

Constructor Summary

Constructors

Constructor and Description
StorageResourceId(String bucketName) Constructor for a StorageResourceId representing a Bucket; getObjectName() will return null for a StorageResourceId which represents a Bucket.
StorageResourceId(String bucketName, String objectName) Constructor for a StorageResourceId representing a full StorageObject, including bucketName and objectName.

Method Summary

Methods

Modifier and Type	Method and Description
static String	createReadableString(String bucketName, String objectName) Helper for standardizing the way various human-readable messages in logs/exceptions which refer to a bucket/object pair.
boolean	equals(Object obj)
String	getBucketName() Gets the bucket name component of this resource identifier.
String	getObjectName() Gets the object name component of this resource identifier.
int	hashCode()
boolean	isBucket() Returns true if this StorageResourceId represents a GCS Bucket; if true, then getObjectName will return null.
boolean	isDirectory() Indicates if this StorageResourceId corresponds to a 'directory'; similar to FileInfo.isDirectory() except deals entirely with pathnames instead of also checking for exists() to be true on a corresponding GoogleCloudStorageItemInfo.
boolean	isRoot() Returns true if this StorageResourceId represents the GCS root (gs://); if true, then both getBucketName and getObjectName will be null.
boolean	isStorageObject() Returns true if this StorageResourceId represents a GCS StorageObject; if true, both getBucketName and getObjectName will be non-empty and non-null.
String	toString() Returns a string of the form gs:///.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final StorageResourceId ROOT

Constructor Detail

StorageResourceId

public StorageResourceId(String bucketName)

Constructor for a StorageResourceId representing a Bucket; getObjectName() will return null for a StorageResourceId which represents a Bucket.

Parameters:

bucketName - The bucket name of the resource. Must be non-empty and non-null.

StorageResourceId

public StorageResourceId(String bucketName,
                 String objectName)

Constructor for a StorageResourceId representing a full StorageObject, including bucketName and objectName.

Parameters:

bucketName - The bucket name of the resource. Must be non-empty and non-null.

objectName - The object name of the resource. Must be non-empty and non-null.

Method Detail

isStorageObject

public boolean isStorageObject()

Returns true if this StorageResourceId represents a GCS StorageObject; if true, both getBucketName and getObjectName will be non-empty and non-null.

isBucket

public boolean isBucket()

Returns true if this StorageResourceId represents a GCS Bucket; if true, then getObjectName will return null.

isRoot

public boolean isRoot()

Returns true if this StorageResourceId represents the GCS root (gs://); if true, then both getBucketName and getObjectName will be null.

isDirectory

public boolean isDirectory()

Indicates if this StorageResourceId corresponds to a 'directory'; similar to FileInfo.isDirectory() except deals entirely with pathnames instead of also checking for exists() to be true on a corresponding GoogleCloudStorageItemInfo.

getBucketName

public String getBucketName()

Gets the bucket name component of this resource identifier.

getObjectName

public String getObjectName()

Gets the object name component of this resource identifier.

toString

public String toString()

Returns a string of the form gs:///.

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

createReadableString

public static String createReadableString(String bucketName,
                          String objectName)

Helper for standardizing the way various human-readable messages in logs/exceptions which refer to a bucket/object pair.