Interface GetQAppResponse.Builder

  • Method Details

    • appId

      The unique identifier of the Q App.

      Parameters:
      appId - The unique identifier of the Q App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • appArn

      The Amazon Resource Name (ARN) of the Q App.

      Parameters:
      appArn - The Amazon Resource Name (ARN) of the Q App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • title

      The title of the Q App.

      Parameters:
      title - The title of the Q App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      GetQAppResponse.Builder description(String description)

      The description of the Q App.

      Parameters:
      description - The description of the Q App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • initialPrompt

      GetQAppResponse.Builder initialPrompt(String initialPrompt)

      The initial prompt displayed when the Q App is started.

      Parameters:
      initialPrompt - The initial prompt displayed when the Q App is started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • appVersion

      GetQAppResponse.Builder appVersion(Integer appVersion)

      The version of the Q App.

      Parameters:
      appVersion - The version of the Q App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status of the Q App.

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

      The status of the Q App.

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

      GetQAppResponse.Builder createdAt(Instant createdAt)

      The date and time the Q App was created.

      Parameters:
      createdAt - The date and time the Q App was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdBy

      GetQAppResponse.Builder createdBy(String createdBy)

      The user who created the Q App.

      Parameters:
      createdBy - The user who created the Q App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      GetQAppResponse.Builder updatedAt(Instant updatedAt)

      The date and time the Q App was last updated.

      Parameters:
      updatedAt - The date and time the Q App was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedBy

      GetQAppResponse.Builder updatedBy(String updatedBy)

      The user who last updated the Q App.

      Parameters:
      updatedBy - The user who last updated the Q App.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • requiredCapabilitiesWithStrings

      GetQAppResponse.Builder requiredCapabilitiesWithStrings(Collection<String> requiredCapabilities)

      The capabilities required to run the Q App, such as file upload or third-party integrations.

      Parameters:
      requiredCapabilities - The capabilities required to run the Q App, such as file upload or third-party integrations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • requiredCapabilitiesWithStrings

      GetQAppResponse.Builder requiredCapabilitiesWithStrings(String... requiredCapabilities)

      The capabilities required to run the Q App, such as file upload or third-party integrations.

      Parameters:
      requiredCapabilities - The capabilities required to run the Q App, such as file upload or third-party integrations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • requiredCapabilities

      GetQAppResponse.Builder requiredCapabilities(Collection<AppRequiredCapability> requiredCapabilities)

      The capabilities required to run the Q App, such as file upload or third-party integrations.

      Parameters:
      requiredCapabilities - The capabilities required to run the Q App, such as file upload or third-party integrations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • requiredCapabilities

      GetQAppResponse.Builder requiredCapabilities(AppRequiredCapability... requiredCapabilities)

      The capabilities required to run the Q App, such as file upload or third-party integrations.

      Parameters:
      requiredCapabilities - The capabilities required to run the Q App, such as file upload or third-party integrations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • appDefinition

      GetQAppResponse.Builder appDefinition(AppDefinition appDefinition)

      The full definition of the Q App, specifying the cards and flow.

      Parameters:
      appDefinition - The full definition of the Q App, specifying the cards and flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • appDefinition

      default GetQAppResponse.Builder appDefinition(Consumer<AppDefinition.Builder> appDefinition)

      The full definition of the Q App, specifying the cards and flow.

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

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

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