ml.comet.experiment.impl

Class LoggedArtifactAssetImpl

java.lang.Object

ml.comet.experiment.impl.LoggedArtifactAssetImpl

All Implemented Interfaces:

LoggedArtifactAsset

public final class LoggedArtifactAssetImpl
extends Object
implements LoggedArtifactAsset

Implementation of the LoggedArtifactAsset.

Method Summary

Modifier and Type	Method and Description
ArtifactAsset	download(Path dir)
ArtifactAsset	download(Path dir, AssetOverwriteStrategy overwriteStrategy)
ArtifactAsset	download(@NonNull Path dir, @NonNull Path file, @NonNull AssetOverwriteStrategy overwriteStrategy) Downloads asset to the given directory.
String	getArtifactId() Returns unique identifier of the artifact.
String	getArtifactVersionId() Returns the unique identifier of the artifact version.
Optional<URI>	getLink() Returns the optional URI of the asset if this is remote asset.
Map<String,Object>	getMetadata() Returns metadata assigned to this asset.
Optional<Long>	getSize() Returns the optional size of the asset.
InputStream	openStream() Opens a connection to this LoggedArtifactAsset and returns an InputStream for reading from this connection.
void	writeTo(OutputStream out) Allows loading of asset bytes from Comet server and write to the provided OutputStream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ml.comet.experiment.artifact.LoggedArtifactAsset

getAssetId, getAssetType, getLogicalPath, isRemote

Method Detail

getArtifactId

public String getArtifactId()

Description copied from interface: LoggedArtifactAsset

Returns unique identifier of the artifact.

Specified by:

getArtifactId in interface LoggedArtifactAsset

Returns:

the unique identifier of the artifact.

getArtifactVersionId

public String getArtifactVersionId()

Description copied from interface: LoggedArtifactAsset

Returns the unique identifier of the artifact version.

Specified by:

getArtifactVersionId in interface LoggedArtifactAsset

Returns:

the unique identifier of the artifact version.

getSize

public Optional<Long> getSize()

Description copied from interface: LoggedArtifactAsset

Returns the optional size of the asset.

Specified by:

getSize in interface LoggedArtifactAsset

Returns:

the optional size of the asset.

getLink

public Optional<URI> getLink()

Description copied from interface: LoggedArtifactAsset

Returns the optional URI of the asset if this is remote asset.

Specified by:

getLink in interface LoggedArtifactAsset

Returns:

the optional URI of the asset if this is remote asset.

getMetadata

public Map<String,Object> getMetadata()

Description copied from interface: LoggedArtifactAsset

Returns metadata assigned to this asset.

Specified by:

getMetadata in interface LoggedArtifactAsset

Returns:

the metadata assigned to this asset or empty Map if no metadata was assigned.

download

public ArtifactAsset download(Path dir)
                       throws ArtifactException

Specified by:

download in interface LoggedArtifactAsset

Throws:

ArtifactException

download

public ArtifactAsset download(Path dir,
                              AssetOverwriteStrategy overwriteStrategy)
                       throws ArtifactException

Specified by:

download in interface LoggedArtifactAsset

Throws:

ArtifactException

download

public ArtifactAsset download(@NonNull
                              @NonNull Path dir,
                              @NonNull
                              @NonNull Path file,
                              @NonNull
                              @NonNull AssetOverwriteStrategy overwriteStrategy)
                       throws ArtifactException

Description copied from interface: LoggedArtifactAsset

Downloads asset to the given directory.

Specified by:

download in interface LoggedArtifactAsset

Parameters:

dir - the root folder to which to download.

file - the path relative to the root. If not provided the asset file name will be used as path relative to the root directory.

overwriteStrategy - overwrite strategy to handle conflicting file names.

Returns:

the ArtifactAsset representing downloaded asset file.

Throws:

ArtifactException - if operation failed.

writeTo

public void writeTo(OutputStream out)
             throws ArtifactException

Description copied from interface: LoggedArtifactAsset

Allows loading of asset bytes from Comet server and write to the provided OutputStream.

Specified by:

writeTo in interface LoggedArtifactAsset

Parameters:

out - the OutputStream where downloaded asset bytes will be written.

Throws:

ArtifactException - if operation failed.

openStream

public InputStream openStream()
                       throws ArtifactException

Description copied from interface: LoggedArtifactAsset

Opens a connection to this LoggedArtifactAsset and returns an InputStream for reading from this connection.

NOTE: You are responsible to close an InputStream to avoid resource leak.

Specified by:

openStream in interface LoggedArtifactAsset

Returns:

an input stream for reading asset's data bytes.

Throws:

ArtifactException - if operation failed.