Class GetIndexResponse

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.GetIndexResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetIndexResponse.Builder,GetIndexResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetIndexResponse extends QBusinessResponse implements ToCopyableBuilder<GetIndexResponse.Builder,GetIndexResponse>

  • Method Details

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

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

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

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

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

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

    • toBuilder

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

    • builder

      public static GetIndexResponse.Builder builder()

    • serializableBuilderClass

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