Class ProvidersCatalogEntry
-
- All Implemented Interfaces:
public final class ProvidersCatalogEntryA provider type from the catalog. Contains the key, display name, description, and a
settingsobject describing configuration schema fields.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classProvidersCatalogEntry.BuilderA builder for ProvidersCatalogEntry.
public final classProvidersCatalogEntry.SettingsMap of setting field names (snake_case) to their schema descriptors. Each descriptor has
typeandrequired. Empty when the provider has no configurable schema.
-
Method Summary
Modifier and Type Method Description final Stringchannel()Courier taxonomy channel (e.g. final Stringdescription()Short description of the provider. final Stringname()Human-readable display name. final Stringprovider()The provider key (e.g. final ProvidersCatalogEntry.Settingssettings()Map of setting field names (snake_case) to their schema descriptors. final JsonField<String>_channel()Returns the raw JSON value of channel. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_provider()Returns the raw JSON value of provider. final JsonField<ProvidersCatalogEntry.Settings>_settings()Returns the raw JSON value of settings. final Map<String, JsonValue>_additionalProperties()final ProvidersCatalogEntry.BuildertoBuilder()final ProvidersCatalogEntryvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ProvidersCatalogEntry.Builderbuilder()Returns a mutable builder for constructing an instance of ProvidersCatalogEntry. -
-
Method Detail
-
channel
final String channel()
Courier taxonomy channel (e.g. email, push, sms, direct_message, inbox, webhook).
-
description
final String description()
Short description of the provider.
-
settings
final ProvidersCatalogEntry.Settings settings()
Map of setting field names (snake_case) to their schema descriptors. Each descriptor has
typeandrequired. Empty when the provider has no configurable schema.
-
_channel
final JsonField<String> _channel()
Returns the raw JSON value of channel.
Unlike channel, this method doesn't throw if the JSON field has an unexpected type.
-
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_provider
final JsonField<String> _provider()
Returns the raw JSON value of provider.
Unlike provider, this method doesn't throw if the JSON field has an unexpected type.
-
_settings
final JsonField<ProvidersCatalogEntry.Settings> _settings()
Returns the raw JSON value of settings.
Unlike settings, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ProvidersCatalogEntry.Builder toBuilder()
-
validate
final ProvidersCatalogEntry validate()
-
builder
final static ProvidersCatalogEntry.Builder builder()
Returns a mutable builder for constructing an instance of ProvidersCatalogEntry.
The following fields are required:
.channel() .description() .name() .provider() .settings()
-
-
-
-