Class ViewUpdateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class ViewUpdateParams implements Params
Partially update a view 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 classViewUpdateParams.Bodypublic final classViewUpdateParams.BuilderA builder for ViewUpdateParams.
public final classViewUpdateParams.ViewTypeType of table that the view corresponds to.
-
Method Summary
Modifier and Type Method Description final StringviewId()View id final StringobjectId()The id of the object the view applies to final AclObjectTypeobjectType()The object type that the ACL applies to final Optional<String>name()Name of the view final Optional<ViewOptions>options()Options for the view in the app final Optional<String>userId()Identifies the user who created the view final Optional<ViewData>viewData()The view definition final Optional<ViewUpdateParams.ViewType>viewType()Type of table that the view corresponds to. final JsonField<String>_objectId()Returns the raw JSON value of objectId. final JsonField<AclObjectType>_objectType()Returns the raw JSON value of objectType. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<ViewOptions>_options()Returns the raw JSON value of options. final JsonField<String>_userId()Returns the raw JSON value of userId. final JsonField<ViewData>_viewData()Returns the raw JSON value of viewData. final JsonField<ViewUpdateParams.ViewType>_viewType()Returns the raw JSON value of viewType. 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 ViewUpdateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ViewUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of ViewUpdateParams. -
-
Method Detail
-
objectType
final AclObjectType objectType()
The object type that the ACL applies to
-
options
final Optional<ViewOptions> options()
Options for the view in the app
-
viewType
final Optional<ViewUpdateParams.ViewType> viewType()
Type of table that the view corresponds to.
-
_objectId
final JsonField<String> _objectId()
Returns the raw JSON value of objectId.
Unlike objectId, this method doesn't throw if the JSON field has an unexpected type.
-
_objectType
final JsonField<AclObjectType> _objectType()
Returns the raw JSON value of objectType.
Unlike objectType, 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.
-
_options
final JsonField<ViewOptions> _options()
Returns the raw JSON value of options.
Unlike options, this method doesn't throw if the JSON field has an unexpected type.
-
_userId
final JsonField<String> _userId()
Returns the raw JSON value of userId.
Unlike userId, this method doesn't throw if the JSON field has an unexpected type.
-
_viewData
final JsonField<ViewData> _viewData()
Returns the raw JSON value of viewData.
Unlike viewData, this method doesn't throw if the JSON field has an unexpected type.
-
_viewType
final JsonField<ViewUpdateParams.ViewType> _viewType()
Returns the raw JSON value of viewType.
Unlike viewType, 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 ViewUpdateParams.Builder toBuilder()
-
builder
final static ViewUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of ViewUpdateParams.
The following fields are required:
.viewId() .objectId() .objectType()
-
-
-
-