Class DatasetUpdateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class DatasetUpdateParams implements Params
Partially update a dataset 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 classDatasetUpdateParams.Bodypublic final classDatasetUpdateParams.BuilderA builder for DatasetUpdateParams.
public final classDatasetUpdateParams.MetadataUser-controlled metadata about the dataset
-
Method Summary
Modifier and Type Method Description final StringdatasetId()Dataset id final Optional<String>description()Textual description of the dataset final Optional<DatasetUpdateParams.Metadata>metadata()User-controlled metadata about the dataset final Optional<String>name()Name of the dataset. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<DatasetUpdateParams.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<String>_name()Returns the raw JSON value of name. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()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. final StringgetPathParam(Integer index)final DatasetUpdateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static DatasetUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of DatasetUpdateParams. -
-
Method Detail
-
description
final Optional<String> description()
Textual description of the dataset
-
metadata
final Optional<DatasetUpdateParams.Metadata> metadata()
User-controlled metadata about the dataset
-
_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<DatasetUpdateParams.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.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_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.
-
getPathParam
final String getPathParam(Integer index)
-
toBuilder
final DatasetUpdateParams.Builder toBuilder()
-
builder
final static DatasetUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of DatasetUpdateParams.
The following fields are required:
.datasetId()
-
-
-
-