Class GetApplicationResponse

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

  • Method Details

    • displayName

      public final String displayName()

      The name of the Amazon Q Business application.

      Returns:
      The name of the Amazon Q Business application.

    • applicationId

      public final String applicationId()

      The identifier of the Amazon Q Business application.

      Returns:
      The identifier of the Amazon Q Business application.

    • applicationArn

      public final String applicationArn()

      The Amazon Resource Name (ARN) of the Amazon Q Business application.

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

    • identityType

      public final IdentityType identityType()

      The authentication type being used by a Amazon Q Business application.

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

      Returns:
      The authentication type being used by a Amazon Q Business application.
      See Also:

    • identityTypeAsString

      public final String identityTypeAsString()

      The authentication type being used by a Amazon Q Business application.

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

      Returns:
      The authentication type being used by a Amazon Q Business application.
      See Also:

    • iamIdentityProviderArn

      public final String iamIdentityProviderArn()

      The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

      Returns:
      The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

    • identityCenterApplicationArn

      public final String identityCenterApplicationArn()

      The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

      Returns:
      The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

      Returns:
      The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

    • status

      public final ApplicationStatus status()

      The status of the Amazon Q Business application.

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

      Returns:
      The status of the Amazon Q Business application.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the Amazon Q Business application.

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

      Returns:
      The status of the Amazon Q Business application.
      See Also:

    • description

      public final String description()

      A description for the Amazon Q Business application.

      Returns:
      A description for the Amazon Q Business application.

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

      Returns:
      The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

    • createdAt

      public final Instant createdAt()

      The Unix timestamp when the Amazon Q Business application was last updated.

      Returns:
      The Unix timestamp when the Amazon Q Business application was last updated.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp when the Amazon Q Business application was last updated.

      Returns:
      The Unix timestamp when the Amazon Q Business application was last updated.

    • error

      public final ErrorDetail error()

      If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

      Returns:
      If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

    • attachmentsConfiguration

      public final AppliedAttachmentsConfiguration attachmentsConfiguration()

      Settings for whether end users can upload files directly during chat.

      Returns:
      Settings for whether end users can upload files directly during chat.

    • qAppsConfiguration

      public final QAppsConfiguration qAppsConfiguration()

      Settings for whether end users can create and use Amazon Q Apps in the web experience.

      Returns:
      Settings for whether end users can create and use Amazon Q Apps in the web experience.

    • personalizationConfiguration

      public final PersonalizationConfiguration personalizationConfiguration()

      Configuration information about chat response personalization. For more information, see Personalizing chat responses.

      Returns:
      Configuration information about chat response personalization. For more information, see Personalizing chat responses.

    • autoSubscriptionConfiguration

      public final AutoSubscriptionConfiguration autoSubscriptionConfiguration()

      Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

      Returns:
      Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

    • hasClientIdsForOIDC

      public final boolean hasClientIdsForOIDC()
      For responses, this returns true if the service returned a value for the ClientIdsForOIDC 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.

    • clientIdsForOIDC

      public final List<String> clientIdsForOIDC()

      The OIDC client ID for a Amazon Q Business application.

      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 hasClientIdsForOIDC() method.

      Returns:
      The OIDC client ID for a Amazon Q Business application.

    • quickSightConfiguration

      public final QuickSightConfiguration quickSightConfiguration()

      The Amazon QuickSight authentication configuration for the Amazon Q Business application.

      Returns:
      The Amazon QuickSight authentication configuration for the Amazon Q Business application.

    • toBuilder

      public GetApplicationResponse.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<GetApplicationResponse.Builder,GetApplicationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetApplicationResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetApplicationResponse.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.