Class ProjectScoreUpdateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class ProjectScoreUpdateParams implements Params
Partially update a project_score 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 classProjectScoreUpdateParams.BuilderA builder for ProjectScoreUpdateParams.
public final classProjectScoreUpdateParams.BodyA project score is a user-configured score, which can be manually-labeled through the UI
public final classProjectScoreUpdateParams.CategoriesFor categorical-type project scores, the list of all categories
-
Method Summary
Modifier and Type Method Description final StringprojectScoreId()ProjectScore id final Optional<ProjectScoreUpdateParams.Categories>categories()For categorical-type project scores, the list of all categories final Optional<ProjectScoreConfig>config()final Optional<String>description()Textual description of the project score final Optional<String>name()Name of the project score final Optional<ProjectScoreType>scoreType()The type of the configured score final JsonField<ProjectScoreUpdateParams.Categories>_categories()Returns the raw JSON value of categories. final JsonField<ProjectScoreConfig>_config()Returns the raw JSON value of config. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<ProjectScoreType>_scoreType()Returns the raw JSON value of scoreType. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final ProjectScoreUpdateParams.BuildertoBuilder()final ProjectScoreUpdateParams.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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ProjectScoreUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of ProjectScoreUpdateParams. -
-
Method Detail
-
projectScoreId
final String projectScoreId()
ProjectScore id
-
categories
final Optional<ProjectScoreUpdateParams.Categories> categories()
For categorical-type project scores, the list of all categories
-
config
final Optional<ProjectScoreConfig> config()
-
description
final Optional<String> description()
Textual description of the project score
-
scoreType
final Optional<ProjectScoreType> scoreType()
The type of the configured score
-
_categories
final JsonField<ProjectScoreUpdateParams.Categories> _categories()
Returns the raw JSON value of categories.
Unlike categories, this method doesn't throw if the JSON field has an unexpected type.
-
_config
final JsonField<ProjectScoreConfig> _config()
Returns the raw JSON value of config.
Unlike config, 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.
-
_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.
-
_scoreType
final JsonField<ProjectScoreType> _scoreType()
Returns the raw JSON value of scoreType.
Unlike scoreType, 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 ProjectScoreUpdateParams.Builder toBuilder()
-
_body
final ProjectScoreUpdateParams.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.
-
builder
final static ProjectScoreUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of ProjectScoreUpdateParams.
The following fields are required:
.projectScoreId()
-
-
-
-