Interface GetRetrievalInstructionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, BedrockAgentResponse.Builder, Buildable, CopyableBuilder<GetRetrievalInstructionResponse.Builder,GetRetrievalInstructionResponse>, SdkBuilder<GetRetrievalInstructionResponse.Builder,GetRetrievalInstructionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetRetrievalInstructionResponse
@Mutable @NotThreadSafe public static interface GetRetrievalInstructionResponse.Builder extends BedrockAgentResponse.Builder, SdkPojo, CopyableBuilder<GetRetrievalInstructionResponse.Builder,GetRetrievalInstructionResponse>

  • Method Details

    • retrievalInstructionId

      GetRetrievalInstructionResponse.Builder retrievalInstructionId(String retrievalInstructionId)

      The identifier of the retrieval instruction.

      Parameters:
      retrievalInstructionId - The identifier of the retrieval instruction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrievalInstructionArn

      GetRetrievalInstructionResponse.Builder retrievalInstructionArn(String retrievalInstructionArn)

      The ARN of the retrieval instruction.

      Parameters:
      retrievalInstructionArn - The ARN of the retrieval instruction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetRetrievalInstructionResponse.Builder name(String name)

      The name of the retrieval instruction.

      Parameters:
      name - The name of the retrieval instruction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetRetrievalInstructionResponse.Builder status(String status)

      Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.

      Parameters:
      status - Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetRetrievalInstructionResponse.Builder status(RetrievalInstructionStatus status)

      Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.

      Parameters:
      status - Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastTransitionStatus

      GetRetrievalInstructionResponse.Builder lastTransitionStatus(String lastTransitionStatus)

      The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.

      Parameters:
      lastTransitionStatus - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastTransitionStatus

      GetRetrievalInstructionResponse.Builder lastTransitionStatus(RetrievalInstructionLastTransitionStatus lastTransitionStatus)

      The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.

      Parameters:
      lastTransitionStatus - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instruction

      GetRetrievalInstructionResponse.Builder instruction(RetrievalInstructionContent instruction)

      The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.

      Parameters:
      instruction - The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instruction

      default GetRetrievalInstructionResponse.Builder instruction(Consumer<RetrievalInstructionContent.Builder> instruction)

      The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.

      This is a convenience method that creates an instance of the RetrievalInstructionContent.Builder avoiding the need to create one manually via RetrievalInstructionContent.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instruction(RetrievalInstructionContent).

      Parameters:
      instruction - a consumer that will call methods on RetrievalInstructionContent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      GetRetrievalInstructionResponse.Builder createdAt(Instant createdAt)

      When the retrieval instruction was created. On a numbered version, when that version was created.

      Parameters:
      createdAt - When the retrieval instruction was created. On a numbered version, when that version was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetRetrievalInstructionResponse.Builder updatedAt(Instant updatedAt)

      When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.

      Parameters:
      updatedAt - When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      GetRetrievalInstructionResponse.Builder description(String description)

      A description of the retrieval instruction. On a numbered version, the description of that version.

      Parameters:
      description - A description of the retrieval instruction. On a numbered version, the description of that version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerEncryptionKeyArn

      GetRetrievalInstructionResponse.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

      The ARN of the customer managed KMS key protecting this content, when one was supplied at create.

      Parameters:
      customerEncryptionKeyArn - The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastTransitionStatusReasons

      GetRetrievalInstructionResponse.Builder lastTransitionStatusReasons(Collection<RetrievalInstructionFailureReason> lastTransitionStatusReasons)

      Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.

      Parameters:
      lastTransitionStatusReasons - Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastTransitionStatusReasons

      GetRetrievalInstructionResponse.Builder lastTransitionStatusReasons(RetrievalInstructionFailureReason... lastTransitionStatusReasons)

      Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.

      Parameters:
      lastTransitionStatusReasons - Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastTransitionStatusReasons

      GetRetrievalInstructionResponse.Builder lastTransitionStatusReasons(Consumer<RetrievalInstructionFailureReason.Builder>... lastTransitionStatusReasons)

      Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.

      This is a convenience method that creates an instance of the RetrievalInstructionFailureReason.Builder avoiding the need to create one manually via RetrievalInstructionFailureReason.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastTransitionStatusReasons(List<RetrievalInstructionFailureReason>).

      Parameters:
      lastTransitionStatusReasons - a consumer that will call methods on RetrievalInstructionFailureReason.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • version

      GetRetrievalInstructionResponse.Builder version(String version)

      The version this response describes: a version number, or DRAFT.

      Parameters:
      version - The version this response describes: a version number, or DRAFT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • latestVersion

      GetRetrievalInstructionResponse.Builder latestVersion(String latestVersion)

      The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.

      Parameters:
      latestVersion - The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.