GcsPath (Apache Beam 2.23.0)

java.lang.Object
- org.apache.beam.sdk.extensions.gcp.util.gcsfs.GcsPath

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.nio.file.Path>, java.lang.Iterable<java.nio.file.Path>, java.nio.file.Path, java.nio.file.Watchable
```
public class GcsPath
extends java.lang.Object
implements java.nio.file.Path, java.io.Serializable
```
Implements the Java NIO Path API for Google Cloud Storage paths.
GcsPath uses a slash ('/') as a directory separator. Below is a summary of how slashes are treated:
- A GCS bucket may not contain a slash. An object may contain zero or more slashes.
- A trailing slash always indicates a directory, which is compliant with POSIX.1-2008.
- Slashes separate components of a path. Empty components are allowed, these are represented as repeated slashes. An empty component always refers to a directory, and always ends in a slash.
- getParent()} always returns a path ending in a slash, as the parent of a GcsPath is always a directory.
- Use resolve(String) to append elements to a GcsPath -- this applies the rules consistently and is highly recommended over any custom string concatenation.
GcsPath treats all GCS objects and buckets as belonging to the same filesystem, so the root of a GcsPath is the GcsPath bucket="", object="".
Relative paths are not associated with any bucket. This matches common treatment of Path in which relative paths can be constructed from one filesystem and appended to another filesystem.
See Also:

Java Tutorials: Path Operations, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.util.regex.Pattern GCS_URI
Pattern that is used to parse a GCS URL.

static java.lang.String SCHEME

Fields
Modifier and Type	Field and Description
`static java.util.regex.Pattern`	`GCS_URI` Pattern that is used to parse a GCS URL.
`static java.lang.String`	`SCHEME`

Constructor Summary

Constructors
Constructor and Description

GcsPath(java.nio.file.FileSystem fs, java.lang.String bucket, java.lang.String object)
Constructs a GcsPath.

Constructors
Constructor and Description
`GcsPath(java.nio.file.FileSystem fs, java.lang.String bucket, java.lang.String object)` Constructs a GcsPath.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(java.nio.file.Path other)`
`boolean`	`endsWith(java.nio.file.Path other)`
`boolean`	`endsWith(java.lang.String suffix)`
`boolean`	`equals(java.lang.Object o)`
`static GcsPath`	`fromComponents(java.lang.String bucket, java.lang.String object)` Creates a GcsPath from bucket and object components.
`static GcsPath`	`fromObject(StorageObject object)` Creates a GcsPath from a StorageObject.
`static GcsPath`	`fromResourceName(java.lang.String name)` Creates a GcsPath from a OnePlatform resource name in string form.
`static GcsPath`	`fromUri(java.lang.String uri)` Creates a GcsPath from a URI in string form.
`static GcsPath`	`fromUri(java.net.URI uri)` Creates a GcsPath from a URI.
`java.lang.String`	`getBucket()` Returns the bucket name associated with this GCS path, or an empty string if this is a relative path component.
`GcsPath`	`getFileName()`
`java.nio.file.FileSystem`	`getFileSystem()`
`GcsPath`	`getName(int count)`
`int`	`getNameCount()`
`java.lang.String`	`getObject()` Returns the object name associated with this GCS path, or an empty string if no object is specified.
`GcsPath`	`getParent()` Returns the parent path, or `null` if this path does not have a parent.
`GcsPath`	`getRoot()`
`int`	`hashCode()`
`boolean`	`isAbsolute()`
`java.util.Iterator<java.nio.file.Path>`	`iterator()`
`GcsPath`	`normalize()`
`java.nio.file.WatchKey`	`register(java.nio.file.WatchService watcher, java.nio.file.WatchEvent.Kind<?>... events)`
`java.nio.file.WatchKey`	`register(java.nio.file.WatchService watcher, java.nio.file.WatchEvent.Kind<?>[] events, java.nio.file.WatchEvent.Modifier... modifiers)`
`java.nio.file.Path`	`relativize(java.nio.file.Path other)`
`GcsPath`	`resolve(java.nio.file.Path other)`
`GcsPath`	`resolve(java.lang.String other)`
`java.nio.file.Path`	`resolveSibling(java.nio.file.Path other)`
`java.nio.file.Path`	`resolveSibling(java.lang.String other)`
`void`	`setFileSystem(java.nio.file.FileSystem fs)`
`boolean`	`startsWith(java.nio.file.Path other)`
`boolean`	`startsWith(java.lang.String prefix)`
`GcsPath`	`subpath(int beginIndex, int endIndex)`
`GcsPath`	`toAbsolutePath()`
`java.io.File`	`toFile()`
`GcsPath`	`toRealPath(java.nio.file.LinkOption... options)`
`java.lang.String`	`toResourceName()`
`java.lang.String`	`toString()`
`java.net.URI`	`toUri()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - SCHEME
```
public static final java.lang.String SCHEME
```
    See Also:
    
    Constant Field Values
  - GCS_URI
