Package software.amazon.awssdk.services.bedrockagentruntime.model

Class CreateSessionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest

software.amazon.awssdk.services.bedrockagentruntime.model.CreateSessionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSessionRequest.Builder,CreateSessionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateSessionRequest
extends BedrockAgentRuntimeRequest
implements ToCopyableBuilder<CreateSessionRequest.Builder,CreateSessionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSessionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateSessionRequest.Builder	builder()
String	encryptionKeyArn()	The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSessionMetadata()	For responses, this returns true if the service returned a value for the SessionMetadata property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSessionRequest.Builder>	serializableBuilderClass()
Map<String,String>	sessionMetadata()	A map of key-value pairs containing attributes to be persisted across the session.
Map<String,String>	tags()	Specify the key-value pairs for the tags that you want to attach to the session.
CreateSessionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

encryptionKeyArn

public final String encryptionKeyArn()

The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.

Returns:

The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.

hasSessionMetadata

public final boolean hasSessionMetadata()

For responses, this returns true if the service returned a value for the SessionMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

sessionMetadata

public final Map<String,String> sessionMetadata()

A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.

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 hasSessionMetadata() method.

Returns:

A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.

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

Specify the key-value pairs for the tags that you want to attach to the session.

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:

Specify the key-value pairs for the tags that you want to attach to the session.

toBuilder

public CreateSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSessionRequest.Builder,CreateSessionRequest>

Specified by:

toBuilder in class BedrockAgentRuntimeRequest

builder

public static CreateSessionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateSessionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo