Index (App Engine Client for Google Cloud Storage 0.6 API)

A B C D E F G H I L M N O P R S T U V W X

A

abortOn(Class<? extends Exception>...) - Method in class com.google.appengine.tools.cloudstorage.ExceptionHandler.Builder
AccessTokenProvider - Interface in com.google.appengine.tools.cloudstorage.oauth: Interface for users to implement for providing an access token to be used when authenticating with Google Cloud storage.
acl(String) - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions.Builder: Sets the acl of the object.
addUserMetadata(String, String) - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions.Builder: Adds user specific metadata that will be added to object headers when served through Google Storage.

B

BadRangeException - Exception in com.google.appengine.tools.cloudstorage: Thrown from RawGcsService when a read operation begins at an offset that is >= the length of the file.
BadRangeException(String) - Constructor for exception com.google.appengine.tools.cloudstorage.BadRangeException
beginObjectCreation(GcsFilename, GcsFileOptions, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService
build() - Method in class com.google.appengine.tools.cloudstorage.ExceptionHandler.Builder: Returns a new instance of ExceptionHandler
build() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions.Builder: Create an instance of GcsFileOptions with the parameters set in this builder
build() - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions.Builder
build() - Method in class com.google.appengine.tools.cloudstorage.ListItem.Builder
build() - Method in class com.google.appengine.tools.cloudstorage.ListOptions.Builder
build() - Method in class com.google.appengine.tools.cloudstorage.RetryParams.Builder: Create an instance of RetryParams with the parameters set in this builder
Builder() - Constructor for class com.google.appengine.tools.cloudstorage.ExceptionHandler.Builder
Builder() - Constructor for class com.google.appengine.tools.cloudstorage.GcsFileOptions.Builder
Builder() - Constructor for class com.google.appengine.tools.cloudstorage.GcsServiceOptions.Builder
Builder() - Constructor for class com.google.appengine.tools.cloudstorage.ListItem.Builder
Builder() - Constructor for class com.google.appengine.tools.cloudstorage.ListOptions.Builder
Builder() - Constructor for class com.google.appengine.tools.cloudstorage.RetryParams.Builder
Builder(RetryParams) - Constructor for class com.google.appengine.tools.cloudstorage.RetryParams.Builder

C

cacheControl(String) - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions.Builder: Sets the cache control for the object.
close() - Method in interface com.google.appengine.tools.cloudstorage.GcsInputChannel: Overridden to remove IOException.
close() - Method in interface com.google.appengine.tools.cloudstorage.GcsOutputChannel: Flushes any buffers and writes all data to durable storage.
com.google.appengine.tools.cloudstorage - package com.google.appengine.tools.cloudstorage
com.google.appengine.tools.cloudstorage.dev - package com.google.appengine.tools.cloudstorage.dev
com.google.appengine.tools.cloudstorage.oauth - package com.google.appengine.tools.cloudstorage.oauth
compose(Iterable<String>, GcsFilename) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Concatenates a list of existing files into a new file in the same bucket.
composeObject(Iterable<String>, GcsFilename, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Compose a file from given files.
computeNext() - Method in class com.google.appengine.tools.cloudstorage.ListResult
contentDisposition(String) - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions.Builder: Sets the content disposition for the object.
contentEncoding(String) - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions.Builder: Sets the content encoding for the object.
continueObjectCreationAsync(RawGcsService.RawGcsCreationToken, ByteBuffer, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Reads all remaining bytes from chunk and writes them to the object and offset specified by token asynchronously.
copy(GcsFilename, GcsFilename) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Copies a file to a specified location.
copyObject(GcsFilename, GcsFilename, GcsFileOptions, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Copy source file to dest.
createGcsService(RetryParams) - Static method in class com.google.appengine.tools.cloudstorage.GcsServiceFactory
createGcsService(GcsServiceOptions) - Static method in class com.google.appengine.tools.cloudstorage.GcsServiceFactory
createGcsService() - Static method in class com.google.appengine.tools.cloudstorage.GcsServiceFactory
createLocalRawGcsService() - Static method in class com.google.appengine.tools.cloudstorage.dev.LocalRawGcsServiceFactory
createOauthRawGcsService(ImmutableSet<HTTPHeader>) - Static method in class com.google.appengine.tools.cloudstorage.oauth.OauthRawGcsServiceFactory
createOrReplace(GcsFilename, GcsFileOptions) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Creates a new object.
createOrReplace(GcsFilename, GcsFileOptions, ByteBuffer) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Creates, writes, and closes a new object with a given content.

D

DEFAULT - Static variable in class com.google.appengine.tools.cloudstorage.GcsServiceOptions
DEFAULT - Static variable in class com.google.appengine.tools.cloudstorage.ListOptions: Default settings for including all objects in the result.
DEFAULT_INITIAL_RETRY_DELAY_MILLIS - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
DEFAULT_MAX_REQUEST_TIMEOUT - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
DEFAULT_MAX_RETRY_DELAY_MILLIS - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
DEFAULT_REQUEST_TIMEOUT_MILLIS - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
DEFAULT_REQUEST_TIMEOUT_RETRY_FACTOR - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
DEFAULT_RETRY_DELAY_BACKOFF_FACTOR - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
DEFAULT_RETRY_MAX_ATTEMPTS - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
DEFAULT_RETRY_MIN_ATTEMPTS - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
DEFAULT_TOTAL_RETRY_PERIOD_MILLIS - Static variable in class com.google.appengine.tools.cloudstorage.RetryParams
delete(GcsFilename) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Deletes a file.
deleteObject(GcsFilename, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Returns true if deleted, false if not found.

E

equals(Object) - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata
equals(Object) - Method in class com.google.appengine.tools.cloudstorage.GcsFilename
equals(Object) - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
equals(Object) - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions
equals(Object) - Method in class com.google.appengine.tools.cloudstorage.ListItem
equals(Object) - Method in class com.google.appengine.tools.cloudstorage.ListOptions
equals(Object) - Method in class com.google.appengine.tools.cloudstorage.oauth.XmlHandler.XmlEvent
equals(Object) - Method in class com.google.appengine.tools.cloudstorage.RetryParams
ExceptionHandler - Class in com.google.appengine.tools.cloudstorage: Exception handling used by RetryHelper.
ExceptionHandler.Builder - Class in com.google.appengine.tools.cloudstorage: ExceptionHandler builder.

F

finishObjectCreation(RawGcsService.RawGcsCreationToken, ByteBuffer, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Reads all remaining bytes from chunk and writes them to the object and offset specified by token, as the final bytes of the object.

G

GcsFileMetadata - Class in com.google.appengine.tools.cloudstorage: Contains metadata about a Google Cloud Storage Object.
GcsFileMetadata(GcsFilename, GcsFileOptions, String, long, Date) - Constructor for class com.google.appengine.tools.cloudstorage.GcsFileMetadata
GcsFileMetadata(GcsFilename, GcsFileOptions, String, long, Date, Map<String, String>) - Constructor for class com.google.appengine.tools.cloudstorage.GcsFileMetadata
GcsFilename - Class in com.google.appengine.tools.cloudstorage: Bucket and object name of a Google Cloud Storage object.
GcsFilename(String, String) - Constructor for class com.google.appengine.tools.cloudstorage.GcsFilename
GcsFileOptions - Class in com.google.appengine.tools.cloudstorage: Container class for holding options for creating Google Storage files.
GcsFileOptions.Builder - Class in com.google.appengine.tools.cloudstorage: A builder of GcsFileOptions.
GcsInputChannel - Interface in com.google.appengine.tools.cloudstorage: A readable byte channel for reading data to Google Cloud Storage.
GcsOutputChannel - Interface in com.google.appengine.tools.cloudstorage: A writable byte channel for writing data to Google Cloud Storage.
GcsService - Interface in com.google.appengine.tools.cloudstorage: Allows creating and accessing files in Google Cloud Storage.
GcsServiceFactory - Class in com.google.appengine.tools.cloudstorage: Provides implementations of GcsService.
GcsServiceOptions - Class in com.google.appengine.tools.cloudstorage: A class to hold options for the GcsService.
GcsServiceOptions.Builder - Class in com.google.appengine.tools.cloudstorage: GcsServiceOtpions builder.
getAcl() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
getBucketName() - Method in class com.google.appengine.tools.cloudstorage.GcsFilename
getBufferSizeBytes() - Method in interface com.google.appengine.tools.cloudstorage.GcsOutputChannel
getCacheControl() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
getChunkSizeBytes() - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Calls to RawGcsService.continueObjectCreationAsync(RawGcsCreationToken, ByteBuffer, long) need to pass fixed size chunks.
getContentDisposition() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
getContentEncoding() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
getDefaultInstance() - Static method in class com.google.appengine.tools.cloudstorage.ExceptionHandler: Returns an instance which retry any checked exception and abort on any runtime exception.
getDefaultInstance() - Static method in class com.google.appengine.tools.cloudstorage.GcsFileOptions: Retrieve an instance with the default parameters
getDefaultInstance() - Static method in class com.google.appengine.tools.cloudstorage.RetryParams: Retrieve an instance with the default parameters
getDefaultWriteBufferSize() - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions
getEtag() - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata
getEtag() - Method in class com.google.appengine.tools.cloudstorage.ListItem
getEventType() - Method in class com.google.appengine.tools.cloudstorage.oauth.XmlHandler.XmlEvent
getFilename() - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata
getFilename() - Method in interface com.google.appengine.tools.cloudstorage.GcsOutputChannel: Returns the filename.
getFilename() - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService.RawGcsCreationToken: The Filename of the object being written.
getHttpHeaders() - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions
getInitialRetryDelayMillis() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
getItems() - Method in class com.google.appengine.tools.cloudstorage.RawGcsService.ListItemBatch
getLastModified() - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata
getLastModified() - Method in class com.google.appengine.tools.cloudstorage.ListItem
getLength() - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata
getLength() - Method in class com.google.appengine.tools.cloudstorage.ListItem
getMaxRetryDelayMillis() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
getMaxWriteSizeByte() - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Returns the max bytes allowed per putObject/finishObject operations.
getMetadata(GcsFilename) - Method in interface com.google.appengine.tools.cloudstorage.GcsService
getMimeType() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
getName() - Method in class com.google.appengine.tools.cloudstorage.ListItem
getName() - Method in class com.google.appengine.tools.cloudstorage.oauth.XmlHandler.XmlEvent
getNewAccessToken(List<String>) - Method in interface com.google.appengine.tools.cloudstorage.oauth.AccessTokenProvider: Creates a fresh access token.
getNextMarker() - Method in class com.google.appengine.tools.cloudstorage.RawGcsService.ListItemBatch
getNonRetriableExceptions() - Method in class com.google.appengine.tools.cloudstorage.ExceptionHandler
getObjectMetadata(GcsFilename, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Returns the meta-data for filename.
getObjectName() - Method in class com.google.appengine.tools.cloudstorage.GcsFilename
getOffset() - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService.RawGcsCreationToken: The number of bytes written to the object so far.
getOptions() - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata
getPathDelimiter() - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions
getPrefix() - Method in class com.google.appengine.tools.cloudstorage.ListOptions
getRequestTimeoutMillis() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
getRetriableExceptions() - Method in class com.google.appengine.tools.cloudstorage.ExceptionHandler
getRetryDelayBackoffFactor() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
getRetryMaxAttempts() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
getRetryMinAttempts() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
getRetryParams() - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions
getTotalRetryPeriodMillis() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
getUserMetadata() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
getValue() - Method in class com.google.appengine.tools.cloudstorage.oauth.XmlHandler.XmlEvent: Returns an XML element's text (only available for XmlHandler.EventType.CLOSE_ELEMENT events).
getXGoogHeaders() - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata: Returns the Google headers that were provided together with the metadata.

H

hashCode() - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata
hashCode() - Method in class com.google.appengine.tools.cloudstorage.GcsFilename
hashCode() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
hashCode() - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions
hashCode() - Method in class com.google.appengine.tools.cloudstorage.ListItem
hashCode() - Method in class com.google.appengine.tools.cloudstorage.ListOptions
hashCode() - Method in class com.google.appengine.tools.cloudstorage.oauth.XmlHandler.XmlEvent
hashCode() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
hasNext() - Method in class com.google.appengine.tools.cloudstorage.oauth.XmlHandler

I

initialRetryDelayMillis(long) - Method in class com.google.appengine.tools.cloudstorage.RetryParams.Builder
isDirectory() - Method in class com.google.appengine.tools.cloudstorage.ListItem
isRecursive() - Method in class com.google.appengine.tools.cloudstorage.ListOptions

L

list(String, ListOptions) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Retrieves a list of objects.
list(String, String, String, String, int, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService
ListItem - Class in com.google.appengine.tools.cloudstorage: Contains information of an individual listing item.
ListItem.Builder - Class in com.google.appengine.tools.cloudstorage: ListItem builder.
ListItemBatch(List<ListItem>, String) - Constructor for class com.google.appengine.tools.cloudstorage.RawGcsService.ListItemBatch
ListOptions - Class in com.google.appengine.tools.cloudstorage: GcsService listing options.
ListOptions.Builder - Class in com.google.appengine.tools.cloudstorage: Listing options builder.
ListResult - Class in com.google.appengine.tools.cloudstorage: Contains the result of a listing request.
ListResult(Callable<Iterator<ListItem>>) - Constructor for class com.google.appengine.tools.cloudstorage.ListResult
LocalRawGcsServiceFactory - Class in com.google.appengine.tools.cloudstorage.dev: Creates a RawGcsService for use in-process.

M

maxRetryDelayMillis(long) - Method in class com.google.appengine.tools.cloudstorage.RetryParams.Builder
mimeType(String) - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions.Builder: Sets the mime type of the object.

N

next() - Method in class com.google.appengine.tools.cloudstorage.oauth.XmlHandler
NonRetriableException - Exception in com.google.appengine.tools.cloudstorage: Thrown when RetryHelper callable has indicate it should not be retried.

O

OauthRawGcsServiceFactory - Class in com.google.appengine.tools.cloudstorage.oauth: Factory for RawGcsService using OAuth for authorization.
openPrefetchingReadChannel(GcsFilename, long, int) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Same as openReadChannel, but buffers data in memory and prefetches it before it is required to avoid blocking on most read calls.
openReadChannel(GcsFilename, long) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Note that the implementation may check if the file exists during the call to openReadChannel, or only check it when the first byte is requested.

P

putObject(GcsFilename, GcsFileOptions, ByteBuffer, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Create or replace filename with the given content.

R

RawGcsService - Interface in com.google.appengine.tools.cloudstorage: Low-level ("raw") interface to Google Cloud Storage.
RawGcsService.ListItemBatch - Class in com.google.appengine.tools.cloudstorage: A batch of list items.
RawGcsService.RawGcsCreationToken - Interface in com.google.appengine.tools.cloudstorage: Immutable token that wraps the information a specific implementation of RawGcsService needs to write to an object.
readObjectAsync(ByteBuffer, GcsFilename, long, long) - Method in interface com.google.appengine.tools.cloudstorage.RawGcsService: Issues a request to the server to retrieve data to fill the provided buffer.
requestTimeoutMillis(long) - Method in class com.google.appengine.tools.cloudstorage.RetryParams.Builder
RetriesExhaustedException - Exception in com.google.appengine.tools.cloudstorage: Thrown when a RetryHelper has attempted the maximum number of attempts allowed by RetryParams and was not successful.
retryDelayBackoffFactor(double) - Method in class com.google.appengine.tools.cloudstorage.RetryParams.Builder
RetryHelper<V> - Class in com.google.appengine.tools.cloudstorage: Utility class for retrying operations.
RetryHelperException - Exception in com.google.appengine.tools.cloudstorage: Thrown when a RetryHelper has failed to complete successfully.
RetryInterruptedException - Exception in com.google.appengine.tools.cloudstorage: Thrown when a RetryHelper failed to complete its work due to interruption.
retryMaxAttempts(int) - Method in class com.google.appengine.tools.cloudstorage.RetryParams.Builder
retryMinAttempts(int) - Method in class com.google.appengine.tools.cloudstorage.RetryParams.Builder
retryOn(Class<? extends Exception>...) - Method in class com.google.appengine.tools.cloudstorage.ExceptionHandler.Builder
RetryParams - Class in com.google.appengine.tools.cloudstorage: Parameters for configuring exponential backoff.
RetryParams.Builder - Class in com.google.appengine.tools.cloudstorage: RetryParams builder.
runWithRetries(Callable<V>) - Static method in class com.google.appengine.tools.cloudstorage.RetryHelper
runWithRetries(Callable<V>, RetryParams, ExceptionHandler) - Static method in class com.google.appengine.tools.cloudstorage.RetryHelper

S

setDefaultWriteBufferSize(Integer) - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions.Builder
setDirectory(boolean) - Method in class com.google.appengine.tools.cloudstorage.ListItem.Builder
setEtag(String) - Method in class com.google.appengine.tools.cloudstorage.ListItem.Builder
setHttpHeaders(Map<String, String>) - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions.Builder
setLastModified(Date) - Method in class com.google.appengine.tools.cloudstorage.ListItem.Builder
setLength(long) - Method in class com.google.appengine.tools.cloudstorage.ListItem.Builder
setName(String) - Method in class com.google.appengine.tools.cloudstorage.ListItem.Builder
setPathDelimiter(String) - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions.Builder
setPrefix(String) - Method in class com.google.appengine.tools.cloudstorage.ListOptions.Builder
setRecursive(boolean) - Method in class com.google.appengine.tools.cloudstorage.ListOptions.Builder
setRetryParams(RetryParams) - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions.Builder
SYSTEM_PROPERTY_NAME - Static variable in interface com.google.appengine.tools.cloudstorage.oauth.AccessTokenProvider

T

toString() - Method in class com.google.appengine.tools.cloudstorage.GcsFileMetadata
toString() - Method in class com.google.appengine.tools.cloudstorage.GcsFilename
toString() - Method in class com.google.appengine.tools.cloudstorage.GcsFileOptions
toString() - Method in class com.google.appengine.tools.cloudstorage.GcsServiceOptions
toString() - Method in class com.google.appengine.tools.cloudstorage.ListItem
toString() - Method in class com.google.appengine.tools.cloudstorage.ListOptions
toString() - Method in class com.google.appengine.tools.cloudstorage.oauth.XmlHandler.XmlEvent
toString() - Method in class com.google.appengine.tools.cloudstorage.RetryHelper
toString() - Method in class com.google.appengine.tools.cloudstorage.RetryParams
totalRetryPeriodMillis(long) - Method in class com.google.appengine.tools.cloudstorage.RetryParams.Builder

U

update(GcsFilename, GcsFileOptions) - Method in interface com.google.appengine.tools.cloudstorage.GcsService: Updates a file's metadata with the given options.

V

valueOf(String) - Static method in enum com.google.appengine.tools.cloudstorage.oauth.XmlHandler.EventType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.google.appengine.tools.cloudstorage.oauth.XmlHandler.EventType: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForOutstandingWrites() - Method in interface com.google.appengine.tools.cloudstorage.GcsOutputChannel: Blocks until all data that can be written has been written.
write(ByteBuffer) - Method in interface com.google.appengine.tools.cloudstorage.GcsOutputChannel

X

XmlHandler - Class in com.google.appengine.tools.cloudstorage.oauth: A simpler XML handler.
XmlHandler.EventType - Enum in com.google.appengine.tools.cloudstorage.oauth: The type of the XmlEvent.
XmlHandler.XmlEvent - Class in com.google.appengine.tools.cloudstorage.oauth: Information associated with the callback event.

A B C D E F G H I L M N O P R S T U V W X