Package com.mapr.kafka.eventstreams.impl.admin

Class MStreamDescriptor

java.lang.Object

com.mapr.kafka.eventstreams.impl.admin.MStreamDescriptor

All Implemented Interfaces:

StreamDescriptor, java.lang.Cloneable

public class MStreamDescriptor
extends java.lang.Object
implements StreamDescriptor

Constructor Summary

Constructors

Constructor	Description
MStreamDescriptor()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAdminPerms()
boolean	getAutoCreateTopics()
boolean	getClientCompression()
boolean	getCompact()	Gets log compaction on a stream.
long	getCompactionThrottleFactor()
java.lang.String	getCompressionAlgo()
java.lang.String	getConsumePerms()
java.lang.String	getCopyPerms()
int	getDefaultPartitions()
TimestampType	getDefaultTimestampType()
long	getDeleteRetentionMS()	Applies only if log compaction is enabled on the stream.
boolean	getForce()
boolean	getIsChangelog()
long	getMinCompactionLagMS()	Applies only if log compaction is enabled on the stream.
java.lang.String	getProducePerms()
long	getProducerIdExpirySecs()
long	getTimeToLiveSec()
java.lang.String	getTopicPerms()
boolean	hasAdminPerms()
boolean	hasAutoCreateTopics()
boolean	hasClientCompression()
boolean	hasCompact()
boolean	hasCompactionThrottleFactor()
boolean	hasCompressionAlgo()
boolean	hasConsumePerms()
boolean	hasCopyPerms()
boolean	hasDefaultPartitions()
boolean	hasDeleteRetentionMS()
boolean	hasIsChangelog()
boolean	hasMinCompactionLagMS()
boolean	hasProducePerms()
boolean	hasProducerIdExpirySecs()
boolean	hasTimestampType()
boolean	hasTimeToLiveSec()
boolean	hasTopicPerms()
boolean	isKafkaTopic()
void	setAdminPerms(java.lang.String perms)	Sets the admin permission ace.
void	setAutoCreateTopics(boolean allow)	Sets if topics should be auto-created when a message is produced.
void	setClientCompression(boolean val)
void	setCompact(boolean logCompaction)	Sets the log compaction on stream.
void	setCompactionThrottleFactor(long tf)
void	setCompressionAlgo(java.lang.String algo)	Sets the compression algo.
void	setConsumePerms(java.lang.String perms)	Sets the consume permission ace.
void	setCopyPerms(java.lang.String perms)	Sets the copy permission ace.
void	setDefaultPartitions(int numFeeds)	Sets the default number of partitions per topic.
void	setDefaultTimestampType(TimestampType timestampType)	Sets timestamp type
void	setDeleteRetentionMS(long ts)	Set the time in millisecond for which delete records are retained.
void	setForce()
void	setIsChangelog(boolean ischglog)	Sets the type of the stream to be Changelog.
void	setKafkaTopic(boolean kafkaTopic)	Sets if the stream is a kafka topic stream.
void	setMinCompactionLagMS(long ts)	Set time in millisecond a message should remain uncompacted in the topic-partition.Applies only if log compaction is enabled on the stream.
void	setProducePerms(java.lang.String perms)	Sets the producer permission ace.
void	setProducerIdExpirySecs(long producerIdExpirySecs)	Sets the producer id expiry
void	setTimeToLiveSec(long sec)	Sets the time-to-live for messages.
void	setTopicPerms(java.lang.String perms)	Sets the topic permission ace.

Methods inherited from class java.lang.Object

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

Constructor Detail

MStreamDescriptor

public MStreamDescriptor()

Method Detail

hasDefaultPartitions

public boolean hasDefaultPartitions()

getDefaultPartitions

public int getDefaultPartitions()

Specified by:

getDefaultPartitions in interface StreamDescriptor

Returns:

the default number of partitions per topic.

setDefaultPartitions

public void setDefaultPartitions(int numFeeds)

Description copied from interface: StreamDescriptor

Sets the default number of partitions per topic.

Specified by:

setDefaultPartitions in interface StreamDescriptor

Parameters:

numFeeds - the number of partitions

hasTimeToLiveSec

public boolean hasTimeToLiveSec()

