Class SqsSourceSettings

Inheritance
Object
SqsSourceSettings
Inherited Members
Namespace: Akka.Streams.SQS
Assembly: Akka.Streams.SQS.dll
Syntax
public sealed class SqsSourceSettings

Constructors

| Improve this Doc View Source

SqsSourceSettings(TimeSpan, Int32, Int32, Int32, IReadOnlyList<AttributeName>, IReadOnlyList<MessageAttributeName>, Boolean, Nullable<TimeSpan>)

Declaration
public SqsSourceSettings(TimeSpan waitTime, int maxBufferSize, int parallelism, int maxBatchSize, IReadOnlyList<AttributeName> attributeNames, IReadOnlyList<MessageAttributeName> messageAttributeNames, bool closeOnEmptyReceive, TimeSpan? visibilityTimeout)
Parameters
Type Name Description
TimeSpan waitTime
Int32 maxBufferSize
Int32 parallelism
Int32 maxBatchSize
IReadOnlyList<AttributeName> attributeNames
IReadOnlyList<MessageAttributeName> messageAttributeNames
Boolean closeOnEmptyReceive
Nullable<TimeSpan> visibilityTimeout

Properties

| Improve this Doc View Source

AttributeNames

Declaration
public IReadOnlyList<AttributeName> AttributeNames { get; }
Property Value
Type Description
IReadOnlyList<AttributeName>
| Improve this Doc View Source

CloseOnEmptyReceive

Declaration
public bool CloseOnEmptyReceive { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Default

Declaration
public static SqsSourceSettings Default { get; }
Property Value
Type Description
SqsSourceSettings
| Improve this Doc View Source

MaxBatchSize

Declaration
public int MaxBatchSize { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MaxBufferSize

Declaration
public int MaxBufferSize { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MessageAttributeNames

Declaration
public IReadOnlyList<MessageAttributeName> MessageAttributeNames { get; }
Property Value
Type Description
IReadOnlyList<MessageAttributeName>
| Improve this Doc View Source

Parallelism

Declaration
public int Parallelism { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

VisibilityTimeout

Declaration
public TimeSpan? VisibilityTimeout { get; }
Property Value
Type Description
Nullable<TimeSpan>
| Improve this Doc View Source

WaitTime

Declaration
public TimeSpan WaitTime { get; }
Property Value
Type Description
TimeSpan

Methods

| Improve this Doc View Source

Copy(Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IReadOnlyList<AttributeName>, IReadOnlyList<MessageAttributeName>, Nullable<Boolean>, Nullable<TimeSpan>)

Declaration
public SqsSourceSettings Copy(TimeSpan? waitTime = default(TimeSpan? ), int? maxBufferSize = default(int? ), int? parallelism = default(int? ), int? maxBatchSize = default(int? ), IReadOnlyList<AttributeName> attributeNames = null, IReadOnlyList<MessageAttributeName> messageAttributeNames = null, bool? closeOnEmptyReceive = default(bool? ), TimeSpan? visibilityTimeout = default(TimeSpan? ))
Parameters
Type Name Description
Nullable<TimeSpan> waitTime
Nullable<Int32> maxBufferSize
Nullable<Int32> parallelism
Nullable<Int32> maxBatchSize
IReadOnlyList<AttributeName> attributeNames
IReadOnlyList<MessageAttributeName> messageAttributeNames
Nullable<Boolean> closeOnEmptyReceive
Nullable<TimeSpan> visibilityTimeout
Returns
Type Description
SqsSourceSettings
| Improve this Doc View Source

WithAttributes(AttributeName[])

Declaration
public SqsSourceSettings WithAttributes(params AttributeName[] attributes)
Parameters
Type Name Description
AttributeName[] attributes
Returns
Type Description
SqsSourceSettings
| Improve this Doc View Source

WithCloseOnEmptyReceive(Boolean)

If true, the source completes when no messages are available. Default: false.

Declaration
public SqsSourceSettings WithCloseOnEmptyReceive(bool enable)
Parameters
Type Name Description
Boolean enable
Returns
Type Description
SqsSourceSettings
| Improve this Doc View Source

WithMaxBatchSize(Int32)

The maximum number of messages to return (see MaxNumberOfMessages in AWS docs).

Default: 10 messages

Declaration
public SqsSourceSettings WithMaxBatchSize(int maxBatchSize)
Parameters
Type Name Description
Int32 maxBatchSize
Returns
Type Description
SqsSourceSettings
| Improve this Doc View Source

WithMaxBufferSize(Int32)

Internal buffer size used by the Source.

Default: 100 messages

Declaration
public SqsSourceSettings WithMaxBufferSize(int maxBufferSize)
Parameters
Type Name Description
Int32 maxBufferSize
Returns
Type Description
SqsSourceSettings
| Improve this Doc View Source

WithMessageAttributes(MessageAttributeName[])

Declaration
public SqsSourceSettings WithMessageAttributes(params MessageAttributeName[] attributes)
Parameters
Type Name Description
MessageAttributeName[] attributes
Returns
Type Description
SqsSourceSettings
| Improve this Doc View Source

WithVisibilityTimeout(TimeSpan)

The period of time (in seconds) during which Amazon SQS prevents other consumers from receiving and processing an already received message (see Amazon SQS doc)

Default: None - taken from the SQS queue configuration

Declaration
public SqsSourceSettings WithVisibilityTimeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout
Returns
Type Description
SqsSourceSettings
| Improve this Doc View Source

WithWaitTime(TimeSpan)

The duration in seconds for which the call waits for a message to arrive in the queue before returning. (see WaitTimeSeconds in AWS docs). Default: 20 seconds

Declaration
public SqsSourceSettings WithWaitTime(TimeSpan waitTime)
Parameters
Type Name Description
TimeSpan waitTime
Returns
Type Description
SqsSourceSettings