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

Class ImportDocumentRequest

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.ImportDocumentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ImportDocumentRequest.Builder,ImportDocumentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImportDocumentRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	appId()	The unique identifier of the Q App the file is associated with.
static ImportDocumentRequest.Builder	builder()
String	cardId()	The unique identifier of the card the file is associated with, if applicable.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileContentsBase64()	The base64-encoded contents of the file to upload.
String	fileName()	The name of the file being uploaded.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	The unique identifier of the Amazon Q Business application environment instance.
DocumentScope	scope()	Whether the file is associated with an Q App definition or a specific Q App session.
String	scopeAsString()	Whether the file is associated with an Q App definition or a specific Q App session.
List<SdkField<?>>	sdkFields()
static Class<? extends ImportDocumentRequest.Builder>	serializableBuilderClass()
String	sessionId()	The unique identifier of the Q App session the file is associated with, if applicable.
ImportDocumentRequest.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.

cardId

public final String cardId()

The unique identifier of the card the file is associated with, if applicable.

Returns:

The unique identifier of the card the file is associated with, if applicable.

appId

public final String appId()

The unique identifier of the Q App the file is associated with.

Returns:

The unique identifier of the Q App the file is associated with.

fileContentsBase64

public final String fileContentsBase64()

The base64-encoded contents of the file to upload.

Returns:

The base64-encoded contents of the file to upload.

fileName

public final String fileName()

The name of the file being uploaded.

Returns:

The name of the file being uploaded.

scope

public final DocumentScope scope()

Whether the file is associated with an Q App definition or a specific Q App session.

If the service returns an enum value that is not available in the current SDK version, scope will return DocumentScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

Whether the file is associated with an Q App definition or a specific Q App session.

See Also:

DocumentScope

scopeAsString

public final String scopeAsString()

Whether the file is associated with an Q App definition or a specific Q App session.

If the service returns an enum value that is not available in the current SDK version, scope will return DocumentScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

Whether the file is associated with an Q App definition or a specific Q App session.

See Also:

DocumentScope

sessionId

public final String sessionId()

The unique identifier of the Q App session the file is associated with, if applicable.

Returns:

The unique identifier of the Q App session the file is associated with, if applicable.

toBuilder

public ImportDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportDocumentRequest.Builder,ImportDocumentRequest>

Specified by:

toBuilder in class QAppsRequest

builder

public static ImportDocumentRequest.Builder builder()

serializableBuilderClass

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