Package software.amazon.awssdk.services.qapps.model

Class StartQAppSessionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qapps.model.QAppsRequest

software.amazon.awssdk.services.qapps.model.StartQAppSessionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartQAppSessionRequest.Builder,StartQAppSessionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartQAppSessionRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	appId()	The unique identifier of the Q App to start a session for.
Integer	appVersion()	The version of the Q App to use for the session.
static StartQAppSessionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInitialValues()	For responses, this returns true if the service returned a value for the InitialValues property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<CardValue>	initialValues()	Optional initial input values to provide for the Q App session.
String	instanceId()	The unique identifier of the Amazon Q Business application environment instance.
List<SdkField<?>>	sdkFields()
static Class<? extends StartQAppSessionRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Optional tags to associate with the new Q App session.
StartQAppSessionRequest.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

instanceId

public final String instanceId()

The unique identifier of the Amazon Q Business application environment instance.

Returns:

The unique identifier of the Amazon Q Business application environment instance.

appId

public final String appId()

The unique identifier of the Q App to start a session for.

Returns:

The unique identifier of the Q App to start a session for.

appVersion

public final Integer appVersion()

The version of the Q App to use for the session.

Returns:

The version of the Q App to use for the session.

hasInitialValues

public final boolean hasInitialValues()

For responses, this returns true if the service returned a value for the InitialValues 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.

initialValues

public final List<CardValue> initialValues()

Optional initial input values to provide for the Q App 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 hasInitialValues() method.

Returns:

Optional initial input values to provide for the Q App session.

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

Optional tags to associate with the new Q App 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:

Optional tags to associate with the new Q App session.

toBuilder

public StartQAppSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartQAppSessionRequest.Builder,StartQAppSessionRequest>

Specified by:

toBuilder in class QAppsRequest

builder

public static StartQAppSessionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartQAppSessionRequest.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