Package software.amazon.awssdk.services.qbusiness.model

Class GetIndexResponse

    • Method Detail

      • applicationId

        public final String applicationId()

        The identifier of the Amazon Q Business application associated with the index.

        Returns:
        The identifier of the Amazon Q Business application associated with the index.

      • indexId

        public final String indexId()

        The identifier of the Amazon Q Business index.

        Returns:
        The identifier of the Amazon Q Business index.

      • displayName

        public final String displayName()

        The name of the Amazon Q Business index.

        Returns:
        The name of the Amazon Q Business index.

      • type

        public final IndexType type()

        The type of index attached to your Amazon Q Business application.

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

        Returns:
        The type of index attached to your Amazon Q Business application.
        See Also:
        IndexType

      • typeAsString

        public final String typeAsString()

        The type of index attached to your Amazon Q Business application.

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

        Returns:
        The type of index attached to your Amazon Q Business application.
        See Also:
        IndexType

      • indexArn

        public final String indexArn()

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

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

      • status

        public final IndexStatus status()

        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

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

        Returns:
        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
        See Also:
        IndexStatus

      • statusAsString

        public final String statusAsString()

        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

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

        Returns:
        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
        See Also:
        IndexStatus

      • description

        public final String description()

        The description for the Amazon Q Business index.

        Returns:
        The description for the Amazon Q Business index.

      • createdAt

        public final Instant createdAt()

        The Unix timestamp when the Amazon Q Business index was created.

        Returns:
        The Unix timestamp when the Amazon Q Business index was created.

      • updatedAt

        public final Instant updatedAt()

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

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

      • capacityConfiguration

        public final IndexCapacityConfiguration capacityConfiguration()

        The storage capacity units chosen for your Amazon Q Business index.

        Returns:
        The storage capacity units chosen for your Amazon Q Business index.

      • hasDocumentAttributeConfigurations

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

      • documentAttributeConfigurations

        public final List<DocumentAttributeConfiguration> documentAttributeConfigurations()

        Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

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

        Returns:
        Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

      • error

        public final ErrorDetail error()

        When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

        Returns:
        When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

      • indexStatistics

        public final IndexStatistics indexStatistics()

        Provides information about the number of documents indexed.

        Returns:
        Provides information about the number of documents indexed.

      • 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