Class GetRetrieverResponse

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

  • Method Details

    • applicationId

      public final String applicationId()

      The identifier of the Amazon Q Business application using the retriever.

      Returns:
      The identifier of the Amazon Q Business application using the retriever.

    • retrieverId

      public final String retrieverId()

      The identifier of the retriever.

      Returns:
      The identifier of the retriever.

    • retrieverArn

      public final String retrieverArn()

      The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

    • type

      public final RetrieverType type()

      The type of the retriever.

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

      Returns:
      The type of the retriever.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the retriever.

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

      Returns:
      The type of the retriever.
      See Also:

    • status

      public final RetrieverStatus status()

      The status of the retriever.

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

      Returns:
      The status of the retriever.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the retriever.

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

      Returns:
      The status of the retriever.
      See Also:

    • displayName

      public final String displayName()

      The name of the retriever.

      Returns:
      The name of the retriever.

    • configuration

      public final RetrieverConfiguration configuration()
      Returns the value of the Configuration property for this object.
      Returns:
      The value of the Configuration property for this object.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

      Returns:
      The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

    • createdAt

      public final Instant createdAt()

      The Unix timestamp when the retriever was created.

      Returns:
      The Unix timestamp when the retriever was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp when the retriever was last updated.

      Returns:
      The Unix timestamp when the retriever was last updated.

    • toBuilder

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

    • builder

      public static GetRetrieverResponse.Builder builder()

    • serializableBuilderClass

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