com.google.cloud.hadoop.gcsio

Class GoogleCloudStorageItemInfo

java.lang.Object

com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

public class GoogleCloudStorageItemInfo
extends java.lang.Object

Contains information about an item in Google Cloud Storage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GoogleCloudStorageItemInfo.Provider Convenience interface for classes which want to implement Provider of GoogleCloudStorageItemInfo for callers which may not know the concrete type of an object, but want to check if the object happens to be an instance of this InfoProvider.

Field Summary

Fields

Modifier and Type	Field and Description
static GoogleCloudStorageItemInfo	ROOT_INFO

Constructor Summary

Constructors

Constructor and Description
GoogleCloudStorageItemInfo(StorageResourceId resourceId, long creationTime, long size, java.lang.String location, java.lang.String storageClass) Constructs an instance of GoogleCloudStorageItemInfo.
GoogleCloudStorageItemInfo(StorageResourceId resourceId, long creationTime, long size, java.lang.String location, java.lang.String storageClass, java.lang.String contentType, java.lang.String contentEncoding, java.util.Map<java.lang.String,byte[]> metadata, long contentGeneration, long metaGeneration) Constructs an instance of GoogleCloudStorageItemInfo.
GoogleCloudStorageItemInfo(StorageResourceId resourceId, long creationTime, long size, java.lang.String location, java.lang.String storageClass, java.lang.String contentType, java.lang.String contentEncoding, java.util.Map<java.lang.String,byte[]> metadata, long contentGeneration, long metaGeneration, VerificationAttributes verificationAttributes) Constructs an instance of GoogleCloudStorageItemInfo.

Method Summary

