com.amazonaws.services.cloudwatchevents.model

Class KinesisParameters

java.lang.Object

com.amazonaws.services.cloudwatchevents.model.KinesisParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KinesisParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
KinesisParameters()

Method Summary

Modifier and Type	Method and Description
KinesisParameters	clone()
boolean	equals(Object obj)
String	getPartitionKeyPath() The JSON path to be extracted from the event and used as the partition key.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setPartitionKeyPath(String partitionKeyPath) The JSON path to be extracted from the event and used as the partition key.
String	toString() Returns a string representation of this object; useful for testing and debugging.
KinesisParameters	withPartitionKeyPath(String partitionKeyPath) The JSON path to be extracted from the event and used as the partition key.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KinesisParameters

public KinesisParameters()

Method Detail

setPartitionKeyPath

public void setPartitionKeyPath(String partitionKeyPath)

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Parameters:

partitionKeyPath - The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

getPartitionKeyPath

public String getPartitionKeyPath()

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Returns:

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

withPartitionKeyPath

public KinesisParameters withPartitionKeyPath(String partitionKeyPath)

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Parameters:

partitionKeyPath - The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public KinesisParameters clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.