ml.comet.experiment.artifact

Interface LoggedArtifactAsset

All Known Implementing Classes:

LoggedArtifactAssetImpl

public interface LoggedArtifactAsset

Defines the public contract of the asset logged by the Comet artifact.

Method Summary

Modifier and Type	Method and Description
ArtifactAsset	download(Path dir)
ArtifactAsset	download(Path dir, AssetOverwriteStrategy overwriteStrategy)
ArtifactAsset	download(Path dir, Path file, 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.
String	getAssetId() Returns unique identifier of this asset.
String	getAssetType() Returns type of this asset.
Optional<URI>	getLink() Returns the optional URI of the asset if this is remote asset.
String	getLogicalPath() Returns the logical path of the asset file.
Map<String,Object>	getMetadata() Returns metadata assigned to this asset.
Optional<Long>	getSize() Returns the optional size of the asset.
boolean	isRemote() Allows checking if this is remote 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.

Method Detail

getArtifactId

String getArtifactId()

Returns unique identifier of the artifact.

Returns:

the unique identifier of the artifact.

getArtifactVersionId

String getArtifactVersionId()

Returns the unique identifier of the artifact version.

Returns:

the unique identifier of the artifact version.

getAssetId

String getAssetId()

Returns unique identifier of this asset.

Returns:

the unique identifier of this asset.

getAssetType

String getAssetType()

Returns type of this asset.

Returns:

the type of this asset.

getLogicalPath

String getLogicalPath()

Returns the logical path of the asset file.

Returns:

the logical path of the asset file.

getSize

Optional<Long> getSize()

Returns the optional size of the asset.

Returns:

the optional size of the asset.

getLink

Optional<URI> getLink()

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

Returns:

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

getMetadata

Map<String,Object> getMetadata()

Returns metadata assigned to this asset.

Returns:

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

isRemote

boolean isRemote()

Allows checking if this is remote asset.

Returns:

true if this is remote asset.

download

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

Downloads asset to the given directory.

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.

download

ArtifactAsset download(Path dir,
                       AssetOverwriteStrategy overwriteStrategy)
                throws ArtifactException

Throws:

ArtifactException

download

ArtifactAsset download(Path dir)
                throws ArtifactException

Throws:

ArtifactException

writeTo

void writeTo(OutputStream out)
      throws ArtifactException

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

Parameters:

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

Throws:

ArtifactException - if operation failed.

openStream

InputStream openStream()
                throws ArtifactException

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.

Returns:

an input stream for reading asset's data bytes.

Throws:

ArtifactException - if operation failed.