Package software.amazon.awssdk.services.networkmonitor.model

Class ProbeInput

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

Defines a probe when creating a probe or monitor.

See Also:

  • Method Details

    • sourceArn

      public final String sourceArn()

      The ARN of the subnet.

      Returns:
      The ARN of the subnet.

    • destination

      public final String destination()

      The destination IP address. This must be either IPV4 or IPV6.

      Returns:
      The destination IP address. This must be either IPV4 or IPV6.

    • destinationPort

      public final Integer destinationPort()

      The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.

      Returns:
      The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.

    • protocol

      public final Protocol protocol()

      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

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

      Returns:
      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

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

      Returns:
      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.
      See Also:

    • packetSize

      public final Integer packetSize()

      The size of the packets sent between the source and destination. This must be a number between 56 and 8500.

      Returns:
      The size of the packets sent between the source and destination. This must be a number between 56 and 8500.

    • 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 key-value pairs created and assigned to the 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 key-value pairs created and assigned to the monitor.

    • toBuilder

      public ProbeInput.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<ProbeInput.Builder,ProbeInput>
      Returns:
      a builder for type T

    • builder

      public static ProbeInput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ProbeInput.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.