ml.comet.experiment.artifact

Class GetArtifactOptions.GetArtifactOptionsBuilder

java.lang.Object

ml.comet.experiment.artifact.GetArtifactOptions.GetArtifactOptionsBuilder

Enclosing class:

GetArtifactOptions

public static final class GetArtifactOptions.GetArtifactOptionsBuilder
extends Object

The builder to create properly initialized instances of the GetArtifactOptions.

Method Summary

Modifier and Type	Method and Description
GetArtifactOptions.GetArtifactOptionsBuilder	alias(@NonNull String alias) Creates option to get artifact version with specific alias.
GetArtifactOptions.GetArtifactOptionsBuilder	artifactId(@NonNull String artifactId) Creates option with artifact ID.
GetArtifactOptions	build() Creates properly initialized instance of the GetArtifactOptions.
GetArtifactOptions.GetArtifactOptionsBuilder	consumerExperimentKey(@NonNull String consumerExperimentKey) Creates option allowing to override the experiment key associated with artifact.
GetArtifactOptions.GetArtifactOptionsBuilder	fullName(@NonNull String fullArtifactName) Creates option from fully qualified artifact name.
GetArtifactOptions.GetArtifactOptionsBuilder	name(@NonNull String artifactName) Creates option with artifact name.
GetArtifactOptions.GetArtifactOptionsBuilder	projectName(@NonNull String project) Creates option with project name/id.
GetArtifactOptions.GetArtifactOptionsBuilder	version(@NonNull String version) Creates option with specific version of the artifact to be retrieved.
GetArtifactOptions.GetArtifactOptionsBuilder	versionId(@NonNull String versionId) Creates option with specific ID of the version of the artifact to be retrieved.
GetArtifactOptions.GetArtifactOptionsBuilder	versionOrAlias(@NonNull String versionOrAlias) Creates option to get artifact version either by alias or version string.
GetArtifactOptions.GetArtifactOptionsBuilder	workspaceName(@NonNull String workspace) Creates option with workspace name/id.

Methods inherited from class java.lang.Object

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

Method Detail

workspaceName

public GetArtifactOptions.GetArtifactOptionsBuilder workspaceName(@NonNull
                                                                  @NonNull String workspace)

Creates option with workspace name/id.

Parameters:

workspace - the workspace name/id.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

projectName

public GetArtifactOptions.GetArtifactOptionsBuilder projectName(@NonNull
                                                                @NonNull String project)

Creates option with project name/id.

Parameters:

project - the project name/id.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

name

public GetArtifactOptions.GetArtifactOptionsBuilder name(@NonNull
                                                         @NonNull String artifactName)

Creates option with artifact name.

Parameters:

artifactName - the short artifact name like 'artifact-name'.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

fullName

public GetArtifactOptions.GetArtifactOptionsBuilder fullName(@NonNull
                                                             @NonNull String fullArtifactName)

Creates option from fully qualified artifact name. The provided name will be parsed and corresponding options will be set if defined: name, workspace, and versionOrAlias.

Parameters:

fullArtifactName - the fully qualified artifact name like 'workspace/artifact-name:versionOrAlias' or 'artifact-name:versionOrAlias'

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

artifactId

public GetArtifactOptions.GetArtifactOptionsBuilder artifactId(@NonNull
                                                               @NonNull String artifactId)

Creates option with artifact ID.

Parameters:

artifactId - the ID of the artifact.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

version

public GetArtifactOptions.GetArtifactOptionsBuilder version(@NonNull
                                                            @NonNull String version)

Creates option with specific version of the artifact to be retrieved.

Parameters:

version - the version of the artifact.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

versionId

public GetArtifactOptions.GetArtifactOptionsBuilder versionId(@NonNull
                                                              @NonNull String versionId)

Creates option with specific ID of the version of the artifact to be retrieved.

Parameters:

versionId - the ID of specific version of the artifact.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

alias

public GetArtifactOptions.GetArtifactOptionsBuilder alias(@NonNull
                                                          @NonNull String alias)

Creates option to get artifact version with specific alias.

Parameters:

alias - the artifact version alias.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

versionOrAlias

public GetArtifactOptions.GetArtifactOptionsBuilder versionOrAlias(@NonNull
                                                                   @NonNull String versionOrAlias)

Creates option to get artifact version either by alias or version string.

Parameters:

versionOrAlias - the alias or version string.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

consumerExperimentKey

public GetArtifactOptions.GetArtifactOptionsBuilder consumerExperimentKey(@NonNull
                                                                          @NonNull String consumerExperimentKey)

Creates option allowing to override the experiment key associated with artifact.

Parameters:

consumerExperimentKey - the new experiment key to be associated.

Returns:

the GetArtifactOptions.GetArtifactOptionsBuilder instance with option set.

build

public GetArtifactOptions build()

Creates properly initialized instance of the GetArtifactOptions.

Returns:

the properly initialized instance of the GetArtifactOptions.