Constructor Detail

Method Detail

• agent

   final DeploymentCreateParams.Body.Builder agent(DeploymentCreateParams.Agent agent)

  Agent to deploy. Accepts the agent ID string, which pins the latest version, or an agent object with both id and version specified. The agent must exist and not be archived.

• agent

   final DeploymentCreateParams.Body.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.Body.Builder agent(String string)

  Alias for calling agent with Agent.ofString(string).

• agent

   final DeploymentCreateParams.Body.Builder agent(BetaManagedAgentsAgentParams betaManagedAgentsAgentParams)

  Alias for calling agent with Agent.ofBetaManagedAgentsAgentParams(betaManagedAgentsAgentParams).

• environmentId

   final DeploymentCreateParams.Body.Builder environmentId(String environmentId)

  ID of the environment defining the container configuration for sessions created from this deployment.

• environmentId

   final DeploymentCreateParams.Body.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.Body.Builder initialEvents(List<BetaManagedAgentsDeploymentInitialEventParams> initialEvents)

  Events to send to each session immediately after creation. At least 1, maximum 50.

• initialEvents

   final DeploymentCreateParams.Body.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.Body.Builder addInitialEvent(BetaManagedAgentsDeploymentInitialEventParams initialEvent)

  Adds a single BetaManagedAgentsDeploymentInitialEventParams to initialEvents.

• addInitialEvent

   final DeploymentCreateParams.Body.Builder addInitialEvent(BetaManagedAgentsUserMessageEventParams userMessage)

  Alias for calling addInitialEvent with BetaManagedAgentsDeploymentInitialEventParams.ofUserMessage(userMessage).

• addInitialEvent

   final DeploymentCreateParams.Body.Builder addInitialEvent(BetaManagedAgentsUserDefineOutcomeEventParams userDefineOutcome)

  Alias for calling addInitialEvent with BetaManagedAgentsDeploymentInitialEventParams.ofUserDefineOutcome(userDefineOutcome).

• addInitialEvent

   final DeploymentCreateParams.Body.Builder addInitialEvent(BetaManagedAgentsSystemMessageEventParams systemMessage)

  Alias for calling addInitialEvent with BetaManagedAgentsDeploymentInitialEventParams.ofSystemMessage(systemMessage).

• addUserMessageInitialEvent

   final DeploymentCreateParams.Body.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.Body.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.Body.Builder name(String name)

  Human-readable name for the deployment.

• name

   final DeploymentCreateParams.Body.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.Body.Builder description(String description)

  Description of what the deployment does.

• description

   final DeploymentCreateParams.Body.Builder description(Optional<String> description)

  Alias for calling Builder.description with description.orElse(null).

• description

   final DeploymentCreateParams.Body.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.Body.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.Body.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.Body.Builder resources(List<DeploymentCreateParams.Resource> resources)

  Resources (e.g. repositories, files) to mount into each session's container. Maximum 500.

• resources

   final DeploymentCreateParams.Body.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.Body.Builder addResource(DeploymentCreateParams.Resource resource)

  Adds a single Resource to resources.

• addResource

   final DeploymentCreateParams.Body.Builder addResource(BetaManagedAgentsGitHubRepositoryResourceParams githubRepository)

  Alias for calling addResource with Resource.ofGitHubRepository(githubRepository).

• addResource

   final DeploymentCreateParams.Body.Builder addResource(BetaManagedAgentsFileResourceParams file)

  Alias for calling addResource with Resource.ofFile(file).

• addResource

   final DeploymentCreateParams.Body.Builder addResource(BetaManagedAgentsMemoryStoreResourceParam memoryStore)

  Alias for calling addResource with Resource.ofMemoryStore(memoryStore).

• addFileResource

   final DeploymentCreateParams.Body.Builder addFileResource(String fileId)

  Alias for calling addResource with the following:

  BetaManagedAgentsFileResourceParams.builder()
      .type(BetaManagedAgentsFileResourceParams.Type.FILE)
      .fileId(fileId)
      .build()

• addMemoryStoreResource

   final DeploymentCreateParams.Body.Builder addMemoryStoreResource(String memoryStoreId)

  Alias for calling addResource with the following:

  BetaManagedAgentsMemoryStoreResourceParam.builder()
      .type(BetaManagedAgentsMemoryStoreResourceParam.Type.MEMORY_STORE)
      .memoryStoreId(memoryStoreId)
      .build()

• schedule

   final DeploymentCreateParams.Body.Builder schedule(BetaManagedAgentsScheduleParams schedule)

  5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.

• schedule

   final DeploymentCreateParams.Body.Builder schedule(Optional<BetaManagedAgentsScheduleParams> schedule)

  Alias for calling Builder.schedule with schedule.orElse(null).

• schedule

   final DeploymentCreateParams.Body.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.Body.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.Body.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.Body.Builder addVaultId(String vaultId)

  Adds a single String to vaultIds.

• additionalProperties

   final DeploymentCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final DeploymentCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final DeploymentCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final DeploymentCreateParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final DeploymentCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final DeploymentCreateParams.Body build()

  Returns an immutable instance of Body.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .agent()
  .environmentId()
  .initialEvents()
  .name()