Class VpnGateway

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

Describes a virtual private gateway.

See Also:

  • Method Details

    • amazonSideAsn

      public final Long amazonSideAsn()

      The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

      Returns:
      The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      Any tags assigned to the virtual private gateway.

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

      Returns:
      Any tags assigned to the virtual private gateway.

    • vpnGatewayId

      public final String vpnGatewayId()

      The ID of the virtual private gateway.

      Returns:
      The ID of the virtual private gateway.

    • state

      public final VpnState state()

      The current state of the virtual private gateway.

      If the service returns an enum value that is not available in the current SDK version, state will return VpnState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the virtual private gateway.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the virtual private gateway.

      If the service returns an enum value that is not available in the current SDK version, state will return VpnState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the virtual private gateway.
      See Also:

    • type

      public final GatewayType type()

      The type of VPN connection the virtual private gateway supports.

      If the service returns an enum value that is not available in the current SDK version, type will return GatewayType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of VPN connection the virtual private gateway supports.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of VPN connection the virtual private gateway supports.

      If the service returns an enum value that is not available in the current SDK version, type will return GatewayType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of VPN connection the virtual private gateway supports.
      See Also:

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

      Returns:
      The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

    • hasVpcAttachments

      public final boolean hasVpcAttachments()
      For responses, this returns true if the service returned a value for the VpcAttachments 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.

    • vpcAttachments

      public final List<VpcAttachment> vpcAttachments()

      Any VPCs attached to the virtual private gateway.

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

      Returns:
      Any VPCs attached to the virtual private gateway.

    • toBuilder

      public VpnGateway.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<VpnGateway.Builder,VpnGateway>
      Returns:
      a builder for type T

    • builder

      public static VpnGateway.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VpnGateway.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.