Interface GetRetrieverResponse.Builder

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

  • Method Details

    • applicationId

      GetRetrieverResponse.Builder applicationId(String applicationId)

      The identifier of the Amazon Q Business application using the retriever.

      Parameters:
      applicationId - The identifier of the Amazon Q Business application using the retriever.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrieverId

      GetRetrieverResponse.Builder retrieverId(String retrieverId)

      The identifier of the retriever.

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

    • retrieverArn

      GetRetrieverResponse.Builder retrieverArn(String retrieverArn)

      The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

      Parameters:
      retrieverArn - The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      GetRetrieverResponse.Builder type(String type)

      The type of the retriever.

      Parameters:
      type - The type of the retriever.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      GetRetrieverResponse.Builder type(RetrieverType type)

      The type of the retriever.

      Parameters:
      type - The type of the retriever.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetRetrieverResponse.Builder status(String status)

      The status of the retriever.

      Parameters:
      status - The status of the retriever.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetRetrieverResponse.Builder status(RetrieverStatus status)

      The status of the retriever.

      Parameters:
      status - The status of the retriever.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • displayName

      GetRetrieverResponse.Builder displayName(String displayName)

      The name of the retriever.

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

    • configuration

      GetRetrieverResponse.Builder configuration(RetrieverConfiguration configuration)
      Sets the value of the Configuration property for this object.
      Parameters:
      configuration - The new value for the Configuration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default GetRetrieverResponse.Builder configuration(Consumer<RetrieverConfiguration.Builder> configuration)
      Sets the value of the Configuration property for this object. This is a convenience method that creates an instance of the RetrieverConfiguration.Builder avoiding the need to create one manually via RetrieverConfiguration.builder().

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

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

    • roleArn

      GetRetrieverResponse.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      GetRetrieverResponse.Builder createdAt(Instant createdAt)

      The Unix timestamp when the retriever was created.

      Parameters:
      createdAt - The Unix timestamp when the retriever was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetRetrieverResponse.Builder updatedAt(Instant updatedAt)

      The Unix timestamp when the retriever was last updated.

      Parameters:
      updatedAt - The Unix timestamp when the retriever was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.