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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetRetrieverResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the Amazon Q Business application using the retriever.
static GetRetrieverResponse.Builder	builder()
RetrieverConfiguration	configuration()	Returns the value of the Configuration property for this object.
Instant	createdAt()	The Unix timestamp when the retriever was created.
String	displayName()	The name of the retriever.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	retrieverArn()	The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
String	retrieverId()	The identifier of the retriever.
String	roleArn()	The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
List<SdkField<?>>	sdkFields()
static Class<? extends GetRetrieverResponse.Builder>	serializableBuilderClass()
RetrieverStatus	status()	The status of the retriever.
String	statusAsString()	The status of the retriever.
GetRetrieverResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RetrieverType	type()	The type of the retriever.
String	typeAsString()	The type of the retriever.
Instant	updatedAt()	The Unix timestamp when the retriever was last updated.

Methods inherited from class software.amazon.awssdk.services.qbusiness.model.QBusinessResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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.

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:

RetrieverType

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:

RetrieverType

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:

RetrieverStatus

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:

RetrieverStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetRetrieverResponse.Builder,GetRetrieverResponse>

Specified by:

toBuilder in class AwsResponse

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)

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo