org.apache.beam.artifact.local

Class LocalArtifactStagingLocation

java.lang.Object

org.apache.beam.artifact.local.LocalArtifactStagingLocation

public class LocalArtifactStagingLocation
extends java.lang.Object

A location where the results of an LocalFileSystemArtifactStagerService are stored and where the retrieval service retrieves them from.

Method Summary

Modifier and Type	Method and Description
static LocalArtifactStagingLocation	createAt(java.io.File rootDirectory) Create a new LocalArtifactStagingLocation rooted at the specified location, creating any directories or subdirectories as necessary.
static LocalArtifactStagingLocation	forExistingDirectory(java.io.File rootDirectory) Create a LocalArtifactStagingLocation for an existing directory.
java.io.File	getArtifactFile(java.lang.String artifactName) Returns the File which contains the artifact with the provided name.
java.io.File	getManifestFile() Returns the File which contains the ArtifactApi.Manifest.
java.lang.String	getRootPath() Returns the local location of this LocalArtifactStagingLocation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createAt

public static LocalArtifactStagingLocation createAt(java.io.File rootDirectory)

Create a new LocalArtifactStagingLocation rooted at the specified location, creating any directories or subdirectories as necessary.

forExistingDirectory

public static LocalArtifactStagingLocation forExistingDirectory(java.io.File rootDirectory)

Create a LocalArtifactStagingLocation for an existing directory. The directory must contain a manifest and an artifact directory.

getArtifactFile

public java.io.File getArtifactFile(java.lang.String artifactName)

Returns the File which contains the artifact with the provided name.

The file may not exist.

getManifestFile

public java.io.File getManifestFile()

Returns the File which contains the ArtifactApi.Manifest.

The file may not exist.

getRootPath

public java.lang.String getRootPath()

Returns the local location of this LocalArtifactStagingLocation.

This can be used to refer to the staging location when creating a retrieval service.