com.microsoft.applicationinsights.internal.heartbeat

Interface HeartBeatPayloadProviderInterface

All Known Implementing Classes:

DefaultHeartBeatPropertyProvider, WebAppsHeartbeatProvider

public interface HeartBeatPayloadProviderInterface

Interface for setting default properties

This interface is used to set the default payload of a provider and defines implementation for some helper methods to assist it. The default concrete implementations are DefaultHeartBeatPropertyProvider and WebAppsHeartbeatProvider

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the heartbeat provider.
boolean	isKeyword(java.lang.String keyword) Tells if the input string is a reserved property.
java.util.concurrent.Callable<java.lang.Boolean>	setDefaultPayload(java.util.List<java.lang.String> disableFields, HeartBeatProviderInterface provider) Returns a callable which can be executed to set the payload based on the parameters.

Method Detail

getName

java.lang.String getName()

Returns the name of the heartbeat provider.

Returns:

Name of the heartbeat provider

isKeyword

boolean isKeyword(java.lang.String keyword)

Tells if the input string is a reserved property.

Parameters:

keyword - string to test

Returns:

true if input string is reserved keyword

setDefaultPayload

java.util.concurrent.Callable<java.lang.Boolean> setDefaultPayload(java.util.List<java.lang.String> disableFields,
                                                                   HeartBeatProviderInterface provider)

Returns a callable which can be executed to set the payload based on the parameters.

Parameters:

disableFields - List of Properties to be excluded from payload

provider - The current heartbeat provider

Returns:

Callable which can be executed to add the payload