Class AgentSpace
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AgentSpace.Builder,AgentSpace>
Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe unique identifier of the AgentSpacestatic AgentSpace.Builderbuilder()final InstantThe timestamp when the resource was created.final StringThe description of the AgentSpace.final booleanfinal booleanequalsBySdkFields(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) final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Preferences property.final StringThe ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.final Stringlocale()The locale for the AgentSpace, which determines the language used in agent responses.final Stringname()The name of the AgentSpace.final Map<AgentSpacePreferenceKey, Boolean> The preferences configured on the agent space.The preferences configured on the agent space.static Class<? extends AgentSpace.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final InstantThe timestamp when the resource was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
-
description
The description of the AgentSpace.
- Returns:
- The description of the AgentSpace.
-
locale
The locale for the AgentSpace, which determines the language used in agent responses.
- Returns:
- The locale for the AgentSpace, which determines the language used in agent responses.
-
createdAt
The timestamp when the resource was created.
- Returns:
- The timestamp when the resource was created.
-
updatedAt
The timestamp when the resource was last updated.
- Returns:
- The timestamp when the resource was last updated.
-
kmsKeyArn
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
- Returns:
- The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
-
agentSpaceId
The unique identifier of the AgentSpace
- Returns:
- The unique identifier of the AgentSpace
-
preferences
The preferences configured on the agent space. Preferences that are not set take their default values.
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
hasPreferences()method.- Returns:
- The preferences configured on the agent space. Preferences that are not set take their default values.
-
hasPreferences
public final boolean hasPreferences()For responses, this returns true if the service returned a value for the Preferences 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. -
preferencesAsStrings
The preferences configured on the agent space. Preferences that are not set take their default values.
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
hasPreferences()method.- Returns:
- The preferences configured on the agent space. Preferences that are not set take their default values.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<AgentSpace.Builder,AgentSpace> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-