Probe (AWS Java SDK for Amazon CloudWatch Network Monitor 1.12.786 API)

java.lang.Object
- com.amazonaws.services.networkmonitor.model.Probe

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Probe
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes information about a network monitor probe.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Probe()

Constructors
Constructor and Description
`Probe()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Probe`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Probe`	`clearTagsEntries()` Removes all the entries added into Tags.
`Probe`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAddressFamily()` The IPv4 or IPv6 address for the probe.
`Date`	`getCreatedAt()` The time and date the probe was created.
`String`	`getDestination()` The destination for the probe.
`Integer`	`getDestinationPort()` The destination port for the probe.
`Date`	`getModifiedAt()` The time and date that the probe was last modified.
`Integer`	`getPacketSize()` The size of the packets traveling between the `source` and `destination`.
`String`	`getProbeArn()` The ARN of the probe.
`String`	`getProbeId()` The ID of the probe.
`String`	`getProtocol()` The network protocol for the destination.
`String`	`getSourceArn()` The ARN of the probe source subnet.
`String`	`getState()` The state of the probe.
`Map<String,String>`	`getTags()` The list of key-value pairs created and assigned to the probe.
`String`	`getVpcId()` The ID of the source VPC subnet.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAddressFamily(String addressFamily)` The IPv4 or IPv6 address for the probe.
`void`	`setCreatedAt(Date createdAt)` The time and date the probe was created.
`void`	`setDestination(String destination)` The destination for the probe.
`void`	`setDestinationPort(Integer destinationPort)` The destination port for the probe.
`void`	`setModifiedAt(Date modifiedAt)` The time and date that the probe was last modified.
`void`	`setPacketSize(Integer packetSize)` The size of the packets traveling between the `source` and `destination`.
`void`	`setProbeArn(String probeArn)` The ARN of the probe.
`void`	`setProbeId(String probeId)` The ID of the probe.
`void`	`setProtocol(String protocol)` The network protocol for the destination.
`void`	`setSourceArn(String sourceArn)` The ARN of the probe source subnet.
`void`	`setState(String state)` The state of the probe.
`void`	`setTags(Map<String,String> tags)` The list of key-value pairs created and assigned to the probe.
`void`	`setVpcId(String vpcId)` The ID of the source VPC subnet.
`String`	`toString()` Returns a string representation of this object.
`Probe`	`withAddressFamily(AddressFamily addressFamily)` The IPv4 or IPv6 address for the probe.
`Probe`	`withAddressFamily(String addressFamily)` The IPv4 or IPv6 address for the probe.
`Probe`	`withCreatedAt(Date createdAt)` The time and date the probe was created.
`Probe`	`withDestination(String destination)` The destination for the probe.
`Probe`	`withDestinationPort(Integer destinationPort)` The destination port for the probe.
`Probe`	`withModifiedAt(Date modifiedAt)` The time and date that the probe was last modified.
`Probe`	`withPacketSize(Integer packetSize)` The size of the packets traveling between the `source` and `destination`.
`Probe`	`withProbeArn(String probeArn)` The ARN of the probe.
`Probe`	`withProbeId(String probeId)` The ID of the probe.
`Probe`	`withProtocol(Protocol protocol)` The network protocol for the destination.
`Probe`	`withProtocol(String protocol)` The network protocol for the destination.
`Probe`	`withSourceArn(String sourceArn)` The ARN of the probe source subnet.
`Probe`	`withState(ProbeState state)` The state of the probe.
`Probe`	`withState(String state)` The state of the probe.
`Probe`	`withTags(Map<String,String> tags)` The list of key-value pairs created and assigned to the probe.
`Probe`	`withVpcId(String vpcId)` The ID of the source VPC subnet.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Probe
```
public Probe()
```
- Method Detail
  - setProbeId
```
public void setProbeId(String probeId)
```
    The ID of the probe.
    
    Parameters:
    
    probeId - The ID of the probe.
  - getProbeId
```
public String getProbeId()
```
    The ID of the probe.
    
    Returns:
    
    The ID of the probe.
  - withProbeId
```
public Probe withProbeId(String probeId)
```
    The ID of the probe.
    
    Parameters:
    
    probeId - The ID of the probe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProbeArn
```
public void setProbeArn(String probeArn)
```
    The ARN of the probe.
    
    Parameters:
    
    probeArn - The ARN of the probe.
  - getProbeArn
```
public String getProbeArn()
```
    The ARN of the probe.
    
    Returns:
    
    The ARN of the probe.
  - withProbeArn
```
public Probe withProbeArn(String probeArn)
```
    The ARN of the probe.
    
    Parameters:
    
    probeArn - The ARN of the probe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceArn
```
public void setSourceArn(String sourceArn)
```
    The ARN of the probe source subnet.
    
    Parameters:
    
    sourceArn - The ARN of the probe source subnet.
  - getSourceArn
```
public String getSourceArn()
```
    The ARN of the probe source subnet.
    
    Returns:
    
    The ARN of the probe source subnet.
  - withSourceArn
```
public Probe withSourceArn(String sourceArn)
```
    The ARN of the probe source subnet.
    
    Parameters:
    
    sourceArn - The ARN of the probe source subnet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestination
```
public void setDestination(String destination)
```
    The destination for the probe. This should be either an IPV4 or IPV6.
    
    Parameters:
    
    destination - The destination for the probe. This should be either an IPV4 or IPV6.
  - getDestination
```
public String getDestination()
```
    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.
  - withDestination
```
public Probe withDestination(String destination)
```
    The destination for the probe. This should be either an IPV4 or IPV6.
    
    Parameters:
    
    destination - The destination for the probe. This should be either an IPV4 or IPV6.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationPort
```
public void setDestinationPort(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.
    
    Parameters:
    
    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.
  - getDestinationPort
```
public Integer getDestinationPort()
```
    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.
  - withDestinationPort
```
public Probe withDestinationPort(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocol
```
public void setProtocol(String protocol)
```
    The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
    
    Parameters:
    
    protocol - 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
  - getProtocol
```
public String getProtocol()
```
    The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
    
    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
  - withProtocol
```
public Probe withProtocol(String protocol)
```
    The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
    
    Parameters:
    
    protocol - The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Protocol
  - withProtocol
```
public Probe withProtocol(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.
    
    Parameters:
    
    protocol - The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Protocol
  - setPacketSize
```
public void setPacketSize(Integer packetSize)
```
    The size of the packets traveling between the source and destination. This must be a number between 56 and
    
    Parameters:
    
    packetSize - The size of the packets traveling between the source and destination. This must be a number between 56 and
  - getPacketSize
```
public Integer getPacketSize()
```
    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
  - withPacketSize
```
public Probe withPacketSize(Integer packetSize)
```
    The size of the packets traveling between the source and destination. This must be a number between 56 and
    
    Parameters:
    
    packetSize - The size of the packets traveling between the source and destination. This must be a number between 56 and
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAddressFamily
```
public void setAddressFamily(String addressFamily)
```
    The IPv4 or IPv6 address for the probe.
    
    Parameters:
    
    addressFamily - The IPv4 or IPv6 address for the probe.
    
    See Also:
    
    AddressFamily
  - getAddressFamily
```
public String getAddressFamily()
```
    The IPv4 or IPv6 address for the probe.
    
    Returns:
    
    The IPv4 or IPv6 address for the probe.
    
    See Also:
    
    AddressFamily
  - withAddressFamily
```
public Probe withAddressFamily(String addressFamily)
```
    The IPv4 or IPv6 address for the probe.
    
    Parameters:
    
    addressFamily - The IPv4 or IPv6 address for the probe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AddressFamily
  - withAddressFamily
```
public Probe withAddressFamily(AddressFamily addressFamily)
```
    The IPv4 or IPv6 address for the probe.
    
    Parameters:
    
    addressFamily - The IPv4 or IPv6 address for the probe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AddressFamily
  - setVpcId
```
public void setVpcId(String vpcId)
```
    The ID of the source VPC subnet.
    
    Parameters:
    
    vpcId - The ID of the source VPC subnet.
  - getVpcId
```
public String getVpcId()
```
    The ID of the source VPC subnet.
    
    Returns:
    
    The ID of the source VPC subnet.
  - withVpcId
```
public Probe withVpcId(String vpcId)
```
    The ID of the source VPC subnet.
    
    Parameters:
    
    vpcId - The ID of the source VPC subnet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of the probe.
    
    Parameters:
    
    state - The state of the probe.
    
    See Also:
    
    ProbeState
  - getState
```
public String getState()
```
    The state of the probe.
    
    Returns:
    
    The state of the probe.
    
    See Also:
    
    ProbeState
  - withState
```
public Probe withState(String state)
```
    The state of the probe.
    
    Parameters:
    
    state - The state of the probe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProbeState
  - withState
```
public Probe withState(ProbeState state)
```
    The state of the probe.
    
    Parameters:
    
    state - The state of the probe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProbeState
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time and date the probe was created.
    
    Parameters:
    
    createdAt - The time and date the probe was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time and date the probe was created.
    
    Returns:
    
    The time and date the probe was created.
  - withCreatedAt
```
public Probe withCreatedAt(Date createdAt)
```
    The time and date the probe was created.
    
    Parameters:
    
    createdAt - The time and date the probe was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModifiedAt
```
public void setModifiedAt(Date modifiedAt)
```
    The time and date that the probe was last modified.
    
    Parameters:
    
    modifiedAt - The time and date that the probe was last modified.
  - getModifiedAt
```
public Date getModifiedAt()
```
    The time and date that the probe was last modified.
    
    Returns:
    
    The time and date that the probe was last modified.
  - withModifiedAt
```
public Probe withModifiedAt(Date modifiedAt)
```
    The time and date that the probe was last modified.
    
    Parameters:
    
    modifiedAt - The time and date that the probe was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The list of key-value pairs created and assigned to the probe.
    
    Returns:
    
    The list of key-value pairs created and assigned to the probe.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The list of key-value pairs created and assigned to the probe.
    
    Parameters:
    
    tags - The list of key-value pairs created and assigned to the probe.
  - withTags
```
public Probe withTags(Map<String,String> tags)
```
    The list of key-value pairs created and assigned to the probe.
    
    Parameters:
    
    tags - The list of key-value pairs created and assigned to the probe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Probe addTagsEntry(String key,
                          String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Probe clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Probe clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Probe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Probe

Method Detail

setProbeId

getProbeId

withProbeId

setProbeArn

getProbeArn

withProbeArn

setSourceArn

getSourceArn

withSourceArn

setDestination

getDestination

withDestination

setDestinationPort

getDestinationPort

withDestinationPort

setProtocol

getProtocol

withProtocol

withProtocol

setPacketSize

getPacketSize

withPacketSize

setAddressFamily

getAddressFamily

withAddressFamily

withAddressFamily

setVpcId

getVpcId

withVpcId

setState

getState

withState

withState

setCreatedAt

getCreatedAt

withCreatedAt

setModifiedAt

getModifiedAt

withModifiedAt

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall