software.amazon.awssdk.services.internetmonitor.model

Class GetMonitorResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.internetmonitor.model.InternetMonitorResponse

software.amazon.awssdk.services.internetmonitor.model.GetMonitorResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMonitorResponse.Builder,GetMonitorResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetMonitorResponse
extends InternetMonitorResponse
implements ToCopyableBuilder<GetMonitorResponse.Builder,GetMonitorResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetMonitorResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetMonitorResponse.Builder	builder()
Instant	createdAt() The time when the monitor was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResources() For responses, this returns true if the service returned a value for the Resources property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
InternetMeasurementsLogDelivery	internetMeasurementsLogDelivery() Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.
Integer	maxCityNetworksToMonitor() The maximum number of city-networks to monitor for your resources.
Instant	modifiedAt() The last time that the monitor was modified.
String	monitorArn() The Amazon Resource Name (ARN) of the monitor.
String	monitorName() The name of the monitor.
MonitorProcessingStatusCode	processingStatus() The health of the data processing for the monitor.
String	processingStatusAsString() The health of the data processing for the monitor.
String	processingStatusInfo() Additional information about the health of the data processing for the monitor.
List<String>	resources() The resources that have been added for the monitor.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMonitorResponse.Builder>	serializableBuilderClass()
MonitorConfigState	status() The status of the monitor.
String	statusAsString() The status of the monitor.
Map<String,String>	tags() The tags that have been added to monitor.
GetMonitorResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	trafficPercentageToMonitor() The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

Methods inherited from class software.amazon.awssdk.services.internetmonitor.model.InternetMonitorResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

monitorName

public final String monitorName()

The name of the monitor.

Returns:

The name of the monitor.

monitorArn

public final String monitorArn()

The Amazon Resource Name (ARN) of the monitor.

Returns:

The Amazon Resource Name (ARN) of the monitor.

hasResources

public final boolean hasResources()

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

resources

public final List<String> resources()

The resources that have been added for the monitor. Resources are listed by their Amazon Resource Names (ARNs).

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

Returns:

The resources that have been added for the monitor. Resources are listed by their Amazon Resource Names (ARNs).

status

public final MonitorConfigState status()

The status of the monitor.

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

Returns:

The status of the monitor.

See Also:

MonitorConfigState

statusAsString

public final String statusAsString()

The status of the monitor.

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

Returns:

The status of the monitor.

See Also:

MonitorConfigState

createdAt

public final Instant createdAt()

The time when the monitor was created.

Returns:

The time when the monitor was created.

modifiedAt

public final Instant modifiedAt()

The last time that the monitor was modified.

Returns:

The last time that the monitor was modified.

processingStatus

public final MonitorProcessingStatusCode processingStatus()

The health of the data processing for the monitor.

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

Returns:

The health of the data processing for the monitor.

See Also:

MonitorProcessingStatusCode

processingStatusAsString

public final String processingStatusAsString()

The health of the data processing for the monitor.

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

Returns:

The health of the data processing for the monitor.

See Also:

MonitorProcessingStatusCode

processingStatusInfo

public final String processingStatusInfo()

Additional information about the health of the data processing for the monitor.

Returns:

Additional information about the health of the data processing for the monitor.

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 tags that have been added to 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 tags that have been added to monitor.

maxCityNetworksToMonitor

public final Integer maxCityNetworksToMonitor()

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps control billing costs.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

Returns:

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps control billing costs.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

internetMeasurementsLogDelivery

public final InternetMeasurementsLogDelivery internetMeasurementsLogDelivery()

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

Returns:

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

trafficPercentageToMonitor

public final Integer trafficPercentageToMonitor()

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

Returns:

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

toBuilder

public GetMonitorResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetMonitorResponse.Builder,GetMonitorResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetMonitorResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo