java.lang.Object
- software.amazon.awssdk.services.networkmonitor.model.Probe

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Probe.Builder,Probe>

@Generated("software.amazon.awssdk:codegen")
public final class Probe
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Probe.Builder,Probe>

Describes information about a network monitor probe.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Probe.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AddressFamily`	`addressFamily()`	The IPv4 or IPv6 address for the probe.
`String`	`addressFamilyAsString()`	The IPv4 or IPv6 address for the probe.
`static Probe.Builder`	`builder()`
`Instant`	`createdAt()`	The time and date the probe was created.
`String`	`destination()`	The destination for the probe.
`Integer`	`destinationPort()`	The destination port for the probe.
`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.
`Instant`	`modifiedAt()`	The time and date that the probe was last modified.
`Integer`	`packetSize()`	The size of the packets traveling between the `source` and `destination`.
`String`	`probeArn()`	The ARN of the probe.
`String`	`probeId()`	The ID of the probe.
`Protocol`	`protocol()`	The network protocol for the destination.
`String`	`protocolAsString()`	The network protocol for the destination.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Probe.Builder>`	`serializableBuilderClass()`
`String`	`sourceArn()`	The ARN of the probe source subnet.
`ProbeState`	`state()`	The state of the probe.
`String`	`stateAsString()`	The state of the probe.
`Map<String,String>`	`tags()`	The list of key-value pairs created and assigned to the probe.
`Probe.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`vpcId()`	The ID of the source VPC subnet.

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
  - probeId
```
public final String probeId()
```
    The ID of the probe.
    
    Returns:
    
    The ID of the probe.
  - probeArn
```
public final String probeArn()
```
    The ARN of the probe.
    
    Returns:
    
    The ARN of the probe.
  - sourceArn
```
public final String sourceArn()
```
    The ARN of the probe source subnet.
    
    Returns:
    
    The ARN of the probe source subnet.
  - destination
```
public final String destination()
```
    The destination for the probe. This should be either an IPV4 or IPV6.
    
    Returns:
    
    The destination for the probe. This should be either an IPV4 or IPV6.
  - destinationPort
```
public final Integer destinationPort()
```
    The destination port for the probe. This is required only if the protocol is TCP and must be a number between 1 and 65536.
    
    Returns:
    
    The destination port for the probe. This is required only if the protocol is TCP and must be a number between 1 and 65536.
  - protocol
```
public final Protocol protocol()
```
    The 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 network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
    
    See Also:
    
    Protocol
  - protocolAsString
```
public final String protocolAsString()
```
    The 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 network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
    
    See Also:
    
    Protocol
  - packetSize
```
public final Integer packetSize()
```
    The size of the packets traveling between the source and destination. This must be a number between 56 and
    
    Returns:
    
    The size of the packets traveling between the source and destination. This must be a number between 56 and
  - addressFamily
```
public final AddressFamily addressFamily()
```
    The IPv4 or IPv6 address for the probe.
    
    If the service returns an enum value that is not available in the current SDK version, addressFamily will return AddressFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from addressFamilyAsString().
    
    Returns:
    
    The IPv4 or IPv6 address for the probe.
    
    See Also:
    
    AddressFamily
  - addressFamilyAsString
```
public final String addressFamilyAsString()
```
    The IPv4 or IPv6 address for the probe.
    
    If the service returns an enum value that is not available in the current SDK version, addressFamily will return AddressFamily.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from addressFamilyAsString().
    
    Returns:
    
    The IPv4 or IPv6 address for the probe.
    
    See Also:
    
    AddressFamily
  - vpcId
```
public final String vpcId()
```
    The ID of the source VPC subnet.
    
    Returns:
    
    The ID of the source VPC subnet.
  - state
```
public final ProbeState state()
```
    The state of the probe.
    
    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.
    
    See Also:
    
    ProbeState
  - stateAsString
```
public final String stateAsString()
```
    The state of the probe.
    
    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.
    
    See Also:
    
    ProbeState
  - createdAt
```
public final Instant createdAt()
```
    The time and date the probe was created.
    
    Returns:
    
    The time and date the probe was created.
  - modifiedAt
```
public final Instant modifiedAt()
```
    The time and date that the probe was last modified.
    
    Returns:
    
    The time and date that the probe was last modified.
  - 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 probe.
    
    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 probe.
  - toBuilder
```
public Probe.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Probe.Builder,Probe>
  - builder
```
public static Probe.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Probe.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

Class Probe

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

probeId

probeArn

sourceArn

destination

destinationPort

protocol

protocolAsString

packetSize

addressFamily

addressFamilyAsString

vpcId

state

stateAsString

createdAt

modifiedAt

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields