Class UpdateAgentKnowledgeBaseRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateAgentKnowledgeBaseRequest.Builder,
UpdateAgentKnowledgeBaseRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
agentId()
The unique identifier of the agent associated with the knowledge base that you want to update.final String
The version of the agent associated with the knowledge base that you want to update.builder()
final String
Specifies a new description for the knowledge base associated with an agent.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 extendsSdkRequest
.final int
hashCode()
final String
The unique identifier of the knowledge base that has been associated with an agent.final KnowledgeBaseState
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.final String
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.static Class
<? extends UpdateAgentKnowledgeBaseRequest.Builder> 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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
agentId
The unique identifier of the agent associated with the knowledge base that you want to update.
- Returns:
- The unique identifier of the agent associated with the knowledge base that you want to update.
-
agentVersion
The version of the agent associated with the knowledge base that you want to update.
- Returns:
- The version of the agent associated with the knowledge base that you want to update.
-
description
Specifies a new description for the knowledge base associated with an agent.
- Returns:
- Specifies a new description for the knowledge base associated with an agent.
-
knowledgeBaseId
The unique identifier of the knowledge base that has been associated with an agent.
- Returns:
- The unique identifier of the knowledge base that has been associated with an agent.
-
knowledgeBaseState
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
If the service returns an enum value that is not available in the current SDK version,
knowledgeBaseState
will returnKnowledgeBaseState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromknowledgeBaseStateAsString()
.- Returns:
- Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
- See Also:
-
knowledgeBaseStateAsString
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
If the service returns an enum value that is not available in the current SDK version,
knowledgeBaseState
will returnKnowledgeBaseState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromknowledgeBaseStateAsString()
.- Returns:
- Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
- See Also:
-
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<UpdateAgentKnowledgeBaseRequest.Builder,
UpdateAgentKnowledgeBaseRequest> - Specified by:
toBuilder
in classBedrockAgentRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-