Class SelectObjectContentEventStream

Namespace

Amazon.S3.Model

Assembly

AWSSDK.S3.dll

A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either

• attaching handlers to listen events, and then call StartProcessing or
• enumerating over the events.

These options should be treaded as mutually exclusive.

public sealed class SelectObjectContentEventStream : EnumerableEventStream<IS3Event, S3EventStreamException>, ISelectObjectContentEventStream, IEnumerableEventStream<IS3Event, S3EventStreamException>, IEventStream<IS3Event, S3EventStreamException>, IDisposable, IEnumerable<IS3Event>, IEnumerable

Inheritance

object

SelectObjectContentEventStream

Implements

ISelectObjectContentEventStream

IEnumerableEventStream<IS3Event, S3EventStreamException>

IEventStream<IS3Event, S3EventStreamException>

IDisposable

IEnumerable<IS3Event>

IEnumerable

Constructors

SelectObjectContentEventStream(Stream)

Event Stream returned by SelectObjectContentStream.

Events can be retrieved from this stream by either

• attaching handlers to listen events, and then call StartProcessing or
• enumerating over the events.

These options should be treated as mutually exclusive.

public SelectObjectContentEventStream(Stream selectObjectStream)

Parameters

selectObjectStream Stream

The network stream which events will be parsed from.

SelectObjectContentEventStream(Stream, IEventStreamDecoder)

Event Stream returned by SelectObjectContentStream.

Events can be retrieved from this stream by either

• attaching handlers to listen events, and then call StartProcessing or
• enumerating over the events.

These options should be treaded as mutually exclusive.

public SelectObjectContentEventStream(Stream selectObjectStream, IEventStreamDecoder eventStreamDecoder)

Parameters

selectObjectStream Stream

The network stream which events will be parsed from.

eventStreamDecoder IEventStreamDecoder

The decoder responsible for parsing events.

Properties

EventMapping

The mapping of event message to a generator function to construct the matching Event Stream event.

protected override IDictionary<string, Func<IEventStreamMessage, IS3Event>> EventMapping { get; }

Property Value

IDictionary<string, Func<IEventStreamMessage, IS3Event>>

ExceptionMapping

The mapping of event message to a generator function to construct the matching Event Stream exception.

protected override IDictionary<string, Func<IEventStreamMessage, S3EventStreamException>> ExceptionMapping { get; }

Property Value

IDictionary<string, Func<IEventStreamMessage, S3EventStreamException>>

IsProcessing

Whether the backround processing loop is running.

protected override bool IsProcessing { get; set; }

Property Value

bool

Events

ContinuationEventReceived

Reaised when a Continuation event is received.

public event EventHandler<EventStreamEventReceivedArgs<ContinuationEvent>> ContinuationEventReceived

Event Type

EventHandler<EventStreamEventReceivedArgs<ContinuationEvent>>

EndEventReceived

Reaised when an End event is received.

public event EventHandler<EventStreamEventReceivedArgs<EndEvent>> EndEventReceived

Event Type

EventHandler<EventStreamEventReceivedArgs<EndEvent>>

EventReceived

Event that encompasses all IS3Events.

public override event EventHandler<EventStreamEventReceivedArgs<IS3Event>> EventReceived

Event Type

EventHandler<EventStreamEventReceivedArgs<IS3Event>>

ExceptionReceived

Event that encompasses S3EventStreamExceptions.

public override event EventHandler<EventStreamExceptionReceivedArgs<S3EventStreamException>> ExceptionReceived

Event Type

EventHandler<EventStreamExceptionReceivedArgs<S3EventStreamException>>

ProgressEventReceived

Reaised when a Progress event is received.

public event EventHandler<EventStreamEventReceivedArgs<ProgressEvent>> ProgressEventReceived

Event Type

EventHandler<EventStreamEventReceivedArgs<ProgressEvent>>

RecordsEventReceived

Reaised when a Records event is received.

public event EventHandler<EventStreamEventReceivedArgs<RecordsEvent>> RecordsEventReceived

Event Type

EventHandler<EventStreamEventReceivedArgs<RecordsEvent>>

StatsEventReceived

Reaised when a Stats event is received.

public event EventHandler<EventStreamEventReceivedArgs<StatsEvent>> StatsEventReceived

Event Type

EventHandler<EventStreamEventReceivedArgs<StatsEvent>>