Class ImpactedLocation
- java.lang.Object
-
- software.amazon.awssdk.services.internetmonitor.model.ImpactedLocation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ImpactedLocation.Builder,ImpactedLocation>
@Generated("software.amazon.awssdk:codegen") public final class ImpactedLocation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ImpactedLocation.Builder,ImpactedLocation>
Information about a location impacted by a health event in Amazon CloudWatch Internet Monitor.
Geographic regions are hierarchically categorized into country, subdivision, metro and city geographic granularities. The geographic region is identified based on the IP address used at the client locations.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceImpactedLocation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringasName()The name of the internet service provider (ISP) or network (ASN).LongasNumber()The Autonomous System Number (ASN) of the network at an impacted location.static ImpactedLocation.Builderbuilder()NetworkImpairmentcausedBy()The cause of the impairment.Stringcity()The name of the city where the health event is located.Stringcountry()The name of the country where the health event is located.StringcountryCode()The country code where the health event is located.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasIpv4Prefixes()For responses, this returns true if the service returned a value for the Ipv4Prefixes property.InternetHealthinternetHealth()The calculated health at a specific location.List<String>ipv4Prefixes()The IPv4 prefixes at the client location that was impacted by the health event.Doublelatitude()The latitude where the health event is located.Doublelongitude()The longitude where the health event is located.Stringmetro()The metro area where the health event is located.List<SdkField<?>>sdkFields()static Class<? extends ImpactedLocation.Builder>serializableBuilderClass()StringserviceLocation()The service location where the health event is located.HealthEventStatusstatus()The status of the health event at an impacted location.StringstatusAsString()The status of the health event at an impacted location.Stringsubdivision()The subdivision location where the health event is located.StringsubdivisionCode()The subdivision code where the health event is located.ImpactedLocation.BuildertoBuilder()StringtoString()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
-
asName
public final String asName()
The name of the internet service provider (ISP) or network (ASN).
- Returns:
- The name of the internet service provider (ISP) or network (ASN).
-
asNumber
public final Long asNumber()
The Autonomous System Number (ASN) of the network at an impacted location.
- Returns:
- The Autonomous System Number (ASN) of the network at an impacted location.
-
country
public final String country()
The name of the country where the health event is located.
- Returns:
- The name of the country where the health event is located.
-
subdivision
public final String subdivision()
The subdivision location where the health event is located. The subdivision usually maps to states in most countries (including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
- Returns:
- The subdivision location where the health event is located. The subdivision usually maps to states in most countries (including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
-
metro
public final String metro()
The metro area where the health event is located.
Metro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary authority, council area, and so on.
- Returns:
- The metro area where the health event is located.
Metro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary authority, council area, and so on.
-
city
public final String city()
The name of the city where the health event is located.
- Returns:
- The name of the city where the health event is located.
-
latitude
public final Double latitude()
The latitude where the health event is located.
- Returns:
- The latitude where the health event is located.
-
longitude
public final Double longitude()
The longitude where the health event is located.
- Returns:
- The longitude where the health event is located.
-
countryCode
public final String countryCode()
The country code where the health event is located. The ISO 3166-2 codes for the country is provided, when available.
- Returns:
- The country code where the health event is located. The ISO 3166-2 codes for the country is provided, when available.
-
subdivisionCode
public final String subdivisionCode()
The subdivision code where the health event is located. The ISO 3166-2 codes for country subdivisions is provided, when available.
- Returns:
- The subdivision code where the health event is located. The ISO 3166-2 codes for country subdivisions is provided, when available.
-
serviceLocation
public final String serviceLocation()
The service location where the health event is located.
- Returns:
- The service location where the health event is located.
-
status
public final HealthEventStatus status()
The status of the health event at an impacted location.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnHealthEventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the health event at an impacted location.
- See Also:
HealthEventStatus
-
statusAsString
public final String statusAsString()
The status of the health event at an impacted location.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnHealthEventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the health event at an impacted location.
- See Also:
HealthEventStatus
-
causedBy
public final NetworkImpairment causedBy()
The cause of the impairment. There are two types of network impairments: Amazon Web Services network issues or internet issues. Internet issues are typically a problem with a network provider, like an internet service provider (ISP).
- Returns:
- The cause of the impairment. There are two types of network impairments: Amazon Web Services network issues or internet issues. Internet issues are typically a problem with a network provider, like an internet service provider (ISP).
-
internetHealth
public final InternetHealth internetHealth()
The calculated health at a specific location.
- Returns:
- The calculated health at a specific location.
-
hasIpv4Prefixes
public final boolean hasIpv4Prefixes()
For responses, this returns true if the service returned a value for the Ipv4Prefixes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
ipv4Prefixes
public final List<String> ipv4Prefixes()
The IPv4 prefixes at the client location that was impacted by the health event.
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
hasIpv4Prefixes()method.- Returns:
- The IPv4 prefixes at the client location that was impacted by the health event.
-
toBuilder
public ImpactedLocation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ImpactedLocation.Builder,ImpactedLocation>
-
builder
public static ImpactedLocation.Builder builder()
-
serializableBuilderClass
public static Class<? extends ImpactedLocation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-