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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProbeInput.Builder

Method Summary

Modifier and Type	Method	Description
static ProbeInput.Builder	builder()
String	destination()	The destination IP address.
Integer	destinationPort()	The port associated with the destination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Integer	packetSize()	The size of the packets sent between the source and destination.
Protocol	protocol()	The protocol used for the network traffic between the source and destination.
String	protocolAsString()	The protocol used for the network traffic between the source and destination.
List<SdkField<?>>	sdkFields()
static Class<? extends ProbeInput.Builder>	serializableBuilderClass()
String	sourceArn()	The ARN of the subnet.
Map<String,String>	tags()	The list of key-value pairs created and assigned to the monitor.
ProbeInput.Builder	toBuilder()
String	toString()	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

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:

Protocol

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:

Protocol

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ProbeInput.Builder,ProbeInput>

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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo