Class Experiment.Builder
-
- All Implemented Interfaces:
public final class Experiment.BuilderA builder for Experiment.
-
-
Method Summary
Modifier and Type Method Description final Experiment.Builderid(String id)Unique identifier for the experiment final Experiment.Builderid(JsonField<String> id)Sets Builder.id to an arbitrary JSON value. final Experiment.Buildername(String name)Name of the experiment. final Experiment.Buildername(JsonField<String> name)Sets Builder.name to an arbitrary JSON value. final Experiment.BuilderprojectId(String projectId)Unique identifier for the project that the experiment belongs under final Experiment.BuilderprojectId(JsonField<String> projectId)Sets Builder.projectId to an arbitrary JSON value. final Experiment.Builderpublic_(Boolean public_)Whether or not the experiment is public. final Experiment.Builderpublic_(JsonField<Boolean> public_)Sets Builder.public_ to an arbitrary JSON value. final Experiment.BuilderbaseExpId(String baseExpId)Id of default base experiment to compare against when viewing this experiment final Experiment.BuilderbaseExpId(Optional<String> baseExpId)Alias for calling Builder.baseExpId with baseExpId.orElse(null).final Experiment.BuilderbaseExpId(JsonField<String> baseExpId)Sets Builder.baseExpId to an arbitrary JSON value. final Experiment.Buildercommit(String commit)Commit, taken directly from repo_info.commitfinal Experiment.Buildercommit(Optional<String> commit)Alias for calling Builder.commit with commit.orElse(null).final Experiment.Buildercommit(JsonField<String> commit)Sets Builder.commit to an arbitrary JSON value. final Experiment.Buildercreated(OffsetDateTime created)Date of experiment creation final Experiment.Buildercreated(Optional<OffsetDateTime> created)Alias for calling Builder.created with created.orElse(null).final Experiment.Buildercreated(JsonField<OffsetDateTime> created)Sets Builder.created to an arbitrary JSON value. final Experiment.BuilderdatasetId(String datasetId)Identifier of the linked dataset, or null if the experiment is not linked to a dataset final Experiment.BuilderdatasetId(Optional<String> datasetId)Alias for calling Builder.datasetId with datasetId.orElse(null).final Experiment.BuilderdatasetId(JsonField<String> datasetId)Sets Builder.datasetId to an arbitrary JSON value. final Experiment.BuilderdatasetVersion(String datasetVersion)Version number of the linked dataset the experiment was run against. final Experiment.BuilderdatasetVersion(Optional<String> datasetVersion)Alias for calling Builder.datasetVersion with datasetVersion.orElse(null).final Experiment.BuilderdatasetVersion(JsonField<String> datasetVersion)Sets Builder.datasetVersion to an arbitrary JSON value. final Experiment.BuilderdeletedAt(OffsetDateTime deletedAt)Date of experiment deletion, or null if the experiment is still active final Experiment.BuilderdeletedAt(Optional<OffsetDateTime> deletedAt)Alias for calling Builder.deletedAt with deletedAt.orElse(null).final Experiment.BuilderdeletedAt(JsonField<OffsetDateTime> deletedAt)Sets Builder.deletedAt to an arbitrary JSON value. final Experiment.Builderdescription(String description)Textual description of the experiment final Experiment.Builderdescription(Optional<String> description)Alias for calling Builder.description with description.orElse(null).final Experiment.Builderdescription(JsonField<String> description)Sets Builder.description to an arbitrary JSON value. final Experiment.Buildermetadata(Experiment.Metadata metadata)User-controlled metadata about the experiment final Experiment.Buildermetadata(Optional<Experiment.Metadata> metadata)Alias for calling Builder.metadata with metadata.orElse(null).final Experiment.Buildermetadata(JsonField<Experiment.Metadata> metadata)Sets Builder.metadata to an arbitrary JSON value. final Experiment.BuilderrepoInfo(RepoInfo repoInfo)Metadata about the state of the repo when the experiment was created final Experiment.BuilderrepoInfo(Optional<RepoInfo> repoInfo)Alias for calling Builder.repoInfo with repoInfo.orElse(null).final Experiment.BuilderrepoInfo(JsonField<RepoInfo> repoInfo)Sets Builder.repoInfo to an arbitrary JSON value. final Experiment.BuilderuserId(String userId)Identifies the user who created the experiment final Experiment.BuilderuserId(Optional<String> userId)Alias for calling Builder.userId with userId.orElse(null).final Experiment.BuilderuserId(JsonField<String> userId)Sets Builder.userId to an arbitrary JSON value. final Experiment.BuilderadditionalProperties(Map<String, JsonValue> additionalProperties)final Experiment.BuilderputAdditionalProperty(String key, JsonValue value)final Experiment.BuilderputAllAdditionalProperties(Map<String, JsonValue> additionalProperties)final Experiment.BuilderremoveAdditionalProperty(String key)final Experiment.BuilderremoveAllAdditionalProperties(Set<String> keys)final Experimentbuild()Returns an immutable instance of Experiment. -
-
Method Detail
-
id
final Experiment.Builder id(String id)
Unique identifier for the experiment
-
id
final Experiment.Builder id(JsonField<String> id)
Sets Builder.id to an arbitrary JSON value.
You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
name
final Experiment.Builder name(String name)
Name of the experiment. Within a project, experiment names are unique
-
name
final Experiment.Builder name(JsonField<String> name)
Sets Builder.name to an arbitrary JSON value.
You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
projectId
final Experiment.Builder projectId(String projectId)
Unique identifier for the project that the experiment belongs under
-
projectId
final Experiment.Builder projectId(JsonField<String> projectId)
Sets Builder.projectId to an arbitrary JSON value.
You should usually call Builder.projectId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
public_
final Experiment.Builder public_(Boolean public_)
Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization
-
public_
final Experiment.Builder public_(JsonField<Boolean> public_)
Sets Builder.public_ to an arbitrary JSON value.
You should usually call Builder.public_ with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
baseExpId
final Experiment.Builder baseExpId(String baseExpId)
Id of default base experiment to compare against when viewing this experiment
-
baseExpId
final Experiment.Builder baseExpId(Optional<String> baseExpId)
Alias for calling Builder.baseExpId with
baseExpId.orElse(null).
-
baseExpId
final Experiment.Builder baseExpId(JsonField<String> baseExpId)
Sets Builder.baseExpId to an arbitrary JSON value.
You should usually call Builder.baseExpId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
commit
final Experiment.Builder commit(String commit)
Commit, taken directly from
repo_info.commit
-
commit
final Experiment.Builder commit(Optional<String> commit)
Alias for calling Builder.commit with
commit.orElse(null).
-
commit
final Experiment.Builder commit(JsonField<String> commit)
Sets Builder.commit to an arbitrary JSON value.
You should usually call Builder.commit with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
created
final Experiment.Builder created(OffsetDateTime created)
Date of experiment creation
-
created
final Experiment.Builder created(Optional<OffsetDateTime> created)
Alias for calling Builder.created with
created.orElse(null).
-
created
final Experiment.Builder created(JsonField<OffsetDateTime> created)
Sets Builder.created to an arbitrary JSON value.
You should usually call Builder.created with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
datasetId
final Experiment.Builder datasetId(String datasetId)
Identifier of the linked dataset, or null if the experiment is not linked to a dataset
-
datasetId
final Experiment.Builder datasetId(Optional<String> datasetId)
Alias for calling Builder.datasetId with
datasetId.orElse(null).
-
datasetId
final Experiment.Builder datasetId(JsonField<String> datasetId)
Sets Builder.datasetId to an arbitrary JSON value.
You should usually call Builder.datasetId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
datasetVersion
final Experiment.Builder datasetVersion(String datasetVersion)
Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified.
-
datasetVersion
final Experiment.Builder datasetVersion(Optional<String> datasetVersion)
Alias for calling Builder.datasetVersion with
datasetVersion.orElse(null).
-
datasetVersion
final Experiment.Builder datasetVersion(JsonField<String> datasetVersion)
Sets Builder.datasetVersion to an arbitrary JSON value.
You should usually call Builder.datasetVersion with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
deletedAt
final Experiment.Builder deletedAt(OffsetDateTime deletedAt)
Date of experiment deletion, or null if the experiment is still active
-
deletedAt
final Experiment.Builder deletedAt(Optional<OffsetDateTime> deletedAt)
Alias for calling Builder.deletedAt with
deletedAt.orElse(null).
-
deletedAt
final Experiment.Builder deletedAt(JsonField<OffsetDateTime> deletedAt)
Sets Builder.deletedAt to an arbitrary JSON value.
You should usually call Builder.deletedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
description
final Experiment.Builder description(String description)
Textual description of the experiment
-
description
final Experiment.Builder description(Optional<String> description)
Alias for calling Builder.description with
description.orElse(null).
-
description
final Experiment.Builder description(JsonField<String> description)
Sets Builder.description to an arbitrary JSON value.
You should usually call Builder.description with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
metadata
final Experiment.Builder metadata(Experiment.Metadata metadata)
User-controlled metadata about the experiment
-
metadata
final Experiment.Builder metadata(Optional<Experiment.Metadata> metadata)
Alias for calling Builder.metadata with
metadata.orElse(null).
-
metadata
final Experiment.Builder metadata(JsonField<Experiment.Metadata> metadata)
Sets Builder.metadata to an arbitrary JSON value.
You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
repoInfo
final Experiment.Builder repoInfo(RepoInfo repoInfo)
Metadata about the state of the repo when the experiment was created
-
repoInfo
final Experiment.Builder repoInfo(Optional<RepoInfo> repoInfo)
Alias for calling Builder.repoInfo with
repoInfo.orElse(null).
-
repoInfo
final Experiment.Builder repoInfo(JsonField<RepoInfo> repoInfo)
Sets Builder.repoInfo to an arbitrary JSON value.
You should usually call Builder.repoInfo with a well-typed RepoInfo value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
userId
final Experiment.Builder userId(String userId)
Identifies the user who created the experiment
-
userId
final Experiment.Builder userId(Optional<String> userId)
Alias for calling Builder.userId with
userId.orElse(null).
-
userId
final Experiment.Builder userId(JsonField<String> userId)
Sets Builder.userId to an arbitrary JSON value.
You should usually call Builder.userId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final Experiment.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final Experiment.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final Experiment.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final Experiment.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final Experiment.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final Experiment build()
Returns an immutable instance of Experiment.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.id() .name() .projectId() .public_()
-
-
-
-