Class CreateAiAgentRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.qconnect.model.QConnectRequest
-
- software.amazon.awssdk.services.qconnect.model.CreateAiAgentRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateAiAgentRequest.Builder,CreateAiAgentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAiAgentRequest extends QConnectRequest implements ToCopyableBuilder<CreateAiAgentRequest.Builder,CreateAiAgentRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateAiAgentRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringassistantId()The identifier of the Amazon Q in Connect assistant.static CreateAiAgentRequest.Builderbuilder()StringclientToken()A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.AIAgentConfigurationconfiguration()The configuration of the AI Agent.Stringdescription()The description of the AI Agent.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringname()The name of the AI Agent.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateAiAgentRequest.Builder>serializableBuilderClass()Map<String,String>tags()The tags used to organize, track, or control access for this resource.CreateAiAgentRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.AIAgentTypetype()The type of the AI Agent.StringtypeAsString()The type of the AI Agent.VisibilityStatusvisibilityStatus()The visibility status of the AI Agent.StringvisibilityStatusAsString()The visibility status of the AI Agent.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
assistantId
public final String assistantId()
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- Returns:
- The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
-
clientToken
public final String clientToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- Returns:
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
-
configuration
public final AIAgentConfiguration configuration()
The configuration of the AI Agent.
- Returns:
- The configuration of the AI Agent.
-
description
public final String description()
The description of the AI Agent.
- Returns:
- The description of the AI Agent.
-
name
public final String name()
The name of the AI Agent.
- Returns:
- The name of the AI Agent.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final Map<String,String> tags()
The tags used to organize, track, or control access for this resource.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags used to organize, track, or control access for this resource.
-
type
public final AIAgentType type()
The type of the AI Agent.
If the service returns an enum value that is not available in the current SDK version,
typewill returnAIAgentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the AI Agent.
- See Also:
AIAgentType
-
typeAsString
public final String typeAsString()
The type of the AI Agent.
If the service returns an enum value that is not available in the current SDK version,
typewill returnAIAgentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the AI Agent.
- See Also:
AIAgentType
-
visibilityStatus
public final VisibilityStatus visibilityStatus()
The visibility status of the AI Agent.
If the service returns an enum value that is not available in the current SDK version,
visibilityStatuswill returnVisibilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvisibilityStatusAsString().- Returns:
- The visibility status of the AI Agent.
- See Also:
VisibilityStatus
-
visibilityStatusAsString
public final String visibilityStatusAsString()
The visibility status of the AI Agent.
If the service returns an enum value that is not available in the current SDK version,
visibilityStatuswill returnVisibilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvisibilityStatusAsString().- Returns:
- The visibility status of the AI Agent.
- See Also:
VisibilityStatus
-
toBuilder
public CreateAiAgentRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateAiAgentRequest.Builder,CreateAiAgentRequest>- Specified by:
toBuilderin classQConnectRequest
-
builder
public static CreateAiAgentRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateAiAgentRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-