Skip navigation links
A B C D E G H I L N O P R S T U W 

A

Access - Class in io.storj
Represents all credentials you need to access data on the Storj network: Satellite address in the form of "host:port" ApiKey to access the satellite Encryption access for accessing the encrypted content
allowDelete() - Method in class io.storj.Permission.Builder
AllowDelete gives permission to delete buckets and objects.
allowDownload() - Method in class io.storj.Permission.Builder
AllowDownload gives permission to download the object's content.
allowList() - Method in class io.storj.Permission.Builder
AllowList gives permission to list buckets.
allowUpload() - Method in class io.storj.Permission.Builder
AllowUpload gives permission to create buckets and upload new objects.

B

BucketInfo - Class in io.storj
Represents bucket metadata.
BucketIterator - Class in io.storj
 
BucketListOption - Class in io.storj
Options for listing buckets.
build() - Method in class io.storj.Permission.Builder
Creates the new Permission object from this builder.
Builder() - Constructor for class io.storj.Permission.Builder
 

C

close() - Method in class io.storj.BucketIterator
 
close() - Method in class io.storj.ObjectInputStream
Closes this input stream and releases any system resources associated with the stream.
close() - Method in class io.storj.ObjectIterator
 
close() - Method in class io.storj.ObjectOutputStream
Closes this input stream and releases any system resources associated with the stream.
close() - Method in class io.storj.Project
 
commit() - Method in class io.storj.ObjectOutputStream
Commits data to the store.
compareTo(BucketInfo) - Method in class io.storj.BucketInfo
Two BucketInfo objects are compared to each other by their names.
compareTo(ObjectInfo) - Method in class io.storj.ObjectInfo
Two ObjectInfo objects are compared to each other by their prefix flag, bucket, path and version, in this order.
compareTo(SystemMetadata) - Method in class io.storj.SystemMetadata
 
createBucket(String) - Method in class io.storj.Project
Creates a bucket in this project.
cursor(String) - Static method in class io.storj.BucketListOption
Option for the starting cursor in the bucket listing.
cursor(String) - Static method in class io.storj.ObjectListOption
Option for the starting cursor in the object listing.
custom() - Static method in class io.storj.ObjectListOption
Option for returning custom metadata with object while listing.

D

deleteBucket(String) - Method in class io.storj.Project
Deletes an bucket from this project.
deleteObject(String, String) - Method in class io.storj.Project
Deletes an object from this bucket.
dialTimeout(int) - Static method in class io.storj.UplinkOption
Option for dial timeout which defines how long client should wait for establishing connection to peers.
downloadObject(String, String, ObjectDownloadOption...) - Method in class io.storj.Project
Starts a download from the specific key.

E

EncryptionKey - Class in io.storj
 
EncryptionKey(String, byte[]) - Constructor for class io.storj.EncryptionKey
 
ensureBucket(String) - Method in class io.storj.Project
Ensures that a bucket exists in this project.
equals(Object) - Method in class io.storj.BucketInfo
Two BucketInfo objects are equal if their names are equal.
equals(Object) - Method in class io.storj.ObjectInfo
Two ObjectInfo objects are equal if their names are equal.
equals(Object) - Method in class io.storj.SystemMetadata
Two SystemMetadata objects are equal.
expires(Date) - Static method in class io.storj.ObjectUploadOption
Option for the expiration date of the new object.

G

getContentLength() - Method in class io.storj.SystemMetadata
Returns object content length.
getCreated() - Method in class io.storj.BucketInfo
Returns the time when the bucket was created.
getCreated() - Method in class io.storj.SystemMetadata
Returns object creation date.
getCustomMetadata() - Method in class io.storj.ObjectInfo
Returns objects custom metadata.
getExpires() - Method in class io.storj.SystemMetadata
Returns when object will expire.
getKey() - Method in class io.storj.ObjectInfo
Returns the key to the object relative to the bucket.
getName() - Method in class io.storj.BucketInfo
Returns the bucket name.
getSystemMetadata() - Method in class io.storj.ObjectInfo
Returns objects system metadata e.g.

H

hashCode() - Method in class io.storj.BucketInfo
The hash code value of BucketInfo is the hash code value of its name.
hashCode() - Method in class io.storj.ObjectInfo
The hash code value of ObjectInfo is the hash code value of its name.
hasNext() - Method in class io.storj.BucketIterator
 
hasNext() - Method in class io.storj.ObjectIterator
 

I

info() - Method in class io.storj.ObjectInputStream
Returns the last information about the object.
info() - Method in class io.storj.ObjectOutputStream
Returns the last information about the uploaded object.
io.storj - package io.storj
 
isPrefix() - Method in class io.storj.ObjectInfo
Returns if this is a prefix instead of an object.
iterator() - Method in class io.storj.BucketIterator
 
iterator() - Method in class io.storj.ObjectIterator
 

L

length(long) - Static method in class io.storj.ObjectDownloadOption
Option for the total bytes to download in bytes.
listBuckets(BucketListOption...) - Method in class io.storj.Project
 
listObjects(String, ObjectListOption...) - Method in class io.storj.Project
Lists the objects in this bucket.

N

next() - Method in class io.storj.BucketIterator
 
next() - Method in class io.storj.ObjectIterator
 
notAfter(Date) - Method in class io.storj.Permission.Builder
NotAfter restricts when the resulting access grant is valid for.
notBefore(Date) - Method in class io.storj.Permission.Builder
NotBefore restricts when the resulting access grant is valid for.

O

ObjectDownloadOption - Class in io.storj
Options for downloading object.
ObjectInfo - Class in io.storj
Represents object metadata.
ObjectInputStream - Class in io.storj
An InputStream for reading data from an object stored on the Storj network.
ObjectIterator - Class in io.storj
 
ObjectListOption - Class in io.storj
Options for listing object.
ObjectOutputStream - Class in io.storj
An OutputStream for writing data to an object stored on the Storj network.
ObjectUploadOption - Class in io.storj
Options for uploading object.
offset(long) - Static method in class io.storj.ObjectDownloadOption
Option for the starting offset of download in bytes.
openProject(Access) - Method in class io.storj.Uplink
Returns a Project handle for the given Access.
overrideEncryptionKey(String, String, EncryptionKey) - Method in class io.storj.Access
Overrides the root encryption key for the prefix in bucket with encryptionKey.

P

parse(String) - Static method in class io.storj.Access
Parses a base58-encoded String to an Access.
Permission - Class in io.storj
Represents a set of permission to apply to Access.
Permission.Builder - Class in io.storj
Builder for Permission objects.
prefix(String) - Static method in class io.storj.ObjectListOption
Option for the path prefix to filter the listing results.
Project - Class in io.storj
Represents a stateful resource to a project.

R

read() - Method in class io.storj.ObjectInputStream
Reads the next byte of data from the input stream.
read(byte[], int, int) - Method in class io.storj.ObjectInputStream
Reads up to len bytes of data from the input stream into an array of bytes.
recursive() - Static method in class io.storj.ObjectListOption
Option for recursive listing.
requestAccessWithPassphrase(String, String, String) - Method in class io.storj.Uplink
Generates a new access grant using a passhprase.

S

serialize() - Method in class io.storj.Access
Serializes this Access to base58-encoded String.
serializedAccess - Variable in class io.storj.Access
 
setCustomMetadata(Map<String, String>) - Method in class io.storj.ObjectOutputStream
Method updates custom metadata to be included with the object.
share(Permission, SharePrefix...) - Method in class io.storj.Access
Creates a new access grant with specific permissions.
SharePrefix - Class in io.storj
Represents a share based on a bucket and a prefix.
SharePrefix(String) - Constructor for class io.storj.SharePrefix
 
SharePrefix(String, String) - Constructor for class io.storj.SharePrefix
 
statBucket(String) - Method in class io.storj.Project
Returns bucket metadata.
statObject(String, String) - Method in class io.storj.Project
Returns object metadata.
StorjException - Exception in io.storj
Signals that an exception occurred when calling a method of the Storj library.
StorjException(Throwable) - Constructor for exception io.storj.StorjException
Constructs a StorjException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
StorjException(String) - Constructor for exception io.storj.StorjException
 
system() - Static method in class io.storj.ObjectListOption
Option for returning system metadata with object while listing.
SystemMetadata - Class in io.storj
Represents object system metadata like content length or creation date.

T

tempDir(String) - Static method in class io.storj.UplinkOption
Option for temp directory to be used during upload.
toString() - Method in class io.storj.ObjectInfo
 
toString() - Method in class io.storj.SystemMetadata
 

U

Uplink - Class in io.storj
Represents the main entrypoint to the Storj network.
Uplink(UplinkOption...) - Constructor for class io.storj.Uplink
 
UplinkOption - Class in io.storj
Options for configuring Uplink.
uploadObject(String, String, ObjectUploadOption...) - Method in class io.storj.Project
Uploads the content to a new object in this bucket.
userAgent(String) - Static method in class io.storj.UplinkOption
Option for user agent string.

W

write(int) - Method in class io.storj.ObjectOutputStream
Writes the specified byte to this output stream.
write(byte[], int, int) - Method in class io.storj.ObjectOutputStream
Writes len bytes from the specified byte array starting at offset off to this output stream.
A B C D E G H I L N O P R S T U W 
Skip navigation links