ml.comet.experiment

Class CometApiImpl

java.lang.Object

ml.comet.experiment.CometApiImpl

All Implemented Interfaces:

Closeable, AutoCloseable, CometApi

public final class CometApiImpl
extends Object
implements CometApi

The CometApi implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CometApiImpl.CometApiBuilder The builder to create properly configured instance of the CometApiImpl.

Constructor Summary

Constructors

Constructor and Description
CometApiImpl(@NonNull String apiKey, @NonNull String baseUrl, int maxAuthRetries)

Method Summary

Modifier and Type	Method and Description
static CometApiImpl.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<ExperimentMetadataRest>	getAllExperiments(@NonNull String projectId) Gets all experiment dto under specified project id
List<RestProject>	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

Constructor Detail

CometApiImpl

public CometApiImpl(@NonNull
                    @NonNull String apiKey,
                    @NonNull
                    @NonNull String baseUrl,
                    int maxAuthRetries)

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<RestProject> 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<ExperimentMetadataRest> getAllExperiments(@NonNull
                                                      @NonNull String projectId)

Description copied from interface: CometApi

Gets all experiment dto under specified project id

Specified by:

getAllExperiments in interface CometApi

Parameters:

projectId - Project id

Returns:

List of experiment dtos

builder

public static CometApiImpl.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.

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.