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

Class AppMonitor

java.lang.Object

software.amazon.awssdk.services.rum.model.AppMonitor

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AppMonitor.Builder,AppMonitor>

@Generated("software.amazon.awssdk:codegen")
public final class AppMonitor
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AppMonitor.Builder,AppMonitor>

A RUM app monitor collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AppMonitor.Builder

Method Summary

Modifier and Type	Method	Description
AppMonitorConfiguration	appMonitorConfiguration()	A structure that contains much of the configuration data for the app monitor.
static AppMonitor.Builder	builder()
String	created()	The date and time that this app monitor was created.
CustomEvents	customEvents()	Specifies whether this app monitor allows the web client to define and send custom events.
DataStorage	dataStorage()	A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.
String	domain()	The top-level internet domain name for which your application has administrative authority.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	id()	The unique ID of this app monitor.
String	lastModified()	The date and time of the most recent changes to this app monitor's configuration.
String	name()	The name of the app monitor.
List<SdkField<?>>	sdkFields()
static Class<? extends AppMonitor.Builder>	serializableBuilderClass()
StateEnum	state()	The current state of the app monitor.
String	stateAsString()	The current state of the app monitor.
Map<String,String>	tags()	The list of tag keys and values associated with this app monitor.
AppMonitor.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

appMonitorConfiguration

public final AppMonitorConfiguration appMonitorConfiguration()

A structure that contains much of the configuration data for the app monitor.

Returns:

A structure that contains much of the configuration data for the app monitor.

created

public final String created()

The date and time that this app monitor was created.

Returns:

The date and time that this app monitor was created.

customEvents

public final CustomEvents customEvents()

Specifies whether this app monitor allows the web client to define and send custom events.

For more information about custom events, see Send custom events.

Returns:

Specifies whether this app monitor allows the web client to define and send custom events.

For more information about custom events, see Send custom events.

dataStorage

public final DataStorage dataStorage()

A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.

Returns:

A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.

domain

public final String domain()

The top-level internet domain name for which your application has administrative authority.

Returns:

The top-level internet domain name for which your application has administrative authority.

id

public final String id()

The unique ID of this app monitor.

Returns:

The unique ID of this app monitor.

lastModified

public final String lastModified()

The date and time of the most recent changes to this app monitor's configuration.

Returns:

The date and time of the most recent changes to this app monitor's configuration.

name

public final String name()

The name of the app monitor.

Returns:

The name of the app monitor.

state

public final StateEnum state()

The current state of the app monitor.

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

Returns:

The current state of the app monitor.

See Also:

StateEnum

stateAsString

public final String stateAsString()

The current state of the app monitor.

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

Returns:

The current state of the app monitor.

See Also:

StateEnum

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

The list of tag keys and values associated with this app monitor.

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 hasTags() method.

Returns:

The list of tag keys and values associated with this app monitor.

toBuilder

public AppMonitor.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AppMonitor.Builder,AppMonitor>

builder

public static AppMonitor.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo