com.amazonaws.services.cloudwatchrum.model

Class MetricDefinitionRequest

java.lang.Object

com.amazonaws.services.cloudwatchrum.model.MetricDefinitionRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricDefinitionRequest
extends Object
implements Serializable, Cloneable, StructuredPojo

Use this structure to define one extended metric that RUM will send to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently.

Only certain combinations of values for Name, ValueKey, and EventPattern are valid. In addition to what is displayed in the list below, the EventPattern can also include information used by the DimensionKeys field.

• If Name is PerformanceNavigationDuration, then ValueKeymust be event_details.duration and the EventPattern must include {"event_type":["com.amazon.rum.performance_navigation_event"]}

• If Name is PerformanceResourceDuration, then ValueKeymust be event_details.duration and the EventPattern must include {"event_type":["com.amazon.rum.performance_resource_event"]}

• If Name is NavigationSatisfiedTransaction, then ValueKeymust be null and the EventPattern must include { "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">",2000] }] } }

• If Name is NavigationToleratedTransaction, then ValueKeymust be null and the EventPattern must include { "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",2000,"<"8000] }] } }

• If Name is NavigationFrustratedTransaction, then ValueKeymust be null and the EventPattern must include { "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",8000] }] } }

• If Name is WebVitalsCumulativeLayoutShift, then ValueKeymust be event_details.value and the EventPattern must include {"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}

• If Name is WebVitalsFirstInputDelay, then ValueKeymust be event_details.value and the EventPattern must include {"event_type":["com.amazon.rum.first_input_delay_event"]}

• If Name is WebVitalsLargestContentfulPaint, then ValueKeymust be event_details.value and the EventPattern must include {"event_type":["com.amazon.rum.largest_contentful_paint_event"]}

• If Name is JsErrorCount, then ValueKeymust be null and the EventPattern must include {"event_type":["com.amazon.rum.js_error_event"]}

• If Name is HttpErrorCount, then ValueKeymust be null and the EventPattern must include {"event_type":["com.amazon.rum.http_event"]}

• If Name is SessionCount, then ValueKeymust be null and the EventPattern must include {"event_type":["com.amazon.rum.session_start_event"]}

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricDefinitionRequest()

Method Summary

Modifier and Type	Method and Description
MetricDefinitionRequest	addDimensionKeysEntry(String key, String value) Add a single DimensionKeys entry
MetricDefinitionRequest	clearDimensionKeysEntries() Removes all the entries added into DimensionKeys.
MetricDefinitionRequest	clone()
boolean	equals(Object obj)
Map<String,String>	getDimensionKeys() Use this field only if you are sending the metric to CloudWatch.
String	getEventPattern() The pattern that defines the metric, specified as a JSON object.
String	getName() The name for the metric that is defined in this structure.
String	getUnitLabel() The CloudWatch metric unit to use for this metric.
String	getValueKey() The field within the event object that the metric value is sourced from.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setDimensionKeys(Map<String,String> dimensionKeys) Use this field only if you are sending the metric to CloudWatch.
void	setEventPattern(String eventPattern) The pattern that defines the metric, specified as a JSON object.
void	setName(String name) The name for the metric that is defined in this structure.
void	setUnitLabel(String unitLabel) The CloudWatch metric unit to use for this metric.
void	setValueKey(String valueKey) The field within the event object that the metric value is sourced from.
String	toString() Returns a string representation of this object.
MetricDefinitionRequest	withDimensionKeys(Map<String,String> dimensionKeys) Use this field only if you are sending the metric to CloudWatch.
MetricDefinitionRequest	withEventPattern(String eventPattern) The pattern that defines the metric, specified as a JSON object.
MetricDefinitionRequest	withName(String name) The name for the metric that is defined in this structure.
MetricDefinitionRequest	withUnitLabel(String unitLabel) The CloudWatch metric unit to use for this metric.
MetricDefinitionRequest	withValueKey(String valueKey) The field within the event object that the metric value is sourced from.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricDefinitionRequest

public MetricDefinitionRequest()

Method Detail

getDimensionKeys

public Map<String,String> getDimensionKeys()

Use this field only if you are sending the metric to CloudWatch.

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following:

• "metadata.pageId": "PageId"

• "metadata.browserName": "BrowserName"

• "metadata.deviceType": "DeviceType"

• "metadata.osName": "OSName"

• "metadata.countryCode": "CountryCode"

• "event_details.fileType": "FileType"

  <p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p> 
 

Returns:

Use this field only if you are sending the metric to CloudWatch.

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following:

• "metadata.pageId": "PageId"

• "metadata.browserName": "BrowserName"

• "metadata.deviceType": "DeviceType"

• "metadata.osName": "OSName"

• "metadata.countryCode": "CountryCode"

• "event_details.fileType": "FileType"

 <p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p> 

setDimensionKeys

public void setDimensionKeys(Map<String,String> dimensionKeys)

Use this field only if you are sending the metric to CloudWatch.

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following:

• "metadata.pageId": "PageId"

• "metadata.browserName": "BrowserName"

• "metadata.deviceType": "DeviceType"

• "metadata.osName": "OSName"

• "metadata.countryCode": "CountryCode"

• "event_details.fileType": "FileType"

  <p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p> 
 

Parameters:

dimensionKeys - Use this field only if you are sending the metric to CloudWatch.

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following:

• "metadata.pageId": "PageId"

• "metadata.browserName": "BrowserName"

• "metadata.deviceType": "DeviceType"

• "metadata.osName": "OSName"

• "metadata.countryCode": "CountryCode"

• "event_details.fileType": "FileType"

 <p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p> 

withDimensionKeys

public MetricDefinitionRequest withDimensionKeys(Map<String,String> dimensionKeys)

Use this field only if you are sending the metric to CloudWatch.

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following:

• "metadata.pageId": "PageId"

• "metadata.browserName": "BrowserName"

• "metadata.deviceType": "DeviceType"

• "metadata.osName": "OSName"

• "metadata.countryCode": "CountryCode"

• "event_details.fileType": "FileType"

  <p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p> 
 

Parameters:

dimensionKeys - Use this field only if you are sending the metric to CloudWatch.

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following:

• "metadata.pageId": "PageId"

• "metadata.browserName": "BrowserName"

• "metadata.deviceType": "DeviceType"

• "metadata.osName": "OSName"

• "metadata.countryCode": "CountryCode"

• "event_details.fileType": "FileType"

  <p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p> 

Returns:

Returns a reference to this object so that method calls can be chained together.

addDimensionKeysEntry

public MetricDefinitionRequest addDimensionKeysEntry(String key,
                                                     String value)

Add a single DimensionKeys entry

See Also:

withDimensionKeys(java.util.Map<java.lang.String, java.lang.String>)

clearDimensionKeysEntries

public MetricDefinitionRequest clearDimensionKeysEntries()

Removes all the entries added into DimensionKeys.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEventPattern

public void setEventPattern(String eventPattern)

The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

Example event patterns:

• '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

Parameters:

eventPattern - The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

Example event patterns:

• '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

getEventPattern

public String getEventPattern()

The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

Example event patterns:

• '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

Returns:

The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

Example event patterns:

• '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

withEventPattern

public MetricDefinitionRequest withEventPattern(String eventPattern)

The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

Example event patterns:

• '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

Parameters:

eventPattern - The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

Example event patterns:

• '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

• '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The name for the metric that is defined in this structure. Valid values are the following:

• PerformanceNavigationDuration

• PerformanceResourceDuration

• NavigationSatisfiedTransaction

• NavigationToleratedTransaction

• NavigationFrustratedTransaction

• WebVitalsCumulativeLayoutShift

• WebVitalsFirstInputDelay

• WebVitalsLargestContentfulPaint

• JsErrorCount

• HttpErrorCount

• SessionCount

Parameters:

name - The name for the metric that is defined in this structure. Valid values are the following:

• PerformanceNavigationDuration

• PerformanceResourceDuration

• NavigationSatisfiedTransaction

• NavigationToleratedTransaction

• NavigationFrustratedTransaction

• WebVitalsCumulativeLayoutShift

• WebVitalsFirstInputDelay

• WebVitalsLargestContentfulPaint

• JsErrorCount

• HttpErrorCount

• SessionCount

getName

public String getName()

The name for the metric that is defined in this structure. Valid values are the following:

• PerformanceNavigationDuration

• PerformanceResourceDuration

• NavigationSatisfiedTransaction

• NavigationToleratedTransaction

• NavigationFrustratedTransaction

• WebVitalsCumulativeLayoutShift

• WebVitalsFirstInputDelay

• WebVitalsLargestContentfulPaint

• JsErrorCount

• HttpErrorCount

• SessionCount

Returns:

The name for the metric that is defined in this structure. Valid values are the following:

• PerformanceNavigationDuration

• PerformanceResourceDuration

• NavigationSatisfiedTransaction

• NavigationToleratedTransaction

• NavigationFrustratedTransaction

• WebVitalsCumulativeLayoutShift

• WebVitalsFirstInputDelay

• WebVitalsLargestContentfulPaint

• JsErrorCount

• HttpErrorCount

• SessionCount

withName

public MetricDefinitionRequest withName(String name)

The name for the metric that is defined in this structure. Valid values are the following:

• PerformanceNavigationDuration

• PerformanceResourceDuration

• NavigationSatisfiedTransaction

• NavigationToleratedTransaction

• NavigationFrustratedTransaction

• WebVitalsCumulativeLayoutShift

• WebVitalsFirstInputDelay

• WebVitalsLargestContentfulPaint

• JsErrorCount

• HttpErrorCount

• SessionCount

Parameters:

name - The name for the metric that is defined in this structure. Valid values are the following:

• PerformanceNavigationDuration

• PerformanceResourceDuration

• NavigationSatisfiedTransaction

• NavigationToleratedTransaction

• NavigationFrustratedTransaction

• WebVitalsCumulativeLayoutShift

• WebVitalsFirstInputDelay

• WebVitalsLargestContentfulPaint

• JsErrorCount

• HttpErrorCount

• SessionCount

Returns:

Returns a reference to this object so that method calls can be chained together.

setUnitLabel

public void setUnitLabel(String unitLabel)

The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

Parameters:

unitLabel - The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

getUnitLabel

public String getUnitLabel()

The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

Returns:

The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

withUnitLabel

public MetricDefinitionRequest withUnitLabel(String unitLabel)

The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

Parameters:

unitLabel - The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

Returns:

Returns a reference to this object so that method calls can be chained together.

setValueKey

public void setValueKey(String valueKey)

The field within the event object that the metric value is sourced from.

If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

Parameters:

valueKey - The field within the event object that the metric value is sourced from.

If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

getValueKey

public String getValueKey()

The field within the event object that the metric value is sourced from.

If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

Returns:

The field within the event object that the metric value is sourced from.

If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

withValueKey

public MetricDefinitionRequest withValueKey(String valueKey)

The field within the event object that the metric value is sourced from.

If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

Parameters:

valueKey - The field within the event object that the metric value is sourced from.

If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MetricDefinitionRequest clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo