Class GetQAppResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.qapps.model.QAppsResponse
software.amazon.awssdk.services.qapps.model.GetQAppResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetQAppResponse.Builder,GetQAppResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetQAppResponse extends QAppsResponse implements ToCopyableBuilder<GetQAppResponse.Builder,GetQAppResponse>

  • Method Details

    • appId

      public final String appId()

      The unique identifier of the Q App.

      Returns:
      The unique identifier of the Q App.

    • appArn

      public final String appArn()

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

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

    • title

      public final String title()

      The title of the Q App.

      Returns:
      The title of the Q App.

    • description

      public final String description()

      The description of the Q App.

      Returns:
      The description of the 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 Q App.

      Returns:
      The version of the Q App.

    • status

      public final AppStatus status()

      The status of the Q App.

      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 Q App.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the Q App.

      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 Q App.
      See Also:

    • 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.

    • appDefinition

      public final AppDefinition appDefinition()

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

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

    • toBuilder

      public GetQAppResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetQAppResponse.Builder,GetQAppResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetQAppResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetQAppResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.