```
public static final java.util.regex.Pattern GCS_URI
```
    Pattern that is used to parse a GCS URL.
    This is used to separate the components. Verification is handled separately.
- Constructor Detail
  - GcsPath
```
public GcsPath(@Nullable
               java.nio.file.FileSystem fs,
               @Nullable
               java.lang.String bucket,
               @Nullable
               java.lang.String object)
```
    Constructs a GcsPath.
    
    Parameters:
    
    fs - the associated FileSystem, if any
    
    bucket - the associated bucket, or none (null or an empty string) for a relative path component
    
    object - the object, which is a fully-qualified object name if bucket was also provided, or none (null or an empty string) for no object
    
    Throws:
    
    java.lang.IllegalArgumentException - if the bucket of object names are invalid.
- Method Detail
  - fromUri
```
public static GcsPath fromUri(java.net.URI uri)
```
    Creates a GcsPath from a URI.
    The URI must be in the form gs://[bucket]/[path], and may not contain a port, user info, a query, or a fragment.
  - fromUri
```
public static GcsPath fromUri(java.lang.String uri)
```
    Creates a GcsPath from a URI in string form.
    This does not use URI parsing, which means it may accept patterns that the URI parser would not accept.
  - fromResourceName
```
public static GcsPath fromResourceName(java.lang.String name)
```
    Creates a GcsPath from a OnePlatform resource name in string form.
  - fromObject
```
public static GcsPath fromObject(StorageObject object)
```
    Creates a GcsPath from a StorageObject.
  - fromComponents
```
public static GcsPath fromComponents(@Nullable
                                     java.lang.String bucket,
                                     @Nullable
                                     java.lang.String object)
```
    Creates a GcsPath from bucket and object components.
    A GcsPath without a bucket name is treated as a relative path, which is a path component with no linkage to the root element. This is similar to a Unix path that does not begin with the root marker (a slash). GCS has different naming constraints and APIs for working with buckets and objects, so these two concepts are kept separate to avoid accidental attempts to treat objects as buckets, or vice versa, as much as possible.
    A GcsPath without an object name is a bucket reference. A bucket is always a directory, which could be used to lookup or add files to a bucket, but could not be opened as a file.
    A GcsPath containing neither bucket or object names is treated as the root of the GCS filesystem. A listing on the root element would return the buckets available to the user.
    If null is passed as either parameter, it is converted to an empty string internally for consistency. There is no distinction between an empty string and a null, as neither are allowed by GCS.
    
    Parameters:
    
    bucket - a GCS bucket name, or none (null or an empty string) if the object is not associated with a bucket (e.g. relative paths or the root node).
    
    object - a GCS object path, or none (null or an empty string) for no object.
  - getBucket
```
public java.lang.String getBucket()
```
    Returns the bucket name associated with this GCS path, or an empty string if this is a relative path component.
  - getObject
```
public java.lang.String getObject()
```
    Returns the object name associated with this GCS path, or an empty string if no object is specified.
  - setFileSystem
```
public void setFileSystem(java.nio.file.FileSystem fs)
```
  - getFileSystem
```
public java.nio.file.FileSystem getFileSystem()
```
    Specified by:
    
    getFileSystem in interface java.nio.file.Path
  - isAbsolute
```
public boolean isAbsolute()
```
    Specified by:
    
    isAbsolute in interface java.nio.file.Path
  - getRoot
```
public GcsPath getRoot()
```
    Specified by:
    
    getRoot in interface java.nio.file.Path
  - getFileName
```
public GcsPath getFileName()
```
    Specified by:
    
    getFileName in interface java.nio.file.Path
  - getParent
```
public GcsPath getParent()
```
    Returns the parent path, or null if this path does not have a parent.
    Returns a path that ends in '/', as the parent path always refers to a directory.
    
    Specified by:
    
    getParent in interface java.nio.file.Path
  - getNameCount
```
public int getNameCount()
```
    Specified by:
    
    getNameCount in interface java.nio.file.Path
  - getName
```
public GcsPath getName(int count)
```
    Specified by:
    
    getName in interface java.nio.file.Path
  - subpath
```
public GcsPath subpath(int beginIndex,
                       int endIndex)
```
    Specified by:
    
    subpath in interface java.nio.file.Path
  - startsWith
```
public boolean startsWith(java.nio.file.Path other)
```
    Specified by:
    
    startsWith in interface java.nio.file.Path
  - startsWith
```
public boolean startsWith(java.lang.String prefix)
```
    Specified by:
    
    startsWith in interface java.nio.file.Path
  - endsWith
```
public boolean endsWith(java.nio.file.Path other)
```
    Specified by:
    
    endsWith in interface java.nio.file.Path
  - endsWith
```
public boolean endsWith(java.lang.String suffix)
```
    Specified by:
    
    endsWith in interface java.nio.file.Path
  - normalize
```
public GcsPath normalize()
```
    Specified by:
    
    normalize in interface java.nio.file.Path
  - resolve
```
public GcsPath resolve(java.nio.file.Path other)
```
    Specified by:
    
    resolve in interface java.nio.file.Path
  - resolve
```
public GcsPath resolve(java.lang.String other)
```
    Specified by:
    
    resolve in interface java.nio.file.Path
  - resolveSibling
```
public java.nio.file.Path resolveSibling(java.nio.file.Path other)
```
    Specified by:
    
    resolveSibling in interface java.nio.file.Path
  - resolveSibling
```
public java.nio.file.Path resolveSibling(java.lang.String other)
```
    Specified by:
    
    resolveSibling in interface java.nio.file.Path
  - relativize
```
public java.nio.file.Path relativize(java.nio.file.Path other)
```
    Specified by:
    
    relativize in interface java.nio.file.Path
  - toAbsolutePath
```
public GcsPath toAbsolutePath()
```
    Specified by:
    
    toAbsolutePath in interface java.nio.file.Path
  - toRealPath
```
public GcsPath toRealPath(java.nio.file.LinkOption... options)
                   throws java.io.IOException
```
    Specified by:
    
    toRealPath in interface java.nio.file.Path
    
    Throws:
    
    java.io.IOException
  - toFile
```
public java.io.File toFile()
```
    Specified by:
    
    toFile in interface java.nio.file.Path
  - register
```
public java.nio.file.WatchKey register(java.nio.file.WatchService watcher,
                                       java.nio.file.WatchEvent.Kind<?>[] events,
                                       java.nio.file.WatchEvent.Modifier... modifiers)
                                throws java.io.IOException
```
    Specified by:
    
    register in interface java.nio.file.Path
    
    Specified by:
    
    register in interface java.nio.file.Watchable
    
    Throws:
    
    java.io.IOException
  - register
```
public java.nio.file.WatchKey register(java.nio.file.WatchService watcher,
                                       java.nio.file.WatchEvent.Kind<?>... events)
                                throws java.io.IOException
```
    Specified by:
    
    register in interface java.nio.file.Path
    
    Specified by:
    
    register in interface java.nio.file.Watchable
    
    Throws:
    
    java.io.IOException
  - iterator
```
public java.util.Iterator<java.nio.file.Path> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.nio.file.Path>
    
    Specified by:
    
    iterator in interface java.nio.file.Path
  - compareTo
```
public int compareTo(java.nio.file.Path other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<java.nio.file.Path>
    
    Specified by:
    
    compareTo in interface java.nio.file.Path
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.nio.file.Path
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.nio.file.Path
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface java.nio.file.Path
    
    Overrides:
    
    toString in class java.lang.Object
  - toResourceName
```
public java.lang.String toResourceName()
```
  - toUri
```
public java.net.URI toUri()
```
    Specified by:
    
    toUri in interface java.nio.file.Path

Class GcsPath

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

SCHEME

GCS_URI

Constructor Detail

GcsPath

Method Detail

fromUri

fromUri

fromResourceName

fromObject

fromComponents

getBucket

getObject

setFileSystem

getFileSystem

isAbsolute

getRoot

getFileName

getParent

getNameCount

getName

subpath

startsWith

startsWith

endsWith

endsWith

normalize

resolve

resolve

resolveSibling

resolveSibling

relativize

toAbsolutePath

toRealPath

toFile

register

register

iterator

compareTo

equals

hashCode

toString

toResourceName

toUri