Class NetworkImpairment

java.lang.Object
software.amazon.awssdk.services.internetmonitor.model.NetworkImpairment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NetworkImpairment.Builder,NetworkImpairment>
@Generated("software.amazon.awssdk:codegen") public final class NetworkImpairment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NetworkImpairment.Builder,NetworkImpairment>

Information about the network impairment for a specific network measured by Amazon CloudWatch Internet Monitor.

See Also:

  • Method Details

    • hasNetworks

      public final boolean hasNetworks()
      For responses, this returns true if the service returned a value for the Networks 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.

    • networks

      public final List<Network> networks()

      The networks that could be impacted by a network impairment 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 hasNetworks() method.

      Returns:
      The networks that could be impacted by a network impairment event.

    • hasAsPath

      public final boolean hasAsPath()
      For responses, this returns true if the service returned a value for the AsPath 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.

    • asPath

      public final List<Network> asPath()

      The combination of the Autonomous System Number (ASN) of the network and the name of the network.

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

      Returns:
      The combination of the Autonomous System Number (ASN) of the network and the name of the network.

    • networkEventType

      public final TriangulationEventType networkEventType()

      The type of network impairment.

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

      Returns:
      The type of network impairment.
      See Also:

    • networkEventTypeAsString

      public final String networkEventTypeAsString()

      The type of network impairment.

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

      Returns:
      The type of network impairment.
      See Also:

    • toBuilder

      public NetworkImpairment.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NetworkImpairment.Builder,NetworkImpairment>
      Returns:
      a builder for type T

    • builder

      public static NetworkImpairment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NetworkImpairment.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.