Package software.amazon.awssdk.services.rum.model

Class BatchCreateRumMetricDefinitionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rum.model.RumRequest

software.amazon.awssdk.services.rum.model.BatchCreateRumMetricDefinitionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchCreateRumMetricDefinitionsRequest.Builder,BatchCreateRumMetricDefinitionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class BatchCreateRumMetricDefinitionsRequest
extends RumRequest
implements ToCopyableBuilder<BatchCreateRumMetricDefinitionsRequest.Builder,BatchCreateRumMetricDefinitionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchCreateRumMetricDefinitionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	appMonitorName()	The name of the CloudWatch RUM app monitor that is to send the metrics.
static BatchCreateRumMetricDefinitionsRequest.Builder	builder()
MetricDestination	destination()	The destination to send the metrics to.
String	destinationArn()	This parameter is required if Destination is Evidently.
String	destinationAsString()	The destination to send the metrics to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricDefinitions()	For responses, this returns true if the service returned a value for the MetricDefinitions property.
List<MetricDefinitionRequest>	metricDefinitions()	An array of structures which define the metrics that you want to send.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchCreateRumMetricDefinitionsRequest.Builder>	serializableBuilderClass()
BatchCreateRumMetricDefinitionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

appMonitorName

public final String appMonitorName()

The name of the CloudWatch RUM app monitor that is to send the metrics.

Returns:

The name of the CloudWatch RUM app monitor that is to send the metrics.

destination

public final MetricDestination destination()

The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

If the service returns an enum value that is not available in the current SDK version, destination will return MetricDestination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationAsString().

Returns:

The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

See Also:

MetricDestination

destinationAsString

public final String destinationAsString()

The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

If the service returns an enum value that is not available in the current SDK version, destination will return MetricDestination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationAsString().

Returns:

The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

See Also:

MetricDestination

destinationArn

public final String destinationArn()

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

Returns:

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

hasMetricDefinitions

public final boolean hasMetricDefinitions()

For responses, this returns true if the service returned a value for the MetricDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metricDefinitions

public final List<MetricDefinitionRequest> metricDefinitions()

An array of structures which define the metrics that you want to send.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricDefinitions() method.

Returns:

An array of structures which define the metrics that you want to send.

toBuilder

public BatchCreateRumMetricDefinitionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchCreateRumMetricDefinitionsRequest.Builder,BatchCreateRumMetricDefinitionsRequest>

Specified by:

toBuilder in class RumRequest

builder

public static BatchCreateRumMetricDefinitionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchCreateRumMetricDefinitionsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo