All Implemented Interfaces:

com.braintrustdata.api.core.Params
```
public final class ExperimentUpdateParams
 implements Params
                    
```
Partially update an experiment object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ExperimentUpdateParams.Builder`	A builder for ExperimentUpdateParams.
`public final class`	`ExperimentUpdateParams.Body`
`public final class`	`ExperimentUpdateParams.Metadata`	User-controlled metadata about the experiment

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`experimentId()`	Experiment id
`final Optional<String>`	`baseExpId()`	Id of default base experiment to compare against when viewing this experiment
`final Optional<String>`	`datasetId()`	Identifier of the linked dataset, or null if the experiment is not linked to a dataset
`final Optional<String>`	`datasetVersion()`	Version number of the linked dataset the experiment was run against.
`final Optional<String>`	`description()`	Textual description of the experiment
`final Optional<ExperimentUpdateParams.Metadata>`	`metadata()`	User-controlled metadata about the experiment
`final Optional<String>`	`name()`	Name of the experiment.
`final Optional<Boolean>`	`public_()`	Whether or not the experiment is public.
`final Optional<RepoInfo>`	`repoInfo()`	Metadata about the state of the repo when the experiment was created
`final JsonField<String>`	`_baseExpId()`	Returns the raw JSON value of baseExpId.
`final JsonField<String>`	`_datasetId()`	Returns the raw JSON value of datasetId.
`final JsonField<String>`	`_datasetVersion()`	Returns the raw JSON value of datasetVersion.
`final JsonField<String>`	`_description()`	Returns the raw JSON value of description.
`final JsonField<ExperimentUpdateParams.Metadata>`	`_metadata()`	Returns the raw JSON value of metadata.
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final JsonField<Boolean>`	`_public_()`	Returns the raw JSON value of public_.
`final JsonField<RepoInfo>`	`_repoInfo()`	Returns the raw JSON value of repoInfo.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final ExperimentUpdateParams.Builder`	`toBuilder()`
`final ExperimentUpdateParams.Body`	`_body()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ExperimentUpdateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ExperimentUpdateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - experimentId
```
 final String experimentId()
```
    Experiment id
  - baseExpId
```
 final Optional<String> baseExpId()
```
    Id of default base experiment to compare against when viewing this experiment
  - datasetId
```
 final Optional<String> datasetId()
```
    Identifier of the linked dataset, or null if the experiment is not linked to a dataset
  - datasetVersion
```
 final Optional<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.
  - description
```
 final Optional<String> description()
```
    Textual description of the experiment
  - metadata
```
 final Optional<ExperimentUpdateParams.Metadata> metadata()
```
    User-controlled metadata about the experiment
  - name
```
 final Optional<String> name()
```
    Name of the experiment. Within a project, experiment names are unique
  - public_
```
 final Optional<Boolean> public_()
```
    Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization
  - repoInfo
```
 final Optional<RepoInfo> repoInfo()
```
    Metadata about the state of the repo when the experiment was created
  - _baseExpId
```
 final JsonField<String> _baseExpId()
```
    Returns the raw JSON value of baseExpId.
    Unlike baseExpId, this method doesn't throw if the JSON field has an unexpected type.
  - _datasetId
```
 final JsonField<String> _datasetId()
```
    Returns the raw JSON value of datasetId.
    Unlike datasetId, this method doesn't throw if the JSON field has an unexpected type.
  - _datasetVersion
```
 final JsonField<String> _datasetVersion()
```
    Returns the raw JSON value of datasetVersion.
    Unlike datasetVersion, this method doesn't throw if the JSON field has an unexpected type.
  - _description
```
 final JsonField<String> _description()
```
    Returns the raw JSON value of description.
    Unlike description, this method doesn't throw if the JSON field has an unexpected type.
  - _metadata
```
 final JsonField<ExperimentUpdateParams.Metadata> _metadata()
```
    Returns the raw JSON value of metadata.
    Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
  - _name
```
 final JsonField<String> _name()
```
    Returns the raw JSON value of name.
    Unlike name, this method doesn't throw if the JSON field has an unexpected type.
  - _public_
```
 final JsonField<Boolean> _public_()
```
    Returns the raw JSON value of public_.
    Unlike public_, this method doesn't throw if the JSON field has an unexpected type.
  - _repoInfo
```
 final JsonField<RepoInfo> _repoInfo()
```
    Returns the raw JSON value of repoInfo.
    Unlike repoInfo, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final ExperimentUpdateParams.Builder toBuilder()
```
  - _body
```
 final ExperimentUpdateParams.Body _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ExperimentUpdateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ExperimentUpdateParams.
    The following fields are required:
    .experimentId()

Class ExperimentUpdateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

experimentId

baseExpId

datasetId

datasetVersion

description

metadata

name

public_

repoInfo

_baseExpId

_datasetId

_datasetVersion

_description

_metadata

_name

_public_

_repoInfo

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder