Package com.hivemq.extensions.amazon.kinesis.api.model

Interface CustomSettings

@Immutable
@DoNotImplement
public interface CustomSettings

This interface provides information about <custom-settings> as it is configured in the amazon-kinesis-configuration.xml.

Since:

4.14.0

Method Summary

Modifier and Type	Method	Description
@Immutable @NotNull List<@NotNull CustomSetting>	asList()
@Immutable @NotNull Map<String,String>	asSingleValueMap()
@Immutable @NotNull List<@NotNull String>	getAllForName(@NotNull String name)
@NotNull Optional<String>	getFirst(@NotNull String name)
boolean	isEmpty()

Method Detail

getFirst

@NotNull
@NotNull Optional<String> getFirst(@NotNull
                                   @NotNull String name)

Parameters:

name - The name of the custom setting to get.

Returns:

An Optional that contains the first custom setting with the specified name.

Since:

4.14.0

getAllForName

@Immutable
@NotNull
@Immutable @NotNull List<@NotNull String> getAllForName(@NotNull
                                                        @NotNull String name)

Parameters:

name - The name of the custom settings to get.

Returns:

The values custom setting with the specified name.

Since:

4.14.0

asList

@Immutable
@NotNull
@Immutable @NotNull List<@NotNull CustomSetting> asList()

Returns:

A list of all CustomSettings.

Since:

4.14.0

asSingleValueMap

@Immutable
@NotNull
@Immutable @NotNull Map<String,String> asSingleValueMap()

Returns:

A map with the first value for every custom setting name.

Since:

4.14.0

isEmpty

boolean isEmpty()

Returns:

true if no custom settings are present, else false.

Since:

4.14.0