org.apache.nifi.processors.aws.cloudwatch

Class PutCloudWatchMetric

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.aws.AbstractAWSProcessor<ClientType>

org.apache.nifi.processors.aws.AbstractAWSCredentialsProviderProcessor<com.amazonaws.services.cloudwatch.AmazonCloudWatchClient>

org.apache.nifi.processors.aws.cloudwatch.PutCloudWatchMetric

All Implemented Interfaces:

ConfigurableComponent, Processor

Direct Known Subclasses:

MockPutCloudWatchMetric

@SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Publishes metrics to Amazon CloudWatch. Metric can be either a single value, or a StatisticSet comprised of minimum, maximum, sum and sample count.")
 @DynamicProperty(name="Dimension Name",
                 value="Dimension Value",
                 description="Allows dimension name/value pairs to be added to the metric. AWS supports a maximum of 10 dimensions.",
                 supportsExpressionLanguage=true)
 @Tags(value={"amazon","aws","cloudwatch","metrics","put","publish"})
public class PutCloudWatchMetric
extends AbstractAWSCredentialsProviderProcessor<com.amazonaws.services.cloudwatch.AmazonCloudWatchClient>

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	MAXIMUM
static PropertyDescriptor	METRIC_NAME
static PropertyDescriptor	MINIMUM
static PropertyDescriptor	NAMESPACE
static java.util.List<PropertyDescriptor>	properties
static java.util.Set<Relationship>	relationships
static PropertyDescriptor	SAMPLECOUNT
static PropertyDescriptor	SUM
static PropertyDescriptor	TIMESTAMP
static PropertyDescriptor	UNIT
static PropertyDescriptor	VALUE

Fields inherited from class org.apache.nifi.processors.aws.AbstractAWSCredentialsProviderProcessor

AWS_CREDENTIALS_PROVIDER_SERVICE

Fields inherited from class org.apache.nifi.processors.aws.AbstractAWSProcessor

ACCESS_KEY, client, CREDENTIALS_FILE, DEFAULT_PROTOCOL, DEFAULT_USER_AGENT, ENDPOINT_OVERRIDE, PROXY_HOST, PROXY_HOST_PORT, region, REGION, REL_FAILURE, REL_SUCCESS, SECRET_KEY, SSL_CONTEXT_SERVICE, TIMEOUT

Constructor Summary

Constructors

Constructor and Description
PutCloudWatchMetric()

Method Summary

Modifier and Type	Method and Description
protected com.amazonaws.services.cloudwatch.AmazonCloudWatchClient	createClient(ProcessContext processContext, com.amazonaws.auth.AWSCredentials awsCredentials, com.amazonaws.ClientConfiguration clientConfiguration) Deprecated. use createClient(ProcessContext, AWSCredentialsProvider, ClientConfiguration) instead
protected com.amazonaws.services.cloudwatch.AmazonCloudWatchClient	createClient(ProcessContext processContext, com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider, com.amazonaws.ClientConfiguration clientConfiguration) Create client using aws credentials provider.
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext validationContext) Allows subclasses to perform their own validation on the already set properties.
java.util.Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName) Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered.
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
void	onPropertyModified(PropertyDescriptor descriptor, java.lang.String oldValue, java.lang.String newValue) Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor.
void	onTrigger(ProcessContext context, ProcessSession session)
protected com.amazonaws.services.cloudwatch.model.PutMetricDataResult	putMetricData(com.amazonaws.services.cloudwatch.model.PutMetricDataRequest metricDataRequest)

Methods inherited from class org.apache.nifi.processors.aws.AbstractAWSCredentialsProviderProcessor

getCredentialsProvider, onScheduled, onScheduledUsingControllerService, onShutDown

Methods inherited from class org.apache.nifi.processors.aws.AbstractAWSProcessor

createConfiguration, getClient, getCredentials, getRegion, initializeRegionAndEndpoint, onShutdown

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

relationships

public static final java.util.Set<Relationship> relationships

NAMESPACE

public static final PropertyDescriptor NAMESPACE

METRIC_NAME

