ml.comet.experiment.impl

Class CometApiImpl

java.lang.Object

ml.comet.experiment.impl.CometApiImpl

All Implemented Interfaces:

Closeable, AutoCloseable, CometApi

public final class CometApiImpl
extends Object
implements CometApi

The implementation of the CometApi.

Method Summary

Modifier and Type	Method and Description
static CometApiBuilder	builder() Returns builder to be used to properly create instance of this class.
void	close() Release all resources hold by this instance, such as connection to the Comet server.
List<ExperimentMetadata>	getAllExperiments(@NonNull String projectId) Gets all experiment DTOs under specified project id.
List<Project>	getAllProjects(@NonNull String workspaceName) Gets all project DTOs under specified workspace name.
List<String>	getAllWorkspaces() Gets all workspaces available for current API key.

Methods inherited from class java.lang.Object

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

Method Detail

getAllWorkspaces

public List<String> getAllWorkspaces()

Description copied from interface: CometApi

Gets all workspaces available for current API key.

Specified by:

getAllWorkspaces in interface CometApi

Returns:

List of workspace names

getAllProjects

public List<Project> getAllProjects(@NonNull
                                    @NonNull String workspaceName)

Description copied from interface: CometApi

Gets all project DTOs under specified workspace name.

Specified by:

getAllProjects in interface CometApi

Parameters:

workspaceName - workspace name

Returns:

List of project DTOs

getAllExperiments

public List<ExperimentMetadata> getAllExperiments(@NonNull
                                                  @NonNull String projectId)

Description copied from interface: CometApi

Gets all experiment DTOs under specified project id.

Specified by:

getAllExperiments in interface CometApi

Parameters:

projectId - Project id

Returns:

List of experiment DTOs

close

public void close()
           throws IOException

Release all resources hold by this instance, such as connection to the Comet server.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O exception occurs.

builder

public static CometApiBuilder builder()

Returns builder to be used to properly create instance of this class.

Returns:

the builder to be used to properly create instance of this class.