com.amazonaws.services.networkmanager.model.RouteAnalysis Maven / Gradle / Ivy
Show all versions of aws-java-sdk-networkmanager Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.networkmanager.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes a route analysis.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RouteAnalysis implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ID of the global network.
*
*/
private String globalNetworkId;
/**
*
* The ID of the AWS account that created the route analysis.
*
*/
private String ownerAccountId;
/**
*
* The ID of the route analysis.
*
*/
private String routeAnalysisId;
/**
*
* The time that the analysis started.
*
*/
private java.util.Date startTimestamp;
/**
*
* The status of the route analysis.
*
*/
private String status;
/**
*
* The source.
*
*/
private RouteAnalysisEndpointOptions source;
/**
*
* The destination.
*
*/
private RouteAnalysisEndpointOptions destination;
/**
*
* Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does
* not succeed.
*
*/
private Boolean includeReturnPath;
/**
*
* Indicates whether to include the location of middlebox appliances in the route analysis.
*
*/
private Boolean useMiddleboxes;
/**
*
* The forward path.
*
*/
private RouteAnalysisPath forwardPath;
/**
*
* The return path.
*
*/
private RouteAnalysisPath returnPath;
/**
*
* The ID of the global network.
*
*
* @param globalNetworkId
* The ID of the global network.
*/
public void setGlobalNetworkId(String globalNetworkId) {
this.globalNetworkId = globalNetworkId;
}
/**
*
* The ID of the global network.
*
*
* @return The ID of the global network.
*/
public String getGlobalNetworkId() {
return this.globalNetworkId;
}
/**
*
* The ID of the global network.
*
*
* @param globalNetworkId
* The ID of the global network.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withGlobalNetworkId(String globalNetworkId) {
setGlobalNetworkId(globalNetworkId);
return this;
}
/**
*
* The ID of the AWS account that created the route analysis.
*
*
* @param ownerAccountId
* The ID of the AWS account that created the route analysis.
*/
public void setOwnerAccountId(String ownerAccountId) {
this.ownerAccountId = ownerAccountId;
}
/**
*
* The ID of the AWS account that created the route analysis.
*
*
* @return The ID of the AWS account that created the route analysis.
*/
public String getOwnerAccountId() {
return this.ownerAccountId;
}
/**
*
* The ID of the AWS account that created the route analysis.
*
*
* @param ownerAccountId
* The ID of the AWS account that created the route analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withOwnerAccountId(String ownerAccountId) {
setOwnerAccountId(ownerAccountId);
return this;
}
/**
*
* The ID of the route analysis.
*
*
* @param routeAnalysisId
* The ID of the route analysis.
*/
public void setRouteAnalysisId(String routeAnalysisId) {
this.routeAnalysisId = routeAnalysisId;
}
/**
*
* The ID of the route analysis.
*
*
* @return The ID of the route analysis.
*/
public String getRouteAnalysisId() {
return this.routeAnalysisId;
}
/**
*
* The ID of the route analysis.
*
*
* @param routeAnalysisId
* The ID of the route analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withRouteAnalysisId(String routeAnalysisId) {
setRouteAnalysisId(routeAnalysisId);
return this;
}
/**
*
* The time that the analysis started.
*
*
* @param startTimestamp
* The time that the analysis started.
*/
public void setStartTimestamp(java.util.Date startTimestamp) {
this.startTimestamp = startTimestamp;
}
/**
*
* The time that the analysis started.
*
*
* @return The time that the analysis started.
*/
public java.util.Date getStartTimestamp() {
return this.startTimestamp;
}
/**
*
* The time that the analysis started.
*
*
* @param startTimestamp
* The time that the analysis started.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withStartTimestamp(java.util.Date startTimestamp) {
setStartTimestamp(startTimestamp);
return this;
}
/**
*
* The status of the route analysis.
*
*
* @param status
* The status of the route analysis.
* @see RouteAnalysisStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the route analysis.
*
*
* @return The status of the route analysis.
* @see RouteAnalysisStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the route analysis.
*
*
* @param status
* The status of the route analysis.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisStatus
*/
public RouteAnalysis withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the route analysis.
*
*
* @param status
* The status of the route analysis.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisStatus
*/
public RouteAnalysis withStatus(RouteAnalysisStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The source.
*
*
* @param source
* The source.
*/
public void setSource(RouteAnalysisEndpointOptions source) {
this.source = source;
}
/**
*
* The source.
*
*
* @return The source.
*/
public RouteAnalysisEndpointOptions getSource() {
return this.source;
}
/**
*
* The source.
*
*
* @param source
* The source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withSource(RouteAnalysisEndpointOptions source) {
setSource(source);
return this;
}
/**
*
* The destination.
*
*
* @param destination
* The destination.
*/
public void setDestination(RouteAnalysisEndpointOptions destination) {
this.destination = destination;
}
/**
*
* The destination.
*
*
* @return The destination.
*/
public RouteAnalysisEndpointOptions getDestination() {
return this.destination;
}
/**
*
* The destination.
*
*
* @param destination
* The destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withDestination(RouteAnalysisEndpointOptions destination) {
setDestination(destination);
return this;
}
/**
*
* Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does
* not succeed.
*
*
* @param includeReturnPath
* Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis
* does not succeed.
*/
public void setIncludeReturnPath(Boolean includeReturnPath) {
this.includeReturnPath = includeReturnPath;
}
/**
*
* Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does
* not succeed.
*
*
* @return Indicates whether to analyze the return path. The return path is not analyzed if the forward path
* analysis does not succeed.
*/
public Boolean getIncludeReturnPath() {
return this.includeReturnPath;
}
/**
*
* Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does
* not succeed.
*
*
* @param includeReturnPath
* Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis
* does not succeed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withIncludeReturnPath(Boolean includeReturnPath) {
setIncludeReturnPath(includeReturnPath);
return this;
}
/**
*
* Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does
* not succeed.
*
*
* @return Indicates whether to analyze the return path. The return path is not analyzed if the forward path
* analysis does not succeed.
*/
public Boolean isIncludeReturnPath() {
return this.includeReturnPath;
}
/**
*
* Indicates whether to include the location of middlebox appliances in the route analysis.
*
*
* @param useMiddleboxes
* Indicates whether to include the location of middlebox appliances in the route analysis.
*/
public void setUseMiddleboxes(Boolean useMiddleboxes) {
this.useMiddleboxes = useMiddleboxes;
}
/**
*
* Indicates whether to include the location of middlebox appliances in the route analysis.
*
*
* @return Indicates whether to include the location of middlebox appliances in the route analysis.
*/
public Boolean getUseMiddleboxes() {
return this.useMiddleboxes;
}
/**
*
* Indicates whether to include the location of middlebox appliances in the route analysis.
*
*
* @param useMiddleboxes
* Indicates whether to include the location of middlebox appliances in the route analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withUseMiddleboxes(Boolean useMiddleboxes) {
setUseMiddleboxes(useMiddleboxes);
return this;
}
/**
*
* Indicates whether to include the location of middlebox appliances in the route analysis.
*
*
* @return Indicates whether to include the location of middlebox appliances in the route analysis.
*/
public Boolean isUseMiddleboxes() {
return this.useMiddleboxes;
}
/**
*
* The forward path.
*
*
* @param forwardPath
* The forward path.
*/
public void setForwardPath(RouteAnalysisPath forwardPath) {
this.forwardPath = forwardPath;
}
/**
*
* The forward path.
*
*
* @return The forward path.
*/
public RouteAnalysisPath getForwardPath() {
return this.forwardPath;
}
/**
*
* The forward path.
*
*
* @param forwardPath
* The forward path.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withForwardPath(RouteAnalysisPath forwardPath) {
setForwardPath(forwardPath);
return this;
}
/**
*
* The return path.
*
*
* @param returnPath
* The return path.
*/
public void setReturnPath(RouteAnalysisPath returnPath) {
this.returnPath = returnPath;
}
/**
*
* The return path.
*
*
* @return The return path.
*/
public RouteAnalysisPath getReturnPath() {
return this.returnPath;
}
/**
*
* The return path.
*
*
* @param returnPath
* The return path.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysis withReturnPath(RouteAnalysisPath returnPath) {
setReturnPath(returnPath);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getGlobalNetworkId() != null)
sb.append("GlobalNetworkId: ").append(getGlobalNetworkId()).append(",");
if (getOwnerAccountId() != null)
sb.append("OwnerAccountId: ").append(getOwnerAccountId()).append(",");
if (getRouteAnalysisId() != null)
sb.append("RouteAnalysisId: ").append(getRouteAnalysisId()).append(",");
if (getStartTimestamp() != null)
sb.append("StartTimestamp: ").append(getStartTimestamp()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getDestination() != null)
sb.append("Destination: ").append(getDestination()).append(",");
if (getIncludeReturnPath() != null)
sb.append("IncludeReturnPath: ").append(getIncludeReturnPath()).append(",");
if (getUseMiddleboxes() != null)
sb.append("UseMiddleboxes: ").append(getUseMiddleboxes()).append(",");
if (getForwardPath() != null)
sb.append("ForwardPath: ").append(getForwardPath()).append(",");
if (getReturnPath() != null)
sb.append("ReturnPath: ").append(getReturnPath());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RouteAnalysis == false)
return false;
RouteAnalysis other = (RouteAnalysis) obj;
if (other.getGlobalNetworkId() == null ^ this.getGlobalNetworkId() == null)
return false;
if (other.getGlobalNetworkId() != null && other.getGlobalNetworkId().equals(this.getGlobalNetworkId()) == false)
return false;
if (other.getOwnerAccountId() == null ^ this.getOwnerAccountId() == null)
return false;
if (other.getOwnerAccountId() != null && other.getOwnerAccountId().equals(this.getOwnerAccountId()) == false)
return false;
if (other.getRouteAnalysisId() == null ^ this.getRouteAnalysisId() == null)
return false;
if (other.getRouteAnalysisId() != null && other.getRouteAnalysisId().equals(this.getRouteAnalysisId()) == false)
return false;
if (other.getStartTimestamp() == null ^ this.getStartTimestamp() == null)
return false;
if (other.getStartTimestamp() != null && other.getStartTimestamp().equals(this.getStartTimestamp()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == false)
return false;
if (other.getDestination() == null ^ this.getDestination() == null)
return false;
if (other.getDestination() != null && other.getDestination().equals(this.getDestination()) == false)
return false;
if (other.getIncludeReturnPath() == null ^ this.getIncludeReturnPath() == null)
return false;
if (other.getIncludeReturnPath() != null && other.getIncludeReturnPath().equals(this.getIncludeReturnPath()) == false)
return false;
if (other.getUseMiddleboxes() == null ^ this.getUseMiddleboxes() == null)
return false;
if (other.getUseMiddleboxes() != null && other.getUseMiddleboxes().equals(this.getUseMiddleboxes()) == false)
return false;
if (other.getForwardPath() == null ^ this.getForwardPath() == null)
return false;
if (other.getForwardPath() != null && other.getForwardPath().equals(this.getForwardPath()) == false)
return false;
if (other.getReturnPath() == null ^ this.getReturnPath() == null)
return false;
if (other.getReturnPath() != null && other.getReturnPath().equals(this.getReturnPath()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGlobalNetworkId() == null) ? 0 : getGlobalNetworkId().hashCode());
hashCode = prime * hashCode + ((getOwnerAccountId() == null) ? 0 : getOwnerAccountId().hashCode());
hashCode = prime * hashCode + ((getRouteAnalysisId() == null) ? 0 : getRouteAnalysisId().hashCode());
hashCode = prime * hashCode + ((getStartTimestamp() == null) ? 0 : getStartTimestamp().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getDestination() == null) ? 0 : getDestination().hashCode());
hashCode = prime * hashCode + ((getIncludeReturnPath() == null) ? 0 : getIncludeReturnPath().hashCode());
hashCode = prime * hashCode + ((getUseMiddleboxes() == null) ? 0 : getUseMiddleboxes().hashCode());
hashCode = prime * hashCode + ((getForwardPath() == null) ? 0 : getForwardPath().hashCode());
hashCode = prime * hashCode + ((getReturnPath() == null) ? 0 : getReturnPath().hashCode());
return hashCode;
}
@Override
public RouteAnalysis clone() {
try {
return (RouteAnalysis) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.networkmanager.model.transform.RouteAnalysisMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}