public static final PropertyDescriptor METRIC_NAME

VALUE

public static final PropertyDescriptor VALUE

TIMESTAMP

public static final PropertyDescriptor TIMESTAMP

UNIT

public static final PropertyDescriptor UNIT

MAXIMUM

public static final PropertyDescriptor MAXIMUM

MINIMUM

public static final PropertyDescriptor MINIMUM

SAMPLECOUNT

public static final PropertyDescriptor SAMPLECOUNT

SUM

public static final PropertyDescriptor SUM

properties

public static final java.util.List<PropertyDescriptor> properties

Constructor Detail

PutCloudWatchMetric

public PutCloudWatchMetric()

Method Detail

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName)

Description copied from class: AbstractConfigurableComponent

Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered. By default this method simply returns a null descriptor. By overriding this method processor implementations can support dynamic properties since this allows them to register properties on demand. It is acceptable for a dynamically generated property to indicate it is required so long as it is understood it is only required once set. Dynamic properties by definition cannot be required until used.

This method should be side effect free in the subclasses in terms of how often it is called for a given property name because there is guarantees how often it will be called for a given property name.

Default is null.

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

Parameters:

propertyDescriptorName - used to lookup if any property descriptors exist for that name

Returns:

new property descriptor if supported

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               java.lang.String oldValue,
                               java.lang.String newValue)

Description copied from class: AbstractConfigurableComponent

Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor. As an alternative to using this method a processor may simply get the latest value whenever it needs it and if necessary lazily evaluate it.

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

Parameters:

descriptor - of the modified property

oldValue - non-null property value (previous)

newValue - the new property value or if null indicates the property was removed

getRelationships

public java.util.Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractAWSProcessor<com.amazonaws.services.cloudwatch.AmazonCloudWatchClient>

Returns:

Set of all relationships this processor expects to transfer a flow file to. An empty set indicates this processor does not have any destination relationships. Guaranteed non null.

customValidate

protected java.util.Collection<ValidationResult> customValidate(ValidationContext validationContext)

Description copied from class: AbstractConfigurableComponent

Allows subclasses to perform their own validation on the already set properties. Since each property is validated as it is set this allows validation of groups of properties together. Default return is an empty set. This method will be called only when it has been determined that all property values are valid according to their corresponding PropertyDescriptor's validators.

Overrides:

customValidate in class AbstractAWSProcessor<com.amazonaws.services.cloudwatch.AmazonCloudWatchClient>

Parameters:

validationContext - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

createClient

protected com.amazonaws.services.cloudwatch.AmazonCloudWatchClient createClient(ProcessContext processContext,
                                                                                com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
                                                                                com.amazonaws.ClientConfiguration clientConfiguration)

Create client using aws credentials provider. This is the preferred way for creating clients

Specified by:

createClient in class AbstractAWSCredentialsProviderProcessor<com.amazonaws.services.cloudwatch.AmazonCloudWatchClient>

Parameters:

processContext - process context

awsCredentialsProvider - aws credentials provider

clientConfiguration - aws client configuration

Returns:

ClientType the client

createClient

protected com.amazonaws.services.cloudwatch.AmazonCloudWatchClient createClient(ProcessContext processContext,
                                                                                com.amazonaws.auth.AWSCredentials awsCredentials,
                                                                                com.amazonaws.ClientConfiguration clientConfiguration)

Deprecated. use createClient(ProcessContext, AWSCredentialsProvider, ClientConfiguration) instead

Create client using AWSCredentials

Specified by:

createClient in class AbstractAWSProcessor<com.amazonaws.services.cloudwatch.AmazonCloudWatchClient>

Parameters:

processContext - process context

awsCredentials - static aws credentials

clientConfiguration - aws client configuration

Returns:

ClientType aws client

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

putMetricData

protected com.amazonaws.services.cloudwatch.model.PutMetricDataResult putMetricData(com.amazonaws.services.cloudwatch.model.PutMetricDataRequest metricDataRequest)
                                                                             throws com.amazonaws.AmazonClientException

Throws:

com.amazonaws.AmazonClientException