Class CloudStoragePath (0.127.28)

public final class CloudStoragePath implements Path

A Google Cloud Storage specific implementation of the java.nio.file.Path interface. An instance of this class locates an object or a "pseudo-directory" in GCS. This implementation allows one to use Java's standard file system API to deal with remote objects as if they are local files.

Example of using java.nio.file.Files to read all lines from a remote object:


 Path path = Paths.get(URI.create("gs://bucket/lolcat.csv"));
 List<String> lines = Files.readAllLines(path, StandardCharsets.UTF_8);

Inheritance

Object > CloudStoragePath

Implements

Path

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

bucket()

public String bucket()

Returns the Cloud Storage bucket name being served by this file system.

Returns
Type	Description
`String`

compareTo(Path other)

public int compareTo(Path other)

Parameter
Name	Description
`other`	`Path`

Returns
Type	Description
`int`

endsWith(String other)

public boolean endsWith(String other)

Parameter
Name	Description
`other`	`String`

Returns
Type	Description
`boolean`

endsWith(Path other)

public boolean endsWith(Path other)

Parameter
Name	Description
`other`	`Path`

Returns
Type	Description
`boolean`

equals(Object other)

public boolean equals(Object other)

Parameter
Name	Description
`other`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

getFileName()

public CloudStoragePath getFileName()

Returns
Type	Description
`CloudStoragePath`

getFileSystem()

public CloudStorageFileSystem getFileSystem()

Returns
Type	Description
`CloudStorageFileSystem`

getName(int index)

public CloudStoragePath getName(int index)

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CloudStoragePath`

getNameCount()

public int getNameCount()

Returns
Type	Description
`int`

getParent()

public CloudStoragePath getParent()

Returns
Type	Description
`CloudStoragePath`

getRoot()

public CloudStoragePath getRoot()

Returns
Type	Description
`CloudStoragePath`

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()

isAbsolute()

public boolean isAbsolute()

Returns
Type	Description
`boolean`

iterator()

public Iterator<Path> iterator()

Returns
Type	Description
`Iterator<Path>`

normalize()

public CloudStoragePath normalize()

Returns path without extra slashes or . and .. and preserves trailing slash.

Returns
Type	Description
`CloudStoragePath`

register(WatchService watcher, WatchEvent.Kind<?>[] events)

public WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events)

Throws UnsupportedOperationException because this feature hasn't been implemented yet.

Parameters
Name	Description
`watcher`	`WatchService`
`events`	`Kind<?>[]`

Returns
Type	Description
`WatchKey`

register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier[] modifiers)

public WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier[] modifiers)

Throws UnsupportedOperationException because this feature hasn't been implemented yet.

Parameters
Name	Description
`watcher`	`WatchService`
`events`	`Kind<?>[]`
`modifiers`	`java.nio.file.WatchEvent.Modifier[]`

Returns
Type	Description
`WatchKey`

relativize(Path object)

public CloudStoragePath relativize(Path object)

Parameter
Name	Description
`object`	`Path`

Returns
Type	Description
`CloudStoragePath`

resolve(String other)

public CloudStoragePath resolve(String other)

Parameter
Name	Description
`other`	`String`

Returns
Type	Description
`CloudStoragePath`

resolve(Path object)

public CloudStoragePath resolve(Path object)

Parameter
Name	Description
`object`	`Path`

Returns
Type	Description
`CloudStoragePath`

resolveSibling(String other)

public CloudStoragePath resolveSibling(String other)

Parameter
Name	Description
`other`	`String`

Returns
Type	Description
`CloudStoragePath`

resolveSibling(Path other)

public CloudStoragePath resolveSibling(Path other)

Parameter
Name	Description
`other`	`Path`

Returns
Type	Description
`CloudStoragePath`

startsWith(String other)

public boolean startsWith(String other)

Parameter
Name	Description
`other`	`String`

Returns
Type	Description
`boolean`

startsWith(Path other)

public boolean startsWith(Path other)

Parameter
Name	Description
`other`	`Path`

Returns
Type	Description
`boolean`

subpath(int beginIndex, int endIndex)

public CloudStoragePath subpath(int beginIndex, int endIndex)

Parameters
Name	Description
`beginIndex`	`int`
`endIndex`	`int`

Returns
Type	Description
`CloudStoragePath`

toAbsolutePath()

public CloudStoragePath toAbsolutePath()

Changes relative path to be absolute, using workingDirectory as current dir.

Returns
Type	Description
`CloudStoragePath`

toFile()

public File toFile()

Throws UnsupportedOperationException because Google Cloud Storage files are not backed by the local file system.

Returns
Type	Description
`File`

toRealPath(LinkOption[] options)

public CloudStoragePath toRealPath(LinkOption[] options)

Returns this path rewritten to the Cloud Storage object name that'd be used to perform i/o.

This method makes path absolute and removes the prefix slash from the absolute path when stripPrefixSlash is true.

Parameter
Name	Description
`options`	`java.nio.file.LinkOption[]`

Returns
Type	Description
`CloudStoragePath`

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

Object.toString()

toUri()

public URI toUri()

Returns
Type	Description
`URI`