Class CreateQAppResponse

    • Method Detail

      • appId

        public final String appId()

        The unique identifier of the new Q App.

        Returns:
        The unique identifier of the new Q App.
      • appArn

        public final String appArn()

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

        Returns:
        The Amazon Resource Name (ARN) of the new Q App.
      • title

        public final String title()

        The title of the new Q App.

        Returns:
        The title of the new Q App.
      • description

        public final String description()

        The description of the new Q App.

        Returns:
        The description of the new Q App.
      • initialPrompt

        public final String initialPrompt()

        The initial prompt displayed when the Q App is started.

        Returns:
        The initial prompt displayed when the Q App is started.
      • appVersion

        public final Integer appVersion()

        The version of the new Q App.

        Returns:
        The version of the new Q App.
      • status

        public final AppStatus status()

        The status of the new Q App, such as "Created".

        If the service returns an enum value that is not available in the current SDK version, status will return AppStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the new Q App, such as "Created".
        See Also:
        AppStatus
      • statusAsString

        public final String statusAsString()

        The status of the new Q App, such as "Created".

        If the service returns an enum value that is not available in the current SDK version, status will return AppStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the new Q App, such as "Created".
        See Also:
        AppStatus
      • createdAt

        public final Instant createdAt()

        The date and time the Q App was created.

        Returns:
        The date and time the Q App was created.
      • createdBy

        public final String createdBy()

        The user who created the Q App.

        Returns:
        The user who created the Q App.
      • updatedAt

        public final Instant updatedAt()

        The date and time the Q App was last updated.

        Returns:
        The date and time the Q App was last updated.
      • updatedBy

        public final String updatedBy()

        The user who last updated the Q App.

        Returns:
        The user who last updated the Q App.
      • requiredCapabilities

        public final List<AppRequiredCapability> requiredCapabilities()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiredCapabilities() method.

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

        public final boolean hasRequiredCapabilities()
        For responses, this returns true if the service returned a value for the RequiredCapabilities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • requiredCapabilitiesAsStrings

        public final List<String> requiredCapabilitiesAsStrings()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiredCapabilities() method.

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

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object