Modifier and Type	Method and Description
static GoogleCloudStorageItemInfo	createInferredDirectory(StorageResourceId resourceId) Helper for creating a "found" GoogleCloudStorageItemInfo for an inferred directory.
static GoogleCloudStorageItemInfo	createNotFound(StorageResourceId resourceId) Helper for creating a "not found" GoogleCloudStorageItemInfo for a StorageResourceId.
boolean	equals(java.lang.Object obj)
boolean	exists() Indicates whether this item exists.
java.lang.String	getBucketName() Gets bucket name of this item.
java.lang.String	getContentEncoding() Gets the content-encoding of this item, or null if unknown or inapplicable.
long	getContentGeneration() Get the content generation of the object.
java.lang.String	getContentType() Gets the content-type of this item, or null if unknown or inapplicable.
long	getCreationTime() Gets creation time of this item.
java.lang.String	getLocation() Gets location of this item.
java.util.Map<java.lang.String,byte[]>	getMetadata() Gets user-supplied metadata for this item.
long	getMetaGeneration() Get the meta generation of the object.
java.lang.String	getObjectName() Gets object name of this item.
StorageResourceId	getResourceId() Gets the resourceId that holds the (possibly null) bucketName and objectName of this object.
long	getSize() Gets size of this item (number of bytes).
java.lang.String	getStorageClass() Gets storage class of this item.
VerificationAttributes	getVerificationAttributes() Get object validation attributes.
int	hashCode()
boolean	isBucket() Indicates whether this item is a bucket.
boolean	isRoot() Indicates whether this item refers to the GCS root (gs://).
boolean	metadataEquals(java.util.Map<java.lang.String,byte[]> otherMetadata) Helper for checking logical equality of metadata maps, checking equality of keySet() between this.metadata and otherMetadata, and then using Arrays.equals to compare contents of corresponding byte arrays.
java.lang.String	toString() Gets string representation of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_INFO

public static final GoogleCloudStorageItemInfo ROOT_INFO

Constructor Detail

GoogleCloudStorageItemInfo

public GoogleCloudStorageItemInfo(StorageResourceId resourceId,
                                  long creationTime,
                                  long size,
                                  java.lang.String location,
                                  java.lang.String storageClass)

Constructs an instance of GoogleCloudStorageItemInfo.

Parameters:

resourceId - identifies either root, a Bucket, or a StorageObject

creationTime - Time when object was created (milliseconds since January 1, 1970 UTC).

size - Size of the given object (number of bytes) or -1 if the object does not exist.

GoogleCloudStorageItemInfo

public GoogleCloudStorageItemInfo(StorageResourceId resourceId,
                                  long creationTime,
                                  long size,
                                  java.lang.String location,
                                  java.lang.String storageClass,
                                  java.lang.String contentType,
                                  java.lang.String contentEncoding,
                                  java.util.Map<java.lang.String,byte[]> metadata,
                                  long contentGeneration,
                                  long metaGeneration)

Constructs an instance of GoogleCloudStorageItemInfo.

Parameters:

resourceId - identifies either root, a Bucket, or a StorageObject

creationTime - Time when object was created (milliseconds since January 1, 1970 UTC).

size - Size of the given object (number of bytes) or -1 if the object does not exist.

metadata - User-supplied object metadata for this object.

GoogleCloudStorageItemInfo

public GoogleCloudStorageItemInfo(StorageResourceId resourceId,
                                  long creationTime,
                                  long size,
                                  java.lang.String location,
                                  java.lang.String storageClass,
                                  java.lang.String contentType,
                                  java.lang.String contentEncoding,
                                  java.util.Map<java.lang.String,byte[]> metadata,
                                  long contentGeneration,
                                  long metaGeneration,
                                  VerificationAttributes verificationAttributes)

Constructs an instance of GoogleCloudStorageItemInfo.

Parameters:

resourceId - identifies either root, a Bucket, or a StorageObject

creationTime - Time when object was created (milliseconds since January 1, 1970 UTC).

size - Size of the given object (number of bytes) or -1 if the object does not exist.

metadata - User-supplied object metadata for this object.

Method Detail

createInferredDirectory

public static GoogleCloudStorageItemInfo createInferredDirectory(StorageResourceId resourceId)

Helper for creating a "found" GoogleCloudStorageItemInfo for an inferred directory.

createNotFound

public static GoogleCloudStorageItemInfo createNotFound(StorageResourceId resourceId)

Helper for creating a "not found" GoogleCloudStorageItemInfo for a StorageResourceId.

getBucketName

public java.lang.String getBucketName()

Gets bucket name of this item.

getObjectName

public java.lang.String getObjectName()

Gets object name of this item.

getResourceId

public StorageResourceId getResourceId()

Gets the resourceId that holds the (possibly null) bucketName and objectName of this object.

getCreationTime

public long getCreationTime()

Gets creation time of this item. Time is expressed as milliseconds since January 1, 1970 UTC.

getSize

public long getSize()

Gets size of this item (number of bytes). Returns -1 if the object does not exist.

getLocation

public java.lang.String getLocation()

Gets location of this item. Note: Location is only supported for buckets. The value is always null for objects.

getStorageClass

public java.lang.String getStorageClass()

Gets storage class of this item. Note: Storage-class is only supported for buckets. The value is always null for objects.

getContentType

public java.lang.String getContentType()

Gets the content-type of this item, or null if unknown or inapplicable. Note: content-type is only supported for objects, and will always be null for buckets.

getContentEncoding

public java.lang.String getContentEncoding()

Gets the content-encoding of this item, or null if unknown or inapplicable.

Note: content-encoding is only supported for objects, and will always be null for buckets.

getMetadata

public java.util.Map<java.lang.String,byte[]> getMetadata()

Gets user-supplied metadata for this item. Note: metadata is only supported for objects. This value is always an empty map for buckets.

isBucket

public boolean isBucket()

Indicates whether this item is a bucket. Root is not considered to be a bucket.

isRoot

public boolean isRoot()

Indicates whether this item refers to the GCS root (gs://).

exists

public boolean exists()

Indicates whether this item exists.

getContentGeneration

public long getContentGeneration()

Get the content generation of the object.

getMetaGeneration

public long getMetaGeneration()

Get the meta generation of the object.

getVerificationAttributes

public VerificationAttributes getVerificationAttributes()

Get object validation attributes.

metadataEquals

public boolean metadataEquals(java.util.Map<java.lang.String,byte[]> otherMetadata)

Helper for checking logical equality of metadata maps, checking equality of keySet() between this.metadata and otherMetadata, and then using Arrays.equals to compare contents of corresponding byte arrays.

toString

public java.lang.String toString()

Gets string representation of this instance.

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object