com.amazonaws.services.kinesisfirehose.model

Class MSKSourceConfiguration

java.lang.Object

com.amazonaws.services.kinesisfirehose.model.MSKSourceConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MSKSourceConfiguration()

Method Summary

Modifier and Type	Method and Description
MSKSourceConfiguration	clone()
boolean	equals(Object obj)
AuthenticationConfiguration	getAuthenticationConfiguration() The authentication configuration of the Amazon MSK cluster.
String	getMSKClusterARN() The ARN of the Amazon MSK cluster.
Date	getReadFromTimestamp() The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.
String	getTopicName() The topic name within the Amazon MSK cluster.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAuthenticationConfiguration(AuthenticationConfiguration authenticationConfiguration) The authentication configuration of the Amazon MSK cluster.
void	setMSKClusterARN(String mSKClusterARN) The ARN of the Amazon MSK cluster.
void	setReadFromTimestamp(Date readFromTimestamp) The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.
void	setTopicName(String topicName) The topic name within the Amazon MSK cluster.
String	toString() Returns a string representation of this object.
MSKSourceConfiguration	withAuthenticationConfiguration(AuthenticationConfiguration authenticationConfiguration) The authentication configuration of the Amazon MSK cluster.
MSKSourceConfiguration	withMSKClusterARN(String mSKClusterARN) The ARN of the Amazon MSK cluster.
MSKSourceConfiguration	withReadFromTimestamp(Date readFromTimestamp) The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.
MSKSourceConfiguration	withTopicName(String topicName) The topic name within the Amazon MSK cluster.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MSKSourceConfiguration

public MSKSourceConfiguration()

Method Detail

setMSKClusterARN

public void setMSKClusterARN(String mSKClusterARN)

The ARN of the Amazon MSK cluster.

Parameters:

mSKClusterARN - The ARN of the Amazon MSK cluster.

getMSKClusterARN

public String getMSKClusterARN()

The ARN of the Amazon MSK cluster.

Returns:

The ARN of the Amazon MSK cluster.

withMSKClusterARN

public MSKSourceConfiguration withMSKClusterARN(String mSKClusterARN)

The ARN of the Amazon MSK cluster.

Parameters:

mSKClusterARN - The ARN of the Amazon MSK cluster.

Returns:

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

setTopicName

public void setTopicName(String topicName)

The topic name within the Amazon MSK cluster.

Parameters:

topicName - The topic name within the Amazon MSK cluster.

getTopicName

public String getTopicName()

The topic name within the Amazon MSK cluster.

Returns:

The topic name within the Amazon MSK cluster.

withTopicName

public MSKSourceConfiguration withTopicName(String topicName)

The topic name within the Amazon MSK cluster.

Parameters:

topicName - The topic name within the Amazon MSK cluster.

Returns:

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

setAuthenticationConfiguration

public void setAuthenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)

The authentication configuration of the Amazon MSK cluster.

Parameters:

authenticationConfiguration - The authentication configuration of the Amazon MSK cluster.

getAuthenticationConfiguration

public AuthenticationConfiguration getAuthenticationConfiguration()

The authentication configuration of the Amazon MSK cluster.

Returns:

The authentication configuration of the Amazon MSK cluster.

withAuthenticationConfiguration

public MSKSourceConfiguration withAuthenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)

The authentication configuration of the Amazon MSK cluster.

Parameters:

authenticationConfiguration - The authentication configuration of the Amazon MSK cluster.

Returns:

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

setReadFromTimestamp

public void setReadFromTimestamp(Date readFromTimestamp)

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

Parameters:

readFromTimestamp - The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

getReadFromTimestamp

public Date getReadFromTimestamp()

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

Returns:

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

withReadFromTimestamp

public MSKSourceConfiguration withReadFromTimestamp(Date readFromTimestamp)

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

Parameters:

readFromTimestamp - The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 MSKSourceConfiguration 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.