ml.comet.experiment.artifact

Interface ArtifactBuilder

public interface ArtifactBuilder

The factory to properly create initialized Artifact instances.

Method Summary

Modifier and Type	Method and Description
Artifact	build() Creates properly initialized Artifact instance.
ArtifactBuilder	withAliases(List<String> aliases) Allows to attach the provided list of aliases to the Artifact.
ArtifactBuilder	withMetadata(Map<String,Object> metadata) Allows linking the metadata with the Artifact instance.
ArtifactBuilder	withVersion(String version) Allows specifying version for the artifact.
ArtifactBuilder	withVersionTags(List<String> tags) Allows specifying list of TAG strings to be associated with artifact version.

Method Detail

withAliases

ArtifactBuilder withAliases(List<String> aliases)

Allows to attach the provided list of aliases to the Artifact.

Parameters:

aliases - the list of aliases.

Returns:

the builder instance.

withMetadata

ArtifactBuilder withMetadata(Map<String,Object> metadata)

Allows linking the metadata with the Artifact instance.

Parameters:

metadata - the metadata to link with artifact.

Returns:

the builder instance.

withVersion

ArtifactBuilder withVersion(String version)

Allows specifying version for the artifact. The version string should follow the semantic versioning rules and be in the form: 1.2.3-beta.4+sha899d8g79f87

• 1 is the major part (required)
• 2 is the minor part (required)
• 3 is the patch part (required)
• beta and 4 are the version suffixes (optional)
• sha899d8g79f87 is the build information (optional)

Parameters:

version - the version string to be associated with artifact.

Returns:

the builder instance.

withVersionTags

ArtifactBuilder withVersionTags(List<String> tags)

Allows specifying list of TAG strings to be associated with artifact version.

Parameters:

tags - the list of TAG strings.

Returns:

the builder instance.

build

Artifact build()

Creates properly initialized Artifact instance.

Returns:

the properly initialized Artifact instance.