org.thales.punch.platform.api

Interface ITopic

All Superinterfaces:

ISettingsMap, Map<String,Object>

All Known Implementing Classes:

TopicImpl

public interface ITopic
extends ISettingsMap

The ITopic interface lets you access a given topology resources.

Author:

dimi

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
IEntity	getChannel()
Map<String,String>	getConfigs() This return, if defined, the "delete.retention.ms", "retention.bytes" and "cleanup.policy"
String	getKafkaCluster()
String	getName()
int	getPartitionNumber()
int	getReplicationFactor()

Methods inherited from interface org.thales.punch.settings.api.ISettingsMap

asFlatValuesMap, asFlatValuesMap, asFlatValuesMapIgnoreSettingsList, asHjsonString, asJsonString, asJsonString, asKvString, asListFlatValuesMapIgnoreSettingsList, asYamlString, childAsJson, childAsListOfString, childAsMapEntries, childAsMapValues, childAsRawContent, childAsRequiredListOfString, childAsRequiredString, childAsString, childAsStringContent, childAsTarGz, childFileAsMap, childIsDir, childIsFile, getAsBoolean, getAsBoolean, getAsDouble, getAsInteger, getAsInteger, getAsIsoDateTime, getAsLong, getAsLong, getAsMsDuration, getAsRequiredBoolean, getAsRequiredDouble, getAsRequiredInteger, getAsRequiredIsoDateTime, getAsRequiredLong, getAsRequiredObject, getAsRequiredObjectOfClass, getAsRequiredSettingsList, getAsRequiredSettingsMap, getAsRequiredString, getAsRequiredTimeValue, getAsRequiredZonedDateTime, getAsSettingsList, getAsSettingsList, getAsSettingsListOrEmpty, getAsSettingsMap, getAsSettingsMap, getAsString, getAsString, getAsTimeValue, getCreateAsListOfMap, getCreateMap, getDeepCopy, getMapOrEmpty, getNestedProperty, getOrCreateNestedSettingsMap, getOriginatorName, getRequiredNestedProperty, getStringOrFail, getStringOrFail, getTimeValueMs, overrideWith, putUsingDottedPath, putUsingSlashPath, removeUsingDottedPath, removeUsingSlashPath, setNestedProperty, setOriginatorName, setPropertyIfMissing

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getName

String getName()

Returns:

the name of this job

getChannel

IEntity getChannel()

Returns:

this topology's channel

getKafkaCluster

String getKafkaCluster()
                throws ConfigurationException

Returns:

the associated kafka cluster

Throws:

ConfigurationException

getPartitionNumber

int getPartitionNumber()

Returns:

the number of partitions

getReplicationFactor

int getReplicationFactor()

Returns:

the replication factor

getConfigs

Map<String,String> getConfigs()

This return, if defined, the "delete.retention.ms", "retention.bytes" and "cleanup.policy"

Returns:

a kafka topic map of properties.