Class Processor
- java.lang.Object
-
- software.amazon.awssdk.services.chimesdkmessaging.model.Processor
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Processor.Builder,Processor>
@Generated("software.amazon.awssdk:codegen") public final class Processor extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Processor.Builder,Processor>
The information about a processor in a channel flow.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceProcessor.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Processor.Builderbuilder()ProcessorConfigurationconfiguration()The information about the type of processor and its identifier.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)IntegerexecutionOrder()The sequence in which processors run.FallbackActionfallbackAction()Determines whether to continue with message processing or stop it in cases where communication with a processor fails.StringfallbackActionAsString()Determines whether to continue with message processing or stop it in cases where communication with a processor fails.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringname()The name of the channel flow.List<SdkField<?>>sdkFields()static Class<? extends Processor.Builder>serializableBuilderClass()Processor.BuildertoBuilder()StringtoString()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
-
name
public final String name()
The name of the channel flow.
- Returns:
- The name of the channel flow.
-
configuration
public final ProcessorConfiguration configuration()
The information about the type of processor and its identifier.
- Returns:
- The information about the type of processor and its identifier.
-
executionOrder
public final Integer executionOrder()
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
- Returns:
- The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
-
fallbackAction
public final FallbackAction fallbackAction()
Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of
ABORTand communication with it fails, the processor sets the message status toFAILEDand does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action ofCONTINUEand communication with the processor fails, then the message is considered processed and sent to recipients of the channel.If the service returns an enum value that is not available in the current SDK version,
fallbackActionwill returnFallbackAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfallbackActionAsString().- Returns:
- Determines whether to continue with message processing or stop it in cases where communication with a
processor fails. If a processor has a fallback action of
ABORTand communication with it fails, the processor sets the message status toFAILEDand does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action ofCONTINUEand communication with the processor fails, then the message is considered processed and sent to recipients of the channel. - See Also:
FallbackAction
-
fallbackActionAsString
public final String fallbackActionAsString()
Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of
ABORTand communication with it fails, the processor sets the message status toFAILEDand does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action ofCONTINUEand communication with the processor fails, then the message is considered processed and sent to recipients of the channel.If the service returns an enum value that is not available in the current SDK version,
fallbackActionwill returnFallbackAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfallbackActionAsString().- Returns:
- Determines whether to continue with message processing or stop it in cases where communication with a
processor fails. If a processor has a fallback action of
ABORTand communication with it fails, the processor sets the message status toFAILEDand does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action ofCONTINUEand communication with the processor fails, then the message is considered processed and sent to recipients of the channel. - See Also:
FallbackAction
-
toBuilder
public Processor.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Processor.Builder,Processor>
-
builder
public static Processor.Builder builder()
-
serializableBuilderClass
public static Class<? extends Processor.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-