Package org.apache.flink.runtime.blob

Interface BlobStore

All Superinterfaces:

BlobView

All Known Subinterfaces:

BlobStoreService

All Known Implementing Classes:

FileSystemBlobStore, VoidBlobStore

public interface BlobStore
extends BlobView

A blob store.

Method Summary

Modifier and Type	Method	Description
boolean	delete(JobID jobId, BlobKey blobKey)	Tries to delete a blob from storage.
boolean	deleteAll(JobID jobId)	Tries to delete all blobs for the given job from storage.
boolean	put(File localFile, JobID jobId, BlobKey blobKey)	Copies the local file to the blob store.

Methods inherited from interface org.apache.flink.runtime.blob.BlobView

get

Method Detail

put

boolean put(File localFile,
            JobID jobId,
            BlobKey blobKey)
     throws IOException

Copies the local file to the blob store.

Parameters:

localFile - The file to copy

jobId - ID of the job this blob belongs to (or null if job-unrelated)

blobKey - The ID for the file in the blob store

Returns:

whether the file was copied (true) or not (false)

Throws:

IOException - If the copy fails

delete

boolean delete(JobID jobId,
               BlobKey blobKey)

Tries to delete a blob from storage.

NOTE: This also tries to delete any created directories if empty.

Parameters:

jobId - ID of the job this blob belongs to (or null if job-unrelated)

blobKey - The blob ID

Returns:

true if the given blob is successfully deleted or non-existing; false otherwise

deleteAll

boolean deleteAll(JobID jobId)

Tries to delete all blobs for the given job from storage.

NOTE: This also tries to delete any created directories if empty.

Parameters:

jobId - The JobID part of all blobs to delete

Returns:

true if the job directory is successfully deleted or non-existing; false otherwise