Interface IChannelInfoBuilder
interface IChannelInfoBuilder
Extends com.amazon.apmf.IStandard
Builder that will create the Channel object.
Methods
channelDescriptor()
Sets theIChannelInfoBuilder*channelDescriptor(IChannelDescriptor*channelDescriptor)
ChannelDescriptor of the channel builder and returns an instance of the builder.
Parameters
channelDescriptor
IChannelDescriptor* — Required
Returns
IChannelInfoBuilder*
The ChannelInfoBuilder object with channel channelDescriptor set.
Throws
IllegalStateError— if the function is called after this builder instance has already built an object once.
channelMetadata()
Sets theIChannelInfoBuilder*channelMetadata(IChannelMetadata*channelMetadata)
ChannelMetadata of the channel builder and returns an instance of the builder.
Parameters
channelMetadata
IChannelMetadata* — Required
Returns
IChannelInfoBuilder*
The ChannelInfoBuilder object with channel channelMetadata set.
Throws
IllegalStateError— if the function is called after this builder instance has already built an object once.
build()
Builds and returns a pointer to an instance of theIChannelInfo*build()
IChannelInfo object.
This function should be called after the desired fields of the channel builder
have been set using the other builder functions. The build() function should
only be called once per builder object.
Returns
IChannelInfo*
An instance of a ChannelInfo object with all of the data that was set.
Throws
InvalidArgumentError— if one or more of the required fields are not provided to the builder.IllegalStateError— if the function is called after this builder instance has already built an object once.
