Class GetRetrieverResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetRetrieverResponse.Builder,
GetRetrieverResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The identifier of the Amazon Q Business application using the retriever.static GetRetrieverResponse.Builder
builder()
final RetrieverConfiguration
Returns the value of the Configuration property for this object.final Instant
The Unix timestamp when the retriever was created.final String
The name of the retriever.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the IAM role associated with the retriever.final String
The identifier of the retriever.final String
roleArn()
The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.static Class
<? extends GetRetrieverResponse.Builder> final RetrieverStatus
status()
The status of the retriever.final String
The status of the retriever.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final RetrieverType
type()
The type of the retriever.final String
The type of the retriever.final Instant
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The identifier of the retriever.
- Returns:
- The identifier of the retriever.
-
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
The type of the retriever.
If the service returns an enum value that is not available in the current SDK version,
type
will returnRetrieverType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the retriever.
- See Also:
-
typeAsString
The type of the retriever.
If the service returns an enum value that is not available in the current SDK version,
type
will returnRetrieverType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the retriever.
- See Also:
-
status
The status of the retriever.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRetrieverStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the retriever.
- See Also:
-
statusAsString
The status of the retriever.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRetrieverStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the retriever.
- See Also:
-
displayName
The name of the retriever.
- Returns:
- The name of the retriever.
-
configuration
Returns the value of the Configuration property for this object.- Returns:
- The value of the Configuration property for this object.
-
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
The Unix timestamp when the retriever was created.
- Returns:
- The Unix timestamp when the retriever was created.
-
updatedAt
The Unix timestamp when the retriever was last updated.
- Returns:
- The Unix timestamp when the retriever was last updated.
-
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 interfaceToCopyableBuilder<GetRetrieverResponse.Builder,
GetRetrieverResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-