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

Class Retriever

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.Retriever

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Retriever.Builder,Retriever>

@Generated("software.amazon.awssdk:codegen")
public final class Retriever
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Retriever.Builder,Retriever>

Summary information for the retriever used for your Amazon Q Business application.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Retriever.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the Amazon Q Business application using the retriever.
static Retriever.Builder	builder()
String	displayName()	The name of your retriever.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	retrieverId()	The identifier of the retriever used by your Amazon Q Business application.
List<SdkField<?>>	sdkFields()
static Class<? extends Retriever.Builder>	serializableBuilderClass()
RetrieverStatus	status()	The status of your retriever.
String	statusAsString()	The status of your retriever.
Retriever.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RetrieverType	type()	The type of your retriever.
String	typeAsString()	The type of your retriever.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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 used by your Amazon Q Business application.

Returns:

The identifier of the retriever used by your Amazon Q Business application.

type

public final RetrieverType type()

The type of your 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 your retriever.

See Also:

RetrieverType

typeAsString

public final String typeAsString()

The type of your 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 your retriever.

See Also:

RetrieverType

status

public final RetrieverStatus status()

The status of your 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 your retriever.

See Also:

RetrieverStatus

statusAsString

public final String statusAsString()

The status of your 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 your retriever.

See Also:

RetrieverStatus

displayName

public final String displayName()

The name of your retriever.

Returns:

The name of your retriever.

toBuilder

public Retriever.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Retriever.Builder,Retriever>

builder

public static Retriever.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo