software.amazon.awssdk.services.networkmanager.model.RouteAnalysisCompletion Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.networkmanager.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Describes the status of an analysis at completion.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RouteAnalysisCompletion implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField RESULT_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResultCode").getter(getter(RouteAnalysisCompletion::resultCodeAsString))
.setter(setter(Builder::resultCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResultCode").build()).build();
private static final SdkField REASON_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReasonCode").getter(getter(RouteAnalysisCompletion::reasonCodeAsString))
.setter(setter(Builder::reasonCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReasonCode").build()).build();
private static final SdkField> REASON_CONTEXT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("ReasonContext")
.getter(getter(RouteAnalysisCompletion::reasonContext))
.setter(setter(Builder::reasonContext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReasonContext").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESULT_CODE_FIELD,
REASON_CODE_FIELD, REASON_CONTEXT_FIELD));
private static final long serialVersionUID = 1L;
private final String resultCode;
private final String reasonCode;
private final Map reasonContext;
private RouteAnalysisCompletion(BuilderImpl builder) {
this.resultCode = builder.resultCode;
this.reasonCode = builder.reasonCode;
this.reasonContext = builder.reasonContext;
}
/**
*
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #resultCode} will
* return {@link RouteAnalysisCompletionResultCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #resultCodeAsString}.
*
*
* @return The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
* @see RouteAnalysisCompletionResultCode
*/
public final RouteAnalysisCompletionResultCode resultCode() {
return RouteAnalysisCompletionResultCode.fromValue(resultCode);
}
/**
*
* The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #resultCode} will
* return {@link RouteAnalysisCompletionResultCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #resultCodeAsString}.
*
*
* @return The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
* @see RouteAnalysisCompletionResultCode
*/
public final String resultCodeAsString() {
return 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.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #reasonCode} will
* return {@link RouteAnalysisCompletionReasonCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #reasonCodeAsString}.
*
*
* @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 final RouteAnalysisCompletionReasonCode reasonCode() {
return RouteAnalysisCompletionReasonCode.fromValue(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.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #reasonCode} will
* return {@link RouteAnalysisCompletionReasonCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #reasonCodeAsString}.
*
*
* @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 final String reasonCodeAsString() {
return reasonCode;
}
/**
* For responses, this returns true if the service returned a value for the ReasonContext property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasReasonContext() {
return reasonContext != null && !(reasonContext instanceof SdkAutoConstructMap);
}
/**
*
* Additional information about the path. Available only if a connection is not found.
*
*
* 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 {@link #hasReasonContext} method.
*
*
* @return Additional information about the path. Available only if a connection is not found.
*/
public final Map reasonContext() {
return reasonContext;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(resultCodeAsString());
hashCode = 31 * hashCode + Objects.hashCode(reasonCodeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasReasonContext() ? reasonContext() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RouteAnalysisCompletion)) {
return false;
}
RouteAnalysisCompletion other = (RouteAnalysisCompletion) obj;
return Objects.equals(resultCodeAsString(), other.resultCodeAsString())
&& Objects.equals(reasonCodeAsString(), other.reasonCodeAsString())
&& hasReasonContext() == other.hasReasonContext() && Objects.equals(reasonContext(), other.reasonContext());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("RouteAnalysisCompletion").add("ResultCode", resultCodeAsString())
.add("ReasonCode", reasonCodeAsString()).add("ReasonContext", hasReasonContext() ? reasonContext() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ResultCode":
return Optional.ofNullable(clazz.cast(resultCodeAsString()));
case "ReasonCode":
return Optional.ofNullable(clazz.cast(reasonCodeAsString()));
case "ReasonContext":
return Optional.ofNullable(clazz.cast(reasonContext()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RouteAnalysisCompletion) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisCompletionResultCode
*/
Builder resultCode(String 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.
* @see RouteAnalysisCompletionResultCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisCompletionResultCode
*/
Builder resultCode(RouteAnalysisCompletionResultCode 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.
*
*
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisCompletionReasonCode
*/
Builder reasonCode(String 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.
*
*
* @see RouteAnalysisCompletionReasonCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see RouteAnalysisCompletionReasonCode
*/
Builder reasonCode(RouteAnalysisCompletionReasonCode reasonCode);
/**
*
* 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.
*/
Builder reasonContext(Map reasonContext);
}
static final class BuilderImpl implements Builder {
private String resultCode;
private String reasonCode;
private Map reasonContext = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(RouteAnalysisCompletion model) {
resultCode(model.resultCode);
reasonCode(model.reasonCode);
reasonContext(model.reasonContext);
}
public final String getResultCode() {
return resultCode;
}
public final void setResultCode(String resultCode) {
this.resultCode = resultCode;
}
@Override
public final Builder resultCode(String resultCode) {
this.resultCode = resultCode;
return this;
}
@Override
public final Builder resultCode(RouteAnalysisCompletionResultCode resultCode) {
this.resultCode(resultCode == null ? null : resultCode.toString());
return this;
}
public final String getReasonCode() {
return reasonCode;
}
public final void setReasonCode(String reasonCode) {
this.reasonCode = reasonCode;
}
@Override
public final Builder reasonCode(String reasonCode) {
this.reasonCode = reasonCode;
return this;
}
@Override
public final Builder reasonCode(RouteAnalysisCompletionReasonCode reasonCode) {
this.reasonCode(reasonCode == null ? null : reasonCode.toString());
return this;
}
public final Map getReasonContext() {
if (reasonContext instanceof SdkAutoConstructMap) {
return null;
}
return reasonContext;
}
public final void setReasonContext(Map reasonContext) {
this.reasonContext = ReasonContextMapCopier.copy(reasonContext);
}
@Override
public final Builder reasonContext(Map reasonContext) {
this.reasonContext = ReasonContextMapCopier.copy(reasonContext);
return this;
}
@Override
public RouteAnalysisCompletion build() {
return new RouteAnalysisCompletion(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}