Package com.netflix.genie.web.spring.autoconfigure.events

Class NotificationsAutoConfiguration

java.lang.Object

com.netflix.genie.web.spring.autoconfigure.events.NotificationsAutoConfiguration

@Configuration
@EnableConfigurationProperties(SNSNotificationsProperties.class)
public class NotificationsAutoConfiguration
extends Object

Beans related to external notifications.

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
NotificationsAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
JobFinishedSNSPublisher	jobFinishedSNSPublisher(SNSNotificationsProperties properties, io.micrometer.core.instrument.MeterRegistry registry, com.amazonaws.services.sns.AmazonSNS snsClient, DataServices dataServices)	Create a JobFinishedSNSPublisher unless one exists in the context already.
JobNotificationMetricPublisher	jobNotificationMetricPublisher(io.micrometer.core.instrument.MeterRegistry registry)	Create a JobNotificationMetricPublisher which publishes metrics related to to job state changes notifications.
JobStateChangeSNSPublisher	jobNotificationsSNSPublisher(SNSNotificationsProperties properties, io.micrometer.core.instrument.MeterRegistry registry, com.amazonaws.services.sns.AmazonSNS snsClient)	Create a JobStateChangeSNSPublisher unless one exists in the context already.
PersistedJobStatusObserver	persistedJobStatusObserver(GenieEventBus genieEventBus)	Create PersistedJobStatusObserver if one does not exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NotificationsAutoConfiguration

public NotificationsAutoConfiguration()

Method Details

persistedJobStatusObserver

@Bean
@ConditionalOnMissingBean(PersistedJobStatusObserver.class)
public PersistedJobStatusObserver persistedJobStatusObserver(GenieEventBus genieEventBus)

Create PersistedJobStatusObserver if one does not exist.

Parameters:

genieEventBus - the genie event bus

Returns:

a PersistedJobStatusObserver

jobNotificationMetricPublisher

@Bean
@ConditionalOnMissingBean(JobNotificationMetricPublisher.class)
public JobNotificationMetricPublisher jobNotificationMetricPublisher(io.micrometer.core.instrument.MeterRegistry registry)

Create a JobNotificationMetricPublisher which publishes metrics related to to job state changes notifications.

Parameters:

registry - the metrics registry

Returns:

a JobNotificationMetricPublisher

jobNotificationsSNSPublisher

@Bean
@ConditionalOnProperty(value="genie.notifications.sns.enabled",
                       havingValue="true")
@ConditionalOnMissingBean(JobStateChangeSNSPublisher.class)
public JobStateChangeSNSPublisher jobNotificationsSNSPublisher(SNSNotificationsProperties properties,
 io.micrometer.core.instrument.MeterRegistry registry,
 com.amazonaws.services.sns.AmazonSNS snsClient)

Create a JobStateChangeSNSPublisher unless one exists in the context already.

Parameters:

snsClient - the Amazon SNS client

properties - configuration properties

registry - the metrics registry

Returns:

a JobStateChangeSNSPublisher

jobFinishedSNSPublisher

@Bean
@ConditionalOnProperty(value="genie.notifications.sns.enabled",
                       havingValue="true")
@ConditionalOnMissingBean(JobFinishedSNSPublisher.class)
public JobFinishedSNSPublisher jobFinishedSNSPublisher(SNSNotificationsProperties properties,
 io.micrometer.core.instrument.MeterRegistry registry,
 com.amazonaws.services.sns.AmazonSNS snsClient,
 DataServices dataServices)

Create a JobFinishedSNSPublisher unless one exists in the context already.

Parameters:

properties - configuration properties

registry - the metrics registry

snsClient - the Amazon SNS client

dataServices - The DataServices instance to use

Returns:

a JobFinishedSNSPublisher