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

Class GetProbeResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.networkmonitor.model.NetworkMonitorResponse

software.amazon.awssdk.services.networkmonitor.model.GetProbeResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetProbeResponse.Builder,GetProbeResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetProbeResponse
extends NetworkMonitorResponse
implements ToCopyableBuilder<GetProbeResponse.Builder,GetProbeResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetProbeResponse.Builder

Method Summary

Modifier and Type	Method	Description
AddressFamily	addressFamily()	Indicates whether the IP address is IPV4 or IPV6.
String	addressFamilyAsString()	Indicates whether the IP address is IPV4 or IPV6.
static GetProbeResponse.Builder	builder()
Instant	createdAt()	The time and date that the probe was created.
String	destination()	The destination IP address for the monitor.
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.
Instant	modifiedAt()	The time and date that the probe was last modified.
Integer	packetSize()	The size of the packets sent between the source and destination.
String	probeArn()	The ARN of the probe.
String	probeId()	The ID of the probe for which details are returned.
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 GetProbeResponse.Builder>	serializableBuilderClass()
String	sourceArn()	The ARN of the probe.
ProbeState	state()	The state of the probe.
String	stateAsString()	The state of the probe.
Map<String,String>	tags()	The list of key-value pairs assigned to the probe.
GetProbeResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vpcId()	The ID of the source VPC or subnet.

Methods inherited from class software.amazon.awssdk.services.networkmonitor.model.NetworkMonitorResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 for which details are returned.

Returns:

The ID of the probe for which details are returned.

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.

Returns:

The ARN of the probe.

destination

public final String destination()

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

Returns:

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

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.

addressFamily

public final AddressFamily addressFamily()

Indicates whether the IP address is IPV4 or IPV6.

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:

Indicates whether the IP address is IPV4 or IPV6.

See Also:

AddressFamily

addressFamilyAsString

public final String addressFamilyAsString()

Indicates whether the IP address is IPV4 or IPV6.

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:

Indicates whether the IP address is IPV4 or IPV6.

See Also:

AddressFamily

vpcId

public final String vpcId()

The ID of the source VPC or subnet.

Returns:

The ID of the source VPC or 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 that the probe was created.

Returns:

The time and date that 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 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 assigned to the probe.

toBuilder

public GetProbeResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetProbeResponse.Builder,GetProbeResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetProbeResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo