Class DeploymentCreateParams.Builder
-
- All Implemented Interfaces:
public final class DeploymentCreateParams.BuilderA builder for DeploymentCreateParams.
-
-
Method Summary
-
-
Method Detail
-
betas
final DeploymentCreateParams.Builder betas(List<AnthropicBeta> betas)
Optional header to specify the beta version(s) you want to use.
-
betas
final DeploymentCreateParams.Builder betas(Optional<List<AnthropicBeta>> betas)
Alias for calling Builder.betas with
betas.orElse(null).
-
addBeta
final DeploymentCreateParams.Builder addBeta(AnthropicBeta beta)
Adds a single AnthropicBeta to betas.
-
addBeta
final DeploymentCreateParams.Builder addBeta(String value)
Sets addBeta to an arbitrary String.
You should usually call addBeta with a well-typed AnthropicBeta constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
body
final DeploymentCreateParams.Builder body(DeploymentCreateParams.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:
-
agent
final DeploymentCreateParams.Builder agent(DeploymentCreateParams.Agent agent)
Agent to deploy. Accepts the
agentID string, which pins the latest version, or anagentobject with both id and version specified. The agent must exist and not be archived.
-
agent
final DeploymentCreateParams.Builder agent(JsonField<DeploymentCreateParams.Agent> agent)
Sets Builder.agent to an arbitrary JSON value.
You should usually call Builder.agent with a well-typed Agent value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
agent
final DeploymentCreateParams.Builder agent(String string)
Alias for calling agent with
Agent.ofString(string).
-
agent
final DeploymentCreateParams.Builder agent(BetaManagedAgentsAgentParams betaManagedAgentsAgentParams)
Alias for calling agent with
Agent.ofBetaManagedAgentsAgentParams(betaManagedAgentsAgentParams).
-
environmentId
final DeploymentCreateParams.Builder environmentId(String environmentId)
ID of the
environmentdefining the container configuration for sessions created from this deployment.
-
environmentId
final DeploymentCreateParams.Builder environmentId(JsonField<String> environmentId)
Sets Builder.environmentId to an arbitrary JSON value.
You should usually call Builder.environmentId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
initialEvents
final DeploymentCreateParams.Builder initialEvents(List<BetaManagedAgentsDeploymentInitialEventParams> initialEvents)
Events to send to each session immediately after creation. At least 1, maximum 50.
-
initialEvents
final DeploymentCreateParams.Builder initialEvents(JsonField<List<BetaManagedAgentsDeploymentInitialEventParams>> initialEvents)
Sets Builder.initialEvents to an arbitrary JSON value.
You should usually call Builder.initialEvents with a well-typed
List<BetaManagedAgentsDeploymentInitialEventParams>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addInitialEvent
final DeploymentCreateParams.Builder addInitialEvent(BetaManagedAgentsDeploymentInitialEventParams initialEvent)
Adds a single BetaManagedAgentsDeploymentInitialEventParams to initialEvents.
-
addInitialEvent
final DeploymentCreateParams.Builder addInitialEvent(BetaManagedAgentsUserMessageEventParams userMessage)
Alias for calling addInitialEvent with
BetaManagedAgentsDeploymentInitialEventParams.ofUserMessage(userMessage).
-
addInitialEvent
final DeploymentCreateParams.Builder addInitialEvent(BetaManagedAgentsUserDefineOutcomeEventParams userDefineOutcome)
Alias for calling addInitialEvent with
BetaManagedAgentsDeploymentInitialEventParams.ofUserDefineOutcome(userDefineOutcome).
-
addInitialEvent
final DeploymentCreateParams.Builder addInitialEvent(BetaManagedAgentsSystemMessageEventParams systemMessage)
Alias for calling addInitialEvent with
BetaManagedAgentsDeploymentInitialEventParams.ofSystemMessage(systemMessage).
-
addUserMessageInitialEvent
final DeploymentCreateParams.Builder addUserMessageInitialEvent(List<BetaManagedAgentsUserMessageEventParams.Content> content)
Alias for calling addInitialEvent with the following:
BetaManagedAgentsUserMessageEventParams.builder() .type(BetaManagedAgentsUserMessageEventParams.Type.USER_MESSAGE) .content(content) .build()
-
addSystemMessageInitialEvent
final DeploymentCreateParams.Builder addSystemMessageInitialEvent(List<BetaManagedAgentsSystemContentBlock> content)
Alias for calling addInitialEvent with the following:
BetaManagedAgentsSystemMessageEventParams.builder() .type(BetaManagedAgentsSystemMessageEventParams.Type.SYSTEM_MESSAGE) .content(content) .build()
-
name
final DeploymentCreateParams.Builder name(String name)
Human-readable name for the deployment.
-
name
final DeploymentCreateParams.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 DeploymentCreateParams.Builder description(String description)
Description of what the deployment does.
-
description
final DeploymentCreateParams.Builder description(Optional<String> description)
Alias for calling Builder.description with
description.orElse(null).
-
description
final DeploymentCreateParams.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.
-
metadata
final DeploymentCreateParams.Builder metadata(DeploymentCreateParams.Metadata metadata)
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
-
metadata
final DeploymentCreateParams.Builder metadata(JsonField<DeploymentCreateParams.Metadata> metadata)
Sets Builder.metadata to an arbitrary JSON value.
You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
resources
final DeploymentCreateParams.Builder resources(List<DeploymentCreateParams.Resource> resources)
Resources (e.g. repositories, files) to mount into each session's container. Maximum 500.
-
resources
final DeploymentCreateParams.Builder resources(JsonField<List<DeploymentCreateParams.Resource>> resources)
Sets Builder.resources to an arbitrary JSON value.
You should usually call Builder.resources with a well-typed
List<Resource>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addResource
final DeploymentCreateParams.Builder addResource(DeploymentCreateParams.Resource resource)
-
addResource
final DeploymentCreateParams.Builder addResource(BetaManagedAgentsGitHubRepositoryResourceParams githubRepository)
Alias for calling addResource with
Resource.ofGitHubRepository(githubRepository).
-
addResource
final DeploymentCreateParams.Builder addResource(BetaManagedAgentsFileResourceParams file)
Alias for calling addResource with
Resource.ofFile(file).
-
addResource
final DeploymentCreateParams.Builder addResource(BetaManagedAgentsMemoryStoreResourceParam memoryStore)
Alias for calling addResource with
Resource.ofMemoryStore(memoryStore).
-
addFileResource
final DeploymentCreateParams.Builder addFileResource(String fileId)
Alias for calling addResource with the following:
BetaManagedAgentsFileResourceParams.builder() .type(BetaManagedAgentsFileResourceParams.Type.FILE) .fileId(fileId) .build()
-
addMemoryStoreResource
final DeploymentCreateParams.Builder addMemoryStoreResource(String memoryStoreId)
Alias for calling addResource with the following:
BetaManagedAgentsMemoryStoreResourceParam.builder() .type(BetaManagedAgentsMemoryStoreResourceParam.Type.MEMORY_STORE) .memoryStoreId(memoryStoreId) .build()
-
schedule
final DeploymentCreateParams.Builder schedule(BetaManagedAgentsScheduleParams schedule)
5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
-
schedule
final DeploymentCreateParams.Builder schedule(Optional<BetaManagedAgentsScheduleParams> schedule)
Alias for calling Builder.schedule with
schedule.orElse(null).
-
schedule
final DeploymentCreateParams.Builder schedule(JsonField<BetaManagedAgentsScheduleParams> schedule)
Sets Builder.schedule to an arbitrary JSON value.
You should usually call Builder.schedule with a well-typed BetaManagedAgentsScheduleParams value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
vaultIds
final DeploymentCreateParams.Builder vaultIds(List<String> vaultIds)
Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50.
-
vaultIds
final DeploymentCreateParams.Builder vaultIds(JsonField<List<String>> vaultIds)
Sets Builder.vaultIds to an arbitrary JSON value.
You should usually call Builder.vaultIds with a well-typed
List<String>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addVaultId
final DeploymentCreateParams.Builder addVaultId(String vaultId)
-
additionalBodyProperties
final DeploymentCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
putAdditionalBodyProperty
final DeploymentCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)
-
putAllAdditionalBodyProperties
final DeploymentCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
removeAdditionalBodyProperty
final DeploymentCreateParams.Builder removeAdditionalBodyProperty(String key)
-
removeAllAdditionalBodyProperties
final DeploymentCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)
-
additionalHeaders
final DeploymentCreateParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final DeploymentCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final DeploymentCreateParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final DeploymentCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final DeploymentCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final DeploymentCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final DeploymentCreateParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final DeploymentCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final DeploymentCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final DeploymentCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final DeploymentCreateParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final DeploymentCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final DeploymentCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final DeploymentCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final DeploymentCreateParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final DeploymentCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final DeploymentCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final DeploymentCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final DeploymentCreateParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final DeploymentCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final DeploymentCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final DeploymentCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final DeploymentCreateParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final DeploymentCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final DeploymentCreateParams build()
Returns an immutable instance of DeploymentCreateParams.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.agent() .environmentId() .initialEvents() .name()
-
-
-
-