com.amazonaws.services.cloudwatchrum.model.MetricDefinitionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudwatchrum Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudwatchrum.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Use this structure to define one extended metric or custom metric that RUM will send to CloudWatch or CloudWatch
* Evidently. For more information, see
* Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently.
*
*
* This structure is validated differently for extended metrics and custom metrics. For extended metrics that are sent
* to the AWS/RUM namespace, the following validations apply:
*
*
* -
*
* The Namespace parameter must be omitted or set to AWS/RUM.
*
*
* -
*
* Only certain combinations of values for Name, ValueKey, and EventPattern are
* valid. In addition to what is displayed in the following list, 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"]}
*
*
* -
*
* If Name is PageViewCount, then ValueKeymust be null and the
* EventPattern must include {"event_type":["com.amazon.rum.page_view_event"]}
*
*
* -
*
* If Name is Http4xxCount, then ValueKeymust be null and the
* EventPattern must include
* {"event_type": ["com.amazon.rum.http_event"],"event_details":{"response":{"status":[{"numeric":[">=",400,"<",500]}]}}} }
*
*
* -
*
* If Name is Http5xxCount, then ValueKeymust be null and the
* EventPattern must include
* {"event_type": ["com.amazon.rum.http_event"],"event_details":{"response":{"status":[{"numeric":[">=",500,"<=",599]}]}}} }
*
*
*
*
*
*
* For custom metrics, the following validation rules apply:
*
*
* -
*
* The namespace can't be omitted and can't be AWS/RUM. You can use the AWS/RUM namespace only
* for extended metrics.
*
*
* -
*
* All dimensions listed in the DimensionKeys field must be present in the value of
* EventPattern.
*
*
* -
*
* The values that you specify for ValueKey, EventPattern, and DimensionKeys must
* be fields in RUM events, so all first-level keys in these fields must be one of the keys in the list later in this
* section.
*
*
* -
*
* If you set a value for EventPattern, it must be a JSON object.
*
*
* -
*
* For every non-empty event_details, there must be a non-empty event_type.
*
*
* -
*
* If EventPattern contains an event_details field, it must also contain an
* event_type. For every built-in event_type that you use, you must use a value for
* event_details that corresponds to that event_type. For information about event details that
* correspond to event types, see RUM event details.
*
*
* -
*
* In EventPattern, any JSON array must contain only one value.
*
*
*
*
* Valid key values for first-level keys in the ValueKey, EventPattern, and
* DimensionKeys fields:
*
*
* -
*
* account_id
*
*
* -
*
* application_Id
*
*
* -
*
* application_version
*
*
* -
*
* application_name
*
*
* -
*
* batch_id
*
*
* -
*
* event_details
*
*
* -
*
* event_id
*
*
* -
*
* event_interaction
*
*
* -
*
* event_timestamp
*
*
* -
*
* event_type
*
*
* -
*
* event_version
*
*
* -
*
* log_stream
*
*
* -
*
* metadata
*
*
* -
*
* sessionId
*
*
* -
*
* user_details
*
*
* -
*
* userId
*
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MetricDefinitionRequest implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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. For extended metrics, 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"
*
*
*
*
* For both extended metrics and custom metrics, all dimensions listed in this field must also be included in
* EventPattern.
*
*/
private java.util.Map dimensionKeys;
/**
*
* 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.
*
*/
private String eventPattern;
/**
*
* The name for the metric that is defined in this structure. For custom metrics, you can specify any name that you
* like. For extended metrics, valid values are the following:
*
*
* -
*
* PerformanceNavigationDuration
*
*
* -
*
* PerformanceResourceDuration
*
*
* -
*
* NavigationSatisfiedTransaction
*
*
* -
*
* NavigationToleratedTransaction
*
*
* -
*
* NavigationFrustratedTransaction
*
*
* -
*
* WebVitalsCumulativeLayoutShift
*
*
* -
*
* WebVitalsFirstInputDelay
*
*
* -
*
* WebVitalsLargestContentfulPaint
*
*
* -
*
* JsErrorCount
*
*
* -
*
* HttpErrorCount
*
*
* -
*
* SessionCount
*
*
*
*/
private String name;
/**
*
* If this structure is for a custom metric instead of an extended metrics, use this parameter to define the metric
* namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.
*
*
* You cannot use any string that starts with AWS/ for your namespace.
*
*/
private String namespace;
/**
*
* The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
*
*/
private String unitLabel;
/**
*
* 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 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. Evidently will handle
* data extraction from the event.
*
*/
private String valueKey;
/**
*
* 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. For extended metrics, 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"
*
*
*
*
* For both extended metrics and custom metrics, all dimensions listed in this field must also be included in
* EventPattern.
*
*
* @return 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. For extended metrics, 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"
*
*
*
*
* For both extended metrics and custom metrics, all dimensions listed in this field must also be included
* in EventPattern.
*/
public java.util.Map getDimensionKeys() {
return 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. For extended metrics, 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"
*
*
*
*
* For both extended metrics and custom metrics, all dimensions listed in this field must also be included in
* EventPattern.
*
*
* @param 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. For extended metrics, 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"
*
*
*
*
* For both extended metrics and custom metrics, all dimensions listed in this field must also be included in
* EventPattern.
*/
public void setDimensionKeys(java.util.Map dimensionKeys) {
this.dimensionKeys = 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. For extended metrics, 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"
*
*
*
*
* For both extended metrics and custom metrics, all dimensions listed in this field must also be included in
* EventPattern.
*
*
* @param 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. For extended metrics, 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"
*
*
*
*
* For both extended metrics and custom metrics, all dimensions listed in this field must also be included in
* EventPattern.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDefinitionRequest withDimensionKeys(java.util.Map dimensionKeys) {
setDimensionKeys(dimensionKeys);
return this;
}
/**
* Add a single DimensionKeys entry
*
* @see MetricDefinitionRequest#withDimensionKeys
* @returns a reference to this object so that method calls can be chained together.
*/
public MetricDefinitionRequest addDimensionKeysEntry(String key, String value) {
if (null == this.dimensionKeys) {
this.dimensionKeys = new java.util.HashMap();
}
if (this.dimensionKeys.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.dimensionKeys.put(key, value);
return this;
}
/**
* Removes all the entries added into DimensionKeys.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDefinitionRequest clearDimensionKeysEntries() {
this.dimensionKeys = null;
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEventPattern(String eventPattern) {
this.eventPattern = 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.
*
*
* @return 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.
*/
public String getEventPattern() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDefinitionRequest withEventPattern(String eventPattern) {
setEventPattern(eventPattern);
return this;
}
/**
*
* The name for the metric that is defined in this structure. For custom metrics, you can specify any name that you
* like. For extended metrics, valid values are the following:
*
*
* -
*
* PerformanceNavigationDuration
*
*
* -
*
* PerformanceResourceDuration
*
*
* -
*
* NavigationSatisfiedTransaction
*
*
* -
*
* NavigationToleratedTransaction
*
*
* -
*
* NavigationFrustratedTransaction
*
*
* -
*
* WebVitalsCumulativeLayoutShift
*
*
* -
*
* WebVitalsFirstInputDelay
*
*
* -
*
* WebVitalsLargestContentfulPaint
*
*
* -
*
* JsErrorCount
*
*
* -
*
* HttpErrorCount
*
*
* -
*
* SessionCount
*
*
*
*
* @param name
* The name for the metric that is defined in this structure. For custom metrics, you can specify any name
* that you like. For extended metrics, valid values are the following:
*
* -
*
* PerformanceNavigationDuration
*
*
* -
*
* PerformanceResourceDuration
*
*
* -
*
* NavigationSatisfiedTransaction
*
*
* -
*
* NavigationToleratedTransaction
*
*
* -
*
* NavigationFrustratedTransaction
*
*
* -
*
* WebVitalsCumulativeLayoutShift
*
*
* -
*
* WebVitalsFirstInputDelay
*
*
* -
*
* WebVitalsLargestContentfulPaint
*
*
* -
*
* JsErrorCount
*
*
* -
*
* HttpErrorCount
*
*
* -
*
* SessionCount
*
*
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name for the metric that is defined in this structure. For custom metrics, you can specify any name that you
* like. For extended metrics, valid values are the following:
*
*
* -
*
* PerformanceNavigationDuration
*
*
* -
*
* PerformanceResourceDuration
*
*
* -
*
* NavigationSatisfiedTransaction
*
*
* -
*
* NavigationToleratedTransaction
*
*
* -
*
* NavigationFrustratedTransaction
*
*
* -
*
* WebVitalsCumulativeLayoutShift
*
*
* -
*
* WebVitalsFirstInputDelay
*
*
* -
*
* WebVitalsLargestContentfulPaint
*
*
* -
*
* JsErrorCount
*
*
* -
*
* HttpErrorCount
*
*
* -
*
* SessionCount
*
*
*
*
* @return The name for the metric that is defined in this structure. For custom metrics, you can specify any name
* that you like. For extended metrics, valid values are the following:
*
* -
*
* PerformanceNavigationDuration
*
*
* -
*
* PerformanceResourceDuration
*
*
* -
*
* NavigationSatisfiedTransaction
*
*
* -
*
* NavigationToleratedTransaction
*
*
* -
*
* NavigationFrustratedTransaction
*
*
* -
*
* WebVitalsCumulativeLayoutShift
*
*
* -
*
* WebVitalsFirstInputDelay
*
*
* -
*
* WebVitalsLargestContentfulPaint
*
*
* -
*
* JsErrorCount
*
*
* -
*
* HttpErrorCount
*
*
* -
*
* SessionCount
*
*
*/
public String getName() {
return this.name;
}
/**
*
* The name for the metric that is defined in this structure. For custom metrics, you can specify any name that you
* like. For extended metrics, valid values are the following:
*
*
* -
*
* PerformanceNavigationDuration
*
*
* -
*
* PerformanceResourceDuration
*
*
* -
*
* NavigationSatisfiedTransaction
*
*
* -
*
* NavigationToleratedTransaction
*
*
* -
*
* NavigationFrustratedTransaction
*
*
* -
*
* WebVitalsCumulativeLayoutShift
*
*
* -
*
* WebVitalsFirstInputDelay
*
*
* -
*
* WebVitalsLargestContentfulPaint
*
*
* -
*
* JsErrorCount
*
*
* -
*
* HttpErrorCount
*
*
* -
*
* SessionCount
*
*
*
*
* @param name
* The name for the metric that is defined in this structure. For custom metrics, you can specify any name
* that you like. For extended metrics, valid values are the following:
*
* -
*
* PerformanceNavigationDuration
*
*
* -
*
* PerformanceResourceDuration
*
*
* -
*
* NavigationSatisfiedTransaction
*
*
* -
*
* NavigationToleratedTransaction
*
*
* -
*
* NavigationFrustratedTransaction
*
*
* -
*
* WebVitalsCumulativeLayoutShift
*
*
* -
*
* WebVitalsFirstInputDelay
*
*
* -
*
* WebVitalsLargestContentfulPaint
*
*
* -
*
* JsErrorCount
*
*
* -
*
* HttpErrorCount
*
*
* -
*
* SessionCount
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDefinitionRequest withName(String name) {
setName(name);
return this;
}
/**
*
* If this structure is for a custom metric instead of an extended metrics, use this parameter to define the metric
* namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.
*
*
* You cannot use any string that starts with AWS/ for your namespace.
*
*
* @param namespace
* If this structure is for a custom metric instead of an extended metrics, use this parameter to define the
* metric namespace for that custom metric. Do not specify this parameter if this structure is for an
* extended metric.
*
* You cannot use any string that starts with AWS/ for your namespace.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
*
* If this structure is for a custom metric instead of an extended metrics, use this parameter to define the metric
* namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.
*
*
* You cannot use any string that starts with AWS/ for your namespace.
*
*
* @return If this structure is for a custom metric instead of an extended metrics, use this parameter to define the
* metric namespace for that custom metric. Do not specify this parameter if this structure is for an
* extended metric.
*
* You cannot use any string that starts with AWS/ for your namespace.
*/
public String getNamespace() {
return this.namespace;
}
/**
*
* If this structure is for a custom metric instead of an extended metrics, use this parameter to define the metric
* namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.
*
*
* You cannot use any string that starts with AWS/ for your namespace.
*
*
* @param namespace
* If this structure is for a custom metric instead of an extended metrics, use this parameter to define the
* metric namespace for that custom metric. Do not specify this parameter if this structure is for an
* extended metric.
*
* You cannot use any string that starts with AWS/ for your namespace.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDefinitionRequest withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
*
*
* @param unitLabel
* The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no
* unit.
*/
public void setUnitLabel(String unitLabel) {
this.unitLabel = unitLabel;
}
/**
*
* The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
*
*
* @return The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no
* unit.
*/
public String getUnitLabel() {
return this.unitLabel;
}
/**
*
* The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
*
*
* @param unitLabel
* The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no
* unit.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDefinitionRequest withUnitLabel(String unitLabel) {
setUnitLabel(unitLabel);
return this;
}
/**
*
* 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 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. Evidently will handle
* data extraction from the event.
*
*
* @param 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 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. Evidently will
* handle data extraction from the event.
*/
public void setValueKey(String valueKey) {
this.valueKey = 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 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. Evidently will handle
* data extraction from the event.
*
*
* @return 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 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. Evidently
* will handle data extraction from the event.
*/
public String getValueKey() {
return this.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 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. Evidently will handle
* data extraction from the event.
*
*
* @param 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 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. Evidently will
* handle data extraction from the event.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDefinitionRequest withValueKey(String valueKey) {
setValueKey(valueKey);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDimensionKeys() != null)
sb.append("DimensionKeys: ").append(getDimensionKeys()).append(",");
if (getEventPattern() != null)
sb.append("EventPattern: ").append(getEventPattern()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getNamespace() != null)
sb.append("Namespace: ").append(getNamespace()).append(",");
if (getUnitLabel() != null)
sb.append("UnitLabel: ").append(getUnitLabel()).append(",");
if (getValueKey() != null)
sb.append("ValueKey: ").append(getValueKey());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MetricDefinitionRequest == false)
return false;
MetricDefinitionRequest other = (MetricDefinitionRequest) obj;
if (other.getDimensionKeys() == null ^ this.getDimensionKeys() == null)
return false;
if (other.getDimensionKeys() != null && other.getDimensionKeys().equals(this.getDimensionKeys()) == false)
return false;
if (other.getEventPattern() == null ^ this.getEventPattern() == null)
return false;
if (other.getEventPattern() != null && other.getEventPattern().equals(this.getEventPattern()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getNamespace() == null ^ this.getNamespace() == null)
return false;
if (other.getNamespace() != null && other.getNamespace().equals(this.getNamespace()) == false)
return false;
if (other.getUnitLabel() == null ^ this.getUnitLabel() == null)
return false;
if (other.getUnitLabel() != null && other.getUnitLabel().equals(this.getUnitLabel()) == false)
return false;
if (other.getValueKey() == null ^ this.getValueKey() == null)
return false;
if (other.getValueKey() != null && other.getValueKey().equals(this.getValueKey()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDimensionKeys() == null) ? 0 : getDimensionKeys().hashCode());
hashCode = prime * hashCode + ((getEventPattern() == null) ? 0 : getEventPattern().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
hashCode = prime * hashCode + ((getUnitLabel() == null) ? 0 : getUnitLabel().hashCode());
hashCode = prime * hashCode + ((getValueKey() == null) ? 0 : getValueKey().hashCode());
return hashCode;
}
@Override
public MetricDefinitionRequest clone() {
try {
return (MetricDefinitionRequest) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.cloudwatchrum.model.transform.MetricDefinitionRequestMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}