com.amazonaws.services.networkmanager.model.RouteAnalysisCompletion 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 the status of an analysis at completion.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RouteAnalysisCompletion implements Serializable, Cloneable, StructuredPojo {
/**
*
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
*
*/
private String resultCode;
/**
*
* The reason code. Available only if a connection is not found.
*
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
*
*/
private String reasonCode;
/**
*
* Additional information about the path. Available only if a connection is not found.
*
*/
private java.util.Map reasonContext;
/**
*
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
*
*
* @param resultCode
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
* @see RouteAnalysisCompletionResultCode
*/
public void setResultCode(String resultCode) {
this.resultCode = resultCode;
}
/**
*
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
*
*
* @return The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
* @see RouteAnalysisCompletionResultCode
*/
public String getResultCode() {
return this.resultCode;
}
/**
*
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
*
*
* @param resultCode
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisCompletionResultCode
*/
public RouteAnalysisCompletion withResultCode(String resultCode) {
setResultCode(resultCode);
return this;
}
/**
*
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
*
*
* @param resultCode
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisCompletionResultCode
*/
public RouteAnalysisCompletion withResultCode(RouteAnalysisCompletionResultCode resultCode) {
this.resultCode = resultCode.toString();
return this;
}
/**
*
* The reason code. Available only if a connection is not found.
*
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
*
*
* @param reasonCode
* The reason code. Available only if a connection is not found.
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR
* block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR
* block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
* @see RouteAnalysisCompletionReasonCode
*/
public void setReasonCode(String reasonCode) {
this.reasonCode = reasonCode;
}
/**
*
* The reason code. Available only if a connection is not found.
*
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
*
*
* @return The reason code. Available only if a connection is not found.
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR
* block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR
* block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
* @see RouteAnalysisCompletionReasonCode
*/
public String getReasonCode() {
return this.reasonCode;
}
/**
*
* The reason code. Available only if a connection is not found.
*
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
*
*
* @param reasonCode
* The reason code. Available only if a connection is not found.
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR
* block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR
* block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisCompletionReasonCode
*/
public RouteAnalysisCompletion withReasonCode(String reasonCode) {
setReasonCode(reasonCode);
return this;
}
/**
*
* The reason code. Available only if a connection is not found.
*
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
*
*
* @param reasonCode
* The reason code. Available only if a connection is not found.
*
* -
*
* BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR
* block.
*
*
* -
*
* CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
*
*
* -
*
* INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR
* block.
*
*
* -
*
* MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
*
*
* -
*
* ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
*
*
* -
*
* TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
*
*
* -
*
* TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
*
*
* -
*
* TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
*
*
* -
*
* TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
* associated.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisCompletionReasonCode
*/
public RouteAnalysisCompletion withReasonCode(RouteAnalysisCompletionReasonCode reasonCode) {
this.reasonCode = reasonCode.toString();
return this;
}
/**
*
* Additional information about the path. Available only if a connection is not found.
*
*
* @return Additional information about the path. Available only if a connection is not found.
*/
public java.util.Map getReasonContext() {
return reasonContext;
}
/**
*
* Additional information about the path. Available only if a connection is not found.
*
*
* @param reasonContext
* Additional information about the path. Available only if a connection is not found.
*/
public void setReasonContext(java.util.Map reasonContext) {
this.reasonContext = reasonContext;
}
/**
*
* Additional information about the path. Available only if a connection is not found.
*
*
* @param reasonContext
* Additional information about the path. Available only if a connection is not found.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysisCompletion withReasonContext(java.util.Map reasonContext) {
setReasonContext(reasonContext);
return this;
}
/**
* Add a single ReasonContext entry
*
* @see RouteAnalysisCompletion#withReasonContext
* @returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysisCompletion addReasonContextEntry(String key, String value) {
if (null == this.reasonContext) {
this.reasonContext = new java.util.HashMap();
}
if (this.reasonContext.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.reasonContext.put(key, value);
return this;
}
/**
* Removes all the entries added into ReasonContext.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RouteAnalysisCompletion clearReasonContextEntries() {
this.reasonContext = null;
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 (getResultCode() != null)
sb.append("ResultCode: ").append(getResultCode()).append(",");
if (getReasonCode() != null)
sb.append("ReasonCode: ").append(getReasonCode()).append(",");
if (getReasonContext() != null)
sb.append("ReasonContext: ").append(getReasonContext());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RouteAnalysisCompletion == false)
return false;
RouteAnalysisCompletion other = (RouteAnalysisCompletion) obj;
if (other.getResultCode() == null ^ this.getResultCode() == null)
return false;
if (other.getResultCode() != null && other.getResultCode().equals(this.getResultCode()) == false)
return false;
if (other.getReasonCode() == null ^ this.getReasonCode() == null)
return false;
if (other.getReasonCode() != null && other.getReasonCode().equals(this.getReasonCode()) == false)
return false;
if (other.getReasonContext() == null ^ this.getReasonContext() == null)
return false;
if (other.getReasonContext() != null && other.getReasonContext().equals(this.getReasonContext()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getResultCode() == null) ? 0 : getResultCode().hashCode());
hashCode = prime * hashCode + ((getReasonCode() == null) ? 0 : getReasonCode().hashCode());
hashCode = prime * hashCode + ((getReasonContext() == null) ? 0 : getReasonContext().hashCode());
return hashCode;
}
@Override
public RouteAnalysisCompletion clone() {
try {
return (RouteAnalysisCompletion) 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.RouteAnalysisCompletionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}