RouteAnalysis (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkmanager.model.RouteAnalysis

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RouteAnalysis
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a route analysis.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RouteAnalysis()

Constructors
Constructor and Description
`RouteAnalysis()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RouteAnalysis`	`clone()`
`boolean`	`equals(Object obj)`
`RouteAnalysisEndpointOptions`	`getDestination()` The destination.
`RouteAnalysisPath`	`getForwardPath()` The forward path.
`String`	`getGlobalNetworkId()` The ID of the global network.
`Boolean`	`getIncludeReturnPath()` Indicates whether to analyze the return path.
`String`	`getOwnerAccountId()` The ID of the AWS account that created the route analysis.
`RouteAnalysisPath`	`getReturnPath()` The return path.
`String`	`getRouteAnalysisId()` The ID of the route analysis.
`RouteAnalysisEndpointOptions`	`getSource()` The source.
`Date`	`getStartTimestamp()` The time that the analysis started.
`String`	`getStatus()` The status of the route analysis.
`Boolean`	`getUseMiddleboxes()` Indicates whether to include the location of middlebox appliances in the route analysis.
`int`	`hashCode()`
`Boolean`	`isIncludeReturnPath()` Indicates whether to analyze the return path.
`Boolean`	`isUseMiddleboxes()` Indicates whether to include the location of middlebox appliances in the route analysis.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDestination(RouteAnalysisEndpointOptions destination)` The destination.
`void`	`setForwardPath(RouteAnalysisPath forwardPath)` The forward path.
`void`	`setGlobalNetworkId(String globalNetworkId)` The ID of the global network.
`void`	`setIncludeReturnPath(Boolean includeReturnPath)` Indicates whether to analyze the return path.
`void`	`setOwnerAccountId(String ownerAccountId)` The ID of the AWS account that created the route analysis.
`void`	`setReturnPath(RouteAnalysisPath returnPath)` The return path.
`void`	`setRouteAnalysisId(String routeAnalysisId)` The ID of the route analysis.
`void`	`setSource(RouteAnalysisEndpointOptions source)` The source.
`void`	`setStartTimestamp(Date startTimestamp)` The time that the analysis started.
`void`	`setStatus(String status)` The status of the route analysis.
`void`	`setUseMiddleboxes(Boolean useMiddleboxes)` Indicates whether to include the location of middlebox appliances in the route analysis.
`String`	`toString()` Returns a string representation of this object.
`RouteAnalysis`	`withDestination(RouteAnalysisEndpointOptions destination)` The destination.
`RouteAnalysis`	`withForwardPath(RouteAnalysisPath forwardPath)` The forward path.
`RouteAnalysis`	`withGlobalNetworkId(String globalNetworkId)` The ID of the global network.
`RouteAnalysis`	`withIncludeReturnPath(Boolean includeReturnPath)` Indicates whether to analyze the return path.
`RouteAnalysis`	`withOwnerAccountId(String ownerAccountId)` The ID of the AWS account that created the route analysis.
`RouteAnalysis`	`withReturnPath(RouteAnalysisPath returnPath)` The return path.
`RouteAnalysis`	`withRouteAnalysisId(String routeAnalysisId)` The ID of the route analysis.
`RouteAnalysis`	`withSource(RouteAnalysisEndpointOptions source)` The source.
`RouteAnalysis`	`withStartTimestamp(Date startTimestamp)` The time that the analysis started.
`RouteAnalysis`	`withStatus(RouteAnalysisStatus status)` The status of the route analysis.
`RouteAnalysis`	`withStatus(String status)` The status of the route analysis.
`RouteAnalysis`	`withUseMiddleboxes(Boolean useMiddleboxes)` Indicates whether to include the location of middlebox appliances in the route analysis.

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

- Constructor Detail
  - RouteAnalysis
```
public RouteAnalysis()
```
- Method Detail
  - setGlobalNetworkId
```
public void setGlobalNetworkId(String globalNetworkId)
```
    The ID of the global network.
    
    Parameters:
    
    globalNetworkId - The ID of the global network.
  - getGlobalNetworkId
```
public String getGlobalNetworkId()
```
    The ID of the global network.
    
    Returns:
    
    The ID of the global network.
  - withGlobalNetworkId
```
public RouteAnalysis withGlobalNetworkId(String globalNetworkId)
```
    The ID of the global network.
    
    Parameters:
    
    globalNetworkId - The ID of the global network.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwnerAccountId
```
public void setOwnerAccountId(String ownerAccountId)
```
    The ID of the AWS account that created the route analysis.
    
    Parameters:
    
    ownerAccountId - The ID of the AWS account that created the route analysis.
  - getOwnerAccountId
```
public String getOwnerAccountId()
```
    The ID of the AWS account that created the route analysis.
    
    Returns:
    
    The ID of the AWS account that created the route analysis.
  - withOwnerAccountId
```
public RouteAnalysis withOwnerAccountId(String ownerAccountId)
```
    The ID of the AWS account that created the route analysis.
    
    Parameters:
    
    ownerAccountId - The ID of the AWS account that created the route analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRouteAnalysisId
```
public void setRouteAnalysisId(String routeAnalysisId)
```
    The ID of the route analysis.
    
    Parameters:
    
    routeAnalysisId - The ID of the route analysis.
  - getRouteAnalysisId
```
public String getRouteAnalysisId()
```
    The ID of the route analysis.
    
    Returns:
    
    The ID of the route analysis.
  - withRouteAnalysisId
```
public RouteAnalysis withRouteAnalysisId(String routeAnalysisId)
```
    The ID of the route analysis.
    
    Parameters:
    
    routeAnalysisId - The ID of the route analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTimestamp
```
public void setStartTimestamp(Date startTimestamp)
```
    The time that the analysis started.
    
    Parameters:
    
    startTimestamp - The time that the analysis started.
  - getStartTimestamp
```
public Date getStartTimestamp()
```
    The time that the analysis started.
    
    Returns:
    
    The time that the analysis started.
  - withStartTimestamp
```
public RouteAnalysis withStartTimestamp(Date startTimestamp)
```
    The time that the analysis started.
    
    Parameters:
    
    startTimestamp - The time that the analysis started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the route analysis.
    
    Parameters:
    
    status - The status of the route analysis.
    
    See Also:
    
    RouteAnalysisStatus
  - getStatus
```
public String getStatus()
```
    The status of the route analysis.
    
    Returns:
    
    The status of the route analysis.
    
    See Also:
    
    RouteAnalysisStatus
  - withStatus
```
public RouteAnalysis withStatus(String status)
```
    The status of the route analysis.
    
    Parameters:
    
    status - The status of the route analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RouteAnalysisStatus
  - withStatus
```
public RouteAnalysis withStatus(RouteAnalysisStatus status)
```
    The status of the route analysis.
    
    Parameters:
    
    status - The status of the route analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RouteAnalysisStatus
  - setSource
```
public void setSource(RouteAnalysisEndpointOptions source)
```
    The source.
    
    Parameters:
    
    source - The source.
  - getSource
```
public RouteAnalysisEndpointOptions getSource()
```
    The source.
    
    Returns:
    
    The source.
  - withSource
```
public RouteAnalysis withSource(RouteAnalysisEndpointOptions source)
```
    The source.
    
    Parameters:
    
    source - The source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestination
```
public void setDestination(RouteAnalysisEndpointOptions destination)
```
    The destination.
    
    Parameters:
    
    destination - The destination.
  - getDestination
```
public RouteAnalysisEndpointOptions getDestination()
```
    The destination.
    
    Returns:
    
    The destination.
  - withDestination
```
public RouteAnalysis withDestination(RouteAnalysisEndpointOptions destination)
```
    The destination.
    
    Parameters:
    
    destination - The destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIncludeReturnPath
```
public void setIncludeReturnPath(Boolean includeReturnPath)
```
    Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
    
    Parameters:
    
    includeReturnPath - Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
  - getIncludeReturnPath
```
public Boolean getIncludeReturnPath()
```
    Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
    
    Returns:
    
    Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
  - withIncludeReturnPath
```
public RouteAnalysis withIncludeReturnPath(Boolean includeReturnPath)
```
    Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
    
    Parameters:
    
    includeReturnPath - Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeReturnPath
```
public Boolean isIncludeReturnPath()
```
    Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
    
    Returns:
    
    Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
  - setUseMiddleboxes
```
public void setUseMiddleboxes(Boolean useMiddleboxes)
```
    Indicates whether to include the location of middlebox appliances in the route analysis.
    
    Parameters:
    
    useMiddleboxes - Indicates whether to include the location of middlebox appliances in the route analysis.
  - getUseMiddleboxes
```
public Boolean getUseMiddleboxes()
```
    Indicates whether to include the location of middlebox appliances in the route analysis.
    
    Returns:
    
    Indicates whether to include the location of middlebox appliances in the route analysis.
  - withUseMiddleboxes
```
public RouteAnalysis withUseMiddleboxes(Boolean useMiddleboxes)
```
    Indicates whether to include the location of middlebox appliances in the route analysis.
    
    Parameters:
    
    useMiddleboxes - Indicates whether to include the location of middlebox appliances in the route analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseMiddleboxes
```
public Boolean isUseMiddleboxes()
```
    Indicates whether to include the location of middlebox appliances in the route analysis.
    
    Returns:
    
    Indicates whether to include the location of middlebox appliances in the route analysis.
  - setForwardPath
```
public void setForwardPath(RouteAnalysisPath forwardPath)
```
    The forward path.
    
    Parameters:
    
    forwardPath - The forward path.
  - getForwardPath
```
public RouteAnalysisPath getForwardPath()
```
    The forward path.
    
    Returns:
    
    The forward path.
  - withForwardPath
```
public RouteAnalysis withForwardPath(RouteAnalysisPath forwardPath)
```
    The forward path.
    
    Parameters:
    
    forwardPath - The forward path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReturnPath
```
public void setReturnPath(RouteAnalysisPath returnPath)
```
    The return path.
    
    Parameters:
    
    returnPath - The return path.
  - getReturnPath
```
public RouteAnalysisPath getReturnPath()
```
    The return path.
    
    Returns:
    
    The return path.
  - withReturnPath
```
public RouteAnalysis withReturnPath(RouteAnalysisPath returnPath)
```
    The return path.
    
    Parameters:
    
    returnPath - The return path.
    
    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 RouteAnalysis clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class RouteAnalysis

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RouteAnalysis

Method Detail

setGlobalNetworkId

getGlobalNetworkId

withGlobalNetworkId

setOwnerAccountId

getOwnerAccountId

withOwnerAccountId

setRouteAnalysisId

getRouteAnalysisId

withRouteAnalysisId

setStartTimestamp

getStartTimestamp

withStartTimestamp

setStatus

getStatus

withStatus

withStatus

setSource

getSource

withSource

setDestination

getDestination

withDestination

setIncludeReturnPath

getIncludeReturnPath

withIncludeReturnPath

isIncludeReturnPath

setUseMiddleboxes

getUseMiddleboxes

withUseMiddleboxes

isUseMiddleboxes

setForwardPath

getForwardPath

withForwardPath

setReturnPath

getReturnPath

withReturnPath

toString

equals

hashCode

clone

marshall