getTimeToLiveSec

public long getTimeToLiveSec()

Specified by:

getTimeToLiveSec in interface StreamDescriptor

Returns:

time-to-live for messages in seconds.

setTimeToLiveSec

public void setTimeToLiveSec(long sec)

Description copied from interface: StreamDescriptor

Sets the time-to-live for messages.

Specified by:

setTimeToLiveSec in interface StreamDescriptor

Parameters:

sec - the time to live

hasCompressionAlgo

public boolean hasCompressionAlgo()

getCompressionAlgo

public java.lang.String getCompressionAlgo()

Specified by:

getCompressionAlgo in interface StreamDescriptor

Returns:

the compression algo.

setCompressionAlgo

public void setCompressionAlgo(java.lang.String algo)

Description copied from interface: StreamDescriptor

Sets the compression algo.

Specified by:

setCompressionAlgo in interface StreamDescriptor

Parameters:

algo - the compression algorithm name.

hasClientCompression

public boolean hasClientCompression()

getClientCompression

public boolean getClientCompression()

setClientCompression

public void setClientCompression(boolean val)

hasAutoCreateTopics

public boolean hasAutoCreateTopics()

getAutoCreateTopics

public boolean getAutoCreateTopics()

Specified by:

getAutoCreateTopics in interface StreamDescriptor

Returns:

true if topics should be auto-created when a message is produced.

setAutoCreateTopics

public void setAutoCreateTopics(boolean allow)

Description copied from interface: StreamDescriptor

Sets if topics should be auto-created when a message is produced.

Specified by:

setAutoCreateTopics in interface StreamDescriptor

Parameters:

allow - true if topics should be auto-created.

hasProducePerms

public boolean hasProducePerms()

getProducePerms

public java.lang.String getProducePerms()

Specified by:

getProducePerms in interface StreamDescriptor

Returns:

the producer permission ace.

setProducePerms

public void setProducePerms(java.lang.String perms)

Description copied from interface: StreamDescriptor

Sets the producer permission ace.

Specified by:

setProducePerms in interface StreamDescriptor

Parameters:

perms - the producer permission ace.

hasConsumePerms

public boolean hasConsumePerms()

getConsumePerms

public java.lang.String getConsumePerms()

Specified by:

getConsumePerms in interface StreamDescriptor

Returns:

the consume permission ace.

setConsumePerms

public void setConsumePerms(java.lang.String perms)

Description copied from interface: StreamDescriptor

Sets the consume permission ace.

Specified by:

setConsumePerms in interface StreamDescriptor

Parameters:

perms - the consume permission ace.

hasTopicPerms

public boolean hasTopicPerms()

getTopicPerms

public java.lang.String getTopicPerms()

Specified by:

getTopicPerms in interface StreamDescriptor

Returns:

the topic permission ace.

setTopicPerms

public void setTopicPerms(java.lang.String perms)

Description copied from interface: StreamDescriptor

Sets the topic permission ace.

Specified by:

setTopicPerms in interface StreamDescriptor

Parameters:

perms - the topic permission ace.

hasCopyPerms

public boolean hasCopyPerms()

getCopyPerms

public java.lang.String getCopyPerms()

Specified by:

getCopyPerms in interface StreamDescriptor

Returns:

the copy permission ace.

setCopyPerms

public void setCopyPerms(java.lang.String perms)

Description copied from interface: StreamDescriptor

Sets the copy permission ace.

Specified by:

setCopyPerms in interface StreamDescriptor

Parameters:

perms - the copy permission ace.

hasAdminPerms

public boolean hasAdminPerms()

getAdminPerms

public java.lang.String getAdminPerms()

Specified by:

getAdminPerms in interface StreamDescriptor

Returns:

the admin permission ace.

setAdminPerms

public void setAdminPerms(java.lang.String perms)

Description copied from interface: StreamDescriptor

Sets the admin permission ace.

Specified by:

setAdminPerms in interface StreamDescriptor

Parameters:

perms - the admin permission ace.

hasIsChangelog

public boolean hasIsChangelog()

setIsChangelog

public void setIsChangelog(boolean ischglog)

Description copied from interface: StreamDescriptor

Sets the type of the stream to be Changelog.

Specified by:

setIsChangelog in interface StreamDescriptor

getIsChangelog

public boolean getIsChangelog()

Specified by:

getIsChangelog in interface StreamDescriptor

Returns:

true if this stream is changelog type.

hasTimestampType

public boolean hasTimestampType()

setDefaultTimestampType

public void setDefaultTimestampType(TimestampType timestampType)

Description copied from interface: StreamDescriptor

Sets timestamp type

Specified by:

setDefaultTimestampType in interface StreamDescriptor

Parameters:

timestampType - can be CREATE_TIME or LOG_APPEND_TIME

getDefaultTimestampType

public TimestampType getDefaultTimestampType()

Specified by:

getDefaultTimestampType in interface StreamDescriptor

Returns:

timestampType

hasCompact

public boolean hasCompact()

setCompact

public void setCompact(boolean logCompaction)

Description copied from interface: StreamDescriptor

Sets the log compaction on stream.

Specified by:

setCompact in interface StreamDescriptor

getCompact

public boolean getCompact()

Description copied from interface: StreamDescriptor

Gets log compaction on a stream.

Specified by:

getCompact in interface StreamDescriptor

Returns:

true if stream has log compaction set.

setForce

public void setForce()

Specified by:

setForce in interface StreamDescriptor

getForce

public boolean getForce()

Specified by:

getForce in interface StreamDescriptor

hasMinCompactionLagMS

public boolean hasMinCompactionLagMS()

getMinCompactionLagMS

public long getMinCompactionLagMS()

Description copied from interface: StreamDescriptor

Applies only if log compaction is enabled on the stream.

Specified by:

getMinCompactionLagMS in interface StreamDescriptor

Returns:

The minimum time in millisecond a message will remain uncompacted in the topic-partition.

setMinCompactionLagMS

public void setMinCompactionLagMS(long ts)

Description copied from interface: StreamDescriptor

Set time in millisecond a message should remain uncompacted in the topic-partition.Applies only if log compaction is enabled on the stream.

Specified by:

setMinCompactionLagMS in interface StreamDescriptor

Parameters:

ts - time in milliseconds

hasCompactionThrottleFactor

public boolean hasCompactionThrottleFactor()

getCompactionThrottleFactor

public long getCompactionThrottleFactor()

Specified by:

getCompactionThrottleFactor in interface StreamDescriptor

setCompactionThrottleFactor

public void setCompactionThrottleFactor(long tf)

Specified by:

setCompactionThrottleFactor in interface StreamDescriptor

hasDeleteRetentionMS

public boolean hasDeleteRetentionMS()

getDeleteRetentionMS

public long getDeleteRetentionMS()

Description copied from interface: StreamDescriptor

Applies only if log compaction is enabled on the stream.

Specified by:

getDeleteRetentionMS in interface StreamDescriptor

Returns:

The time in millisecond for which delete records are retained.

setDeleteRetentionMS

public void setDeleteRetentionMS(long ts)

Description copied from interface: StreamDescriptor

Set the time in millisecond for which delete records are retained. Applies only if log compaction is enabled on the stream.

Specified by:

setDeleteRetentionMS in interface StreamDescriptor

Parameters:

ts - time in milliseconds

hasProducerIdExpirySecs

public boolean hasProducerIdExpirySecs()

setProducerIdExpirySecs

public void setProducerIdExpirySecs(long producerIdExpirySecs)

Description copied from interface: StreamDescriptor

Sets the producer id expiry

Specified by:

setProducerIdExpirySecs in interface StreamDescriptor

Parameters:

producerIdExpirySecs - the producer id expiry in secs.

getProducerIdExpirySecs

public long getProducerIdExpirySecs()

Specified by:

getProducerIdExpirySecs in interface StreamDescriptor

Returns:

the producer id expiry in secs

setKafkaTopic

public void setKafkaTopic(boolean kafkaTopic)

Description copied from interface: StreamDescriptor

Sets if the stream is a kafka topic stream.

Specified by:

setKafkaTopic in interface StreamDescriptor

isKafkaTopic

public boolean isKafkaTopic()

Specified by:

isKafkaTopic in interface StreamDescriptor

Returns:

If the stream is a kafka topic stream.