Class UserProfileUpdateParams
-
- All Implemented Interfaces:
-
com.anthropic.core.Params
public final class UserProfileUpdateParams implements Params
Update User Profile
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUserProfileUpdateParams.BuilderA builder for UserProfileUpdateParams.
public final classUserProfileUpdateParams.Bodypublic final classUserProfileUpdateParams.MetadataKey-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters.
public final classUserProfileUpdateParams.RelationshipHow the entity behind a user profile relates to the platform that owns the API key.
external: an individual end-user of the platform.resold: a company the platform resells Claude access to.internal: the platform's own usage.
-
Method Summary
Modifier and Type Method Description final Optional<String>userProfileId()final Optional<List<AnthropicBeta>>betas()Optional header to specify the beta version(s) you want to use. final Optional<String>externalId()If present, replaces the stored external_id. final Optional<UserProfileUpdateParams.Metadata>metadata()Key-value pairs to merge into the stored metadata. final Optional<String>name()If present, replaces the stored name. final Optional<UserProfileUpdateParams.Relationship>relationship()How the entity behind a user profile relates to the platform that owns the API key. final JsonField<String>_externalId()Returns the raw JSON value of externalId. final JsonField<UserProfileUpdateParams.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<UserProfileUpdateParams.Relationship>_relationship()Returns the raw JSON value of relationship. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final UserProfileUpdateParams.BuildertoBuilder()final UserProfileUpdateParams.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 UserProfileUpdateParamsnone()final static UserProfileUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of UserProfileUpdateParams. -
-
Method Detail
-
userProfileId
final Optional<String> userProfileId()
-
betas
final Optional<List<AnthropicBeta>> betas()
Optional header to specify the beta version(s) you want to use.
-
externalId
final Optional<String> externalId()
If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters.
-
metadata
final Optional<UserProfileUpdateParams.Metadata> metadata()
Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters.
-
name
final Optional<String> name()
If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters.
-
relationship
final Optional<UserProfileUpdateParams.Relationship> relationship()
How the entity behind a user profile relates to the platform that owns the API key.
external: an individual end-user of the platform.resold: a company the platform resells Claude access to.internal: the platform's own usage.
-
_externalId
final JsonField<String> _externalId()
Returns the raw JSON value of externalId.
Unlike externalId, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<UserProfileUpdateParams.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.
-
_relationship
final JsonField<UserProfileUpdateParams.Relationship> _relationship()
Returns the raw JSON value of relationship.
Unlike relationship, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final UserProfileUpdateParams.Builder toBuilder()
-
_body
final UserProfileUpdateParams.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.
-
none
final static UserProfileUpdateParams none()
-
builder
final static UserProfileUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of UserProfileUpdateParams.
-
-
-
-