Class UpdateProbeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.networkmonitor.model.NetworkMonitorRequest
software.amazon.awssdk.services.networkmonitor.model.UpdateProbeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateProbeRequest.Builder,UpdateProbeRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateProbeRequest extends NetworkMonitorRequest implements ToCopyableBuilder<UpdateProbeRequest.Builder,UpdateProbeRequest>

  • Method Details

    • monitorName

      public final String monitorName()

      The name of the monitor that the probe was updated for.

      Returns:
      The name of the monitor that the probe was updated for.

    • probeId

      public final String probeId()

      The ID of the probe to update.

      Returns:
      The ID of the probe to update.

    • state

      public final ProbeState state()

      The state of the probe update.

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

      Returns:
      The state of the probe update.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the probe update.

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

      Returns:
      The state of the probe update.
      See Also:

    • destination

      public final String destination()

      The updated IP address for the probe destination. This must be either an IPv4 or IPv6 address.

      Returns:
      The updated IP address for the probe destination. This must be either an IPv4 or IPv6 address.

    • destinationPort

      public final Integer destinationPort()

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

      Returns:
      The updated port for the probe 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 updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.

      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 updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.

      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 updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
      See Also:

    • packetSize

      public final Integer packetSize()

      he updated packets size for network traffic between the source and destination. This must be a number between 56 and 8500.

      Returns:
      he updated packets size for network traffic between the source and destination. This must be a number between 56 and 8500.

    • toBuilder

      public UpdateProbeRequest.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<UpdateProbeRequest.Builder,UpdateProbeRequest>
      Specified by:
      toBuilder in class NetworkMonitorRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateProbeRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.