Package software.amazon.awssdk.services.mailmanager.model

Class DeliverToQBusinessAction

java.lang.Object

software.amazon.awssdk.services.mailmanager.model.DeliverToQBusinessAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DeliverToQBusinessAction.Builder,DeliverToQBusinessAction>

@Generated("software.amazon.awssdk:codegen")
public final class DeliverToQBusinessAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeliverToQBusinessAction.Builder,DeliverToQBusinessAction>

The action to deliver incoming emails to an Amazon Q Business application for indexing.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeliverToQBusinessAction.Builder

Method Summary

Modifier and Type	Method	Description
ActionFailurePolicy	actionFailurePolicy()	A policy that states what to do in the case of failure.
String	actionFailurePolicyAsString()	A policy that states what to do in the case of failure.
String	applicationId()	The unique identifier of the Amazon Q Business application instance where the email content will be delivered.
static DeliverToQBusinessAction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexId()	The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.
String	roleArn()	The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DeliverToQBusinessAction.Builder>	serializableBuilderClass()
DeliverToQBusinessAction.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

actionFailurePolicy

public final ActionFailurePolicy actionFailurePolicy()

A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.

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

Returns:

A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.

See Also:

ActionFailurePolicy

actionFailurePolicyAsString

public final String actionFailurePolicyAsString()

A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.

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

Returns:

A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.

See Also:

ActionFailurePolicy

applicationId

public final String applicationId()

The unique identifier of the Amazon Q Business application instance where the email content will be delivered.

Returns:

The unique identifier of the Amazon Q Business application instance where the email content will be delivered.

indexId

public final String indexId()

The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.

Returns:

The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.

Returns:

The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.

toBuilder

public DeliverToQBusinessAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeliverToQBusinessAction.Builder,DeliverToQBusinessAction>

builder

public static DeliverToQBusinessAction.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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