Class VaultCreateParams.Builder
-
- All Implemented Interfaces:
public final class VaultCreateParams.BuilderA builder for VaultCreateParams.
-
-
Method Summary
-
-
Method Detail
-
body
final VaultCreateParams.Builder body(VaultCreateParams.Body body)
Sets the entire request body.
This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:
-
name
final VaultCreateParams.Builder name(String name)
Display name for the vault
-
name
final VaultCreateParams.Builder name(JsonField<String> name)
Sets Builder.name to an arbitrary JSON value.
You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
description
final VaultCreateParams.Builder description(String description)
Optional description of the vault's purpose
-
description
final VaultCreateParams.Builder description(JsonField<String> description)
Sets Builder.description to an arbitrary JSON value.
You should usually call Builder.description with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
embeddingModel
final VaultCreateParams.Builder embeddingModel(VaultCreateParams.EmbeddingModel embeddingModel)
Optional embedding model for this vault. Defaults to casemark/embed-v1. Determines the S3 Vectors index dimension and which model is used at both ingest and search time. The vault is locked to this model after creation — use a re-embed flow to change later. Ignored when enableIndexing is false. Note:
casemark/llama-nemotron-embed-vl-1b-v2is a deprecated alias forcasemark/embed-v1(retained for SDK backward compatibility); new integrations should usecasemark/embed-v1directly.
-
embeddingModel
final VaultCreateParams.Builder embeddingModel(JsonField<VaultCreateParams.EmbeddingModel> embeddingModel)
Sets Builder.embeddingModel to an arbitrary JSON value.
You should usually call Builder.embeddingModel with a well-typed EmbeddingModel value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
enableGraph
final VaultCreateParams.Builder enableGraph(Boolean enableGraph)
Enable knowledge graph for entity relationship mapping. Only applies when enableIndexing is true.
-
enableGraph
final VaultCreateParams.Builder enableGraph(JsonField<Boolean> enableGraph)
Sets Builder.enableGraph to an arbitrary JSON value.
You should usually call Builder.enableGraph with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
enableIndexing
final VaultCreateParams.Builder enableIndexing(Boolean enableIndexing)
Enable vector indexing and search capabilities. Set to false for storage-only vaults.
-
enableIndexing
final VaultCreateParams.Builder enableIndexing(JsonField<Boolean> enableIndexing)
Sets Builder.enableIndexing to an arbitrary JSON value.
You should usually call Builder.enableIndexing with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
groupId
final VaultCreateParams.Builder groupId(String groupId)
Assign the vault to a vault group for access control. Required when using a group-scoped API key.
-
groupId
final VaultCreateParams.Builder groupId(JsonField<String> groupId)
Sets Builder.groupId to an arbitrary JSON value.
You should usually call Builder.groupId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
metadata
final VaultCreateParams.Builder metadata(JsonValue metadata)
Optional metadata to attach to the vault (e.g., { containsPHI: true } for HIPAA compliance tracking)
-
additionalBodyProperties
final VaultCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
putAdditionalBodyProperty
final VaultCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)
-
putAllAdditionalBodyProperties
final VaultCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
removeAdditionalBodyProperty
final VaultCreateParams.Builder removeAdditionalBodyProperty(String key)
-
removeAllAdditionalBodyProperties
final VaultCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)
-
additionalHeaders
final VaultCreateParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final VaultCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final VaultCreateParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final VaultCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final VaultCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final VaultCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final VaultCreateParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final VaultCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final VaultCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final VaultCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final VaultCreateParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final VaultCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final VaultCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final VaultCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final VaultCreateParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final VaultCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final VaultCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final VaultCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final VaultCreateParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final VaultCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final VaultCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final VaultCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final VaultCreateParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final VaultCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final VaultCreateParams build()
Returns an immutable instance of VaultCreateParams.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.name()
-
-
-
-