Class Explanation

java.lang.Object
software.amazon.awssdk.services.ec2.model.Explanation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Explanation.Builder,Explanation>
@Generated("software.amazon.awssdk:codegen") public final class Explanation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Explanation.Builder,Explanation>

Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.

See Also:

  • Method Details

    • acl

      public final AnalysisComponent acl()

      The network ACL.

      Returns:
      The network ACL.

    • aclRule

      public final AnalysisAclRule aclRule()

      The network ACL rule.

      Returns:
      The network ACL rule.

    • address

      public final String address()

      The IPv4 address, in CIDR notation.

      Returns:
      The IPv4 address, in CIDR notation.

    • hasAddresses

      public final boolean hasAddresses()
      For responses, this returns true if the service returned a value for the Addresses property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • addresses

      public final List<String> addresses()

      The IPv4 addresses, in CIDR notation.

      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 hasAddresses() method.

      Returns:
      The IPv4 addresses, in CIDR notation.

    • attachedTo

      public final AnalysisComponent attachedTo()

      The resource to which the component is attached.

      Returns:
      The resource to which the component is attached.

    • hasAvailabilityZones

      public final boolean hasAvailabilityZones()
      For responses, this returns true if the service returned a value for the AvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • availabilityZones

      public final List<String> availabilityZones()

      The Availability Zones.

      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 hasAvailabilityZones() method.

      Returns:
      The Availability Zones.

    • hasAvailabilityZoneIds

      public final boolean hasAvailabilityZoneIds()
      For responses, this returns true if the service returned a value for the AvailabilityZoneIds property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • availabilityZoneIds

      public final List<String> availabilityZoneIds()

      The IDs of the Availability Zones.

      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 hasAvailabilityZoneIds() method.

      Returns:
      The IDs of the Availability Zones.

    • hasCidrs

      public final boolean hasCidrs()
      For responses, this returns true if the service returned a value for the Cidrs property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • cidrs

      public final List<String> cidrs()

      The CIDR ranges.

      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 hasCidrs() method.

      Returns:
      The CIDR ranges.

    • component

      public final AnalysisComponent component()

      The component.

      Returns:
      The component.

    • customerGateway

      public final AnalysisComponent customerGateway()

      The customer gateway.

      Returns:
      The customer gateway.

    • destination

      public final AnalysisComponent destination()

      The destination.

      Returns:
      The destination.

    • destinationVpc

      public final AnalysisComponent destinationVpc()

      The destination VPC.

      Returns:
      The destination VPC.

    • direction

      public final String direction()

      The direction. The following are the possible values:

      • egress

      • ingress

      Returns:
      The direction. The following are the possible values:

      • egress

      • ingress

    • explanationCode

      public final String explanationCode()

      The explanation code.

      Returns:
      The explanation code.

    • ingressRouteTable

      public final AnalysisComponent ingressRouteTable()

      The route table.

      Returns:
      The route table.

    • internetGateway

      public final AnalysisComponent internetGateway()

      The internet gateway.

      Returns:
      The internet gateway.

    • loadBalancerArn

      public final String loadBalancerArn()

      The Amazon Resource Name (ARN) of the load balancer.

      Returns:
      The Amazon Resource Name (ARN) of the load balancer.

    • classicLoadBalancerListener

      public final AnalysisLoadBalancerListener classicLoadBalancerListener()

      The listener for a Classic Load Balancer.

      Returns:
      The listener for a Classic Load Balancer.

    • loadBalancerListenerPort

      public final Integer loadBalancerListenerPort()

      The listener port of the load balancer.

      Returns:
      The listener port of the load balancer.

    • loadBalancerTarget

      public final AnalysisLoadBalancerTarget loadBalancerTarget()

      The target.

      Returns:
      The target.

    • loadBalancerTargetGroup

      public final AnalysisComponent loadBalancerTargetGroup()

      The target group.

      Returns:
      The target group.

    • hasLoadBalancerTargetGroups

      public final boolean hasLoadBalancerTargetGroups()
      For responses, this returns true if the service returned a value for the LoadBalancerTargetGroups property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • loadBalancerTargetGroups

      public final List<AnalysisComponent> loadBalancerTargetGroups()

      The target groups.

      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 hasLoadBalancerTargetGroups() method.

      Returns:
      The target groups.

    • loadBalancerTargetPort

      public final Integer loadBalancerTargetPort()

      The target port.

      Returns:
      The target port.

    • elasticLoadBalancerListener

      public final AnalysisComponent elasticLoadBalancerListener()

      The load balancer listener.

      Returns:
      The load balancer listener.

    • missingComponent

      public final String missingComponent()

      The missing component.

      Returns:
      The missing component.

    • natGateway

      public final AnalysisComponent natGateway()

      The NAT gateway.

      Returns:
      The NAT gateway.

    • networkInterface

      public final AnalysisComponent networkInterface()

      The network interface.

      Returns:
      The network interface.

    • packetField

      public final String packetField()

      The packet field.

      Returns:
      The packet field.

    • vpcPeeringConnection

      public final AnalysisComponent vpcPeeringConnection()

      The VPC peering connection.

      Returns:
      The VPC peering connection.

    • port

      public final Integer port()

      The port.

      Returns:
      The port.

    • hasPortRanges

      public final boolean hasPortRanges()
      For responses, this returns true if the service returned a value for the PortRanges property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • portRanges

      public final List<PortRange> portRanges()

      The port ranges.

      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 hasPortRanges() method.

      Returns:
      The port ranges.

    • prefixList

      public final AnalysisComponent prefixList()

      The prefix list.

      Returns:
      The prefix list.

    • hasProtocols

      public final boolean hasProtocols()
      For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • protocols

      public final List<String> protocols()

      The protocols.

      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 hasProtocols() method.

      Returns:
      The protocols.

    • routeTableRoute

      public final AnalysisRouteTableRoute routeTableRoute()

      The route table route.

      Returns:
      The route table route.

    • routeTable

      public final AnalysisComponent routeTable()

      The route table.

      Returns:
      The route table.

    • securityGroup

      public final AnalysisComponent securityGroup()

      The security group.

      Returns:
      The security group.

    • securityGroupRule

      public final AnalysisSecurityGroupRule securityGroupRule()

      The security group rule.

      Returns:
      The security group rule.

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • securityGroups

      public final List<AnalysisComponent> securityGroups()

      The security groups.

      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 hasSecurityGroups() method.

      Returns:
      The security groups.

    • sourceVpc

      public final AnalysisComponent sourceVpc()

      The source VPC.

      Returns:
      The source VPC.

    • state

      public final String state()

      The state.

      Returns:
      The state.

    • subnet

      public final AnalysisComponent subnet()

      The subnet.

      Returns:
      The subnet.

    • subnetRouteTable

      public final AnalysisComponent subnetRouteTable()

      The route table for the subnet.

      Returns:
      The route table for the subnet.

    • vpc

      public final AnalysisComponent vpc()

      The component VPC.

      Returns:
      The component VPC.

    • vpcEndpoint

      public final AnalysisComponent vpcEndpoint()

      The VPC endpoint.

      Returns:
      The VPC endpoint.

    • vpnConnection

      public final AnalysisComponent vpnConnection()

      The VPN connection.

      Returns:
      The VPN connection.

    • vpnGateway

      public final AnalysisComponent vpnGateway()

      The VPN gateway.

      Returns:
      The VPN gateway.

    • transitGateway

      public final AnalysisComponent transitGateway()

      The transit gateway.

      Returns:
      The transit gateway.

    • transitGatewayRouteTable

      public final AnalysisComponent transitGatewayRouteTable()

      The transit gateway route table.

      Returns:
      The transit gateway route table.

    • transitGatewayRouteTableRoute

      public final TransitGatewayRouteTableRoute transitGatewayRouteTableRoute()

      The transit gateway route table route.

      Returns:
      The transit gateway route table route.

    • transitGatewayAttachment

      public final AnalysisComponent transitGatewayAttachment()

      The transit gateway attachment.

      Returns:
      The transit gateway attachment.

    • componentAccount

      public final String componentAccount()

      The Amazon Web Services account for the component.

      Returns:
      The Amazon Web Services account for the component.

    • componentRegion

      public final String componentRegion()

      The Region for the component.

      Returns:
      The Region for the component.

    • firewallStatelessRule

      public final FirewallStatelessRule firewallStatelessRule()

      The Network Firewall stateless rule.

      Returns:
      The Network Firewall stateless rule.

    • firewallStatefulRule

      public final FirewallStatefulRule firewallStatefulRule()

      The Network Firewall stateful rule.

      Returns:
      The Network Firewall stateful rule.

    • toBuilder

      public Explanation.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Explanation.Builder,Explanation>
      Returns:
      a builder for type T

    • builder

      public static Explanation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Explanation.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.