io.jenkins.plugins.aws.kinesisconsumer

Class KinesisStreamItem

java.lang.Object

io.jenkins.plugins.aws.kinesisconsumer.KinesisStreamItem

All Implemented Interfaces:

Describable<KinesisStreamItem>

public class KinesisStreamItem
extends Object
implements Describable<KinesisStreamItem>

Class representing a Stream configuration

Author:

Fabio Ponciroli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KinesisStreamItem.DescriptorImpl

Constructor Summary

Constructors

Constructor and Description
KinesisStreamItem(String streamName, String initialPositionInStream) Creates KinesisStreamItem instance.

Method Summary

Modifier and Type	Method and Description
Descriptor<KinesisStreamItem>	getDescriptor() Get a Descriptor of KinesisStreamItem instance
String	getInitialPositionInStream() Get the initial position in the Kinesis stream Valid values are: LATEST or TRIM_HORIZON.
String	getStreamName() Get the stream name
void	setInitialPositionInStream(String initialPositionInStream) Set the initial position in the Kinesis stream
void	setStreamName(String streamName) Set the stream name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KinesisStreamItem

@DataBoundConstructor
public KinesisStreamItem(String streamName,
                                               String initialPositionInStream)

Creates KinesisStreamItem instance.

Parameters:

streamName - the queue name.

Method Detail

getStreamName

public String getStreamName()

Get the stream name

Returns:

the stream name

setStreamName

public void setStreamName(String streamName)

Set the stream name

Parameters:

streamName - stream name

getInitialPositionInStream

public String getInitialPositionInStream()

Get the initial position in the Kinesis stream Valid values are: LATEST or TRIM_HORIZON. Not all the positions have been implemented for the time being.

Returns:

the initial position in the Kinesis stream

See Also:

Kinesis Staring Positions

setInitialPositionInStream

public void setInitialPositionInStream(String initialPositionInStream)

Set the initial position in the Kinesis stream

Parameters:

initialPositionInStream - initial position in the Kinesis stream

getDescriptor

@NonNull
public Descriptor<KinesisStreamItem> getDescriptor()

Get a Descriptor of KinesisStreamItem instance

Specified by:

getDescriptor in interface Describable<KinesisStreamItem>

Returns:

a Descriptor of KinesisStreamItem instance