Class VpcLink

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

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

      Returns:
      The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

    • name

      public final String name()

      The name used to label and identify the VPC link.

      Returns:
      The name used to label and identify the VPC link.

    • description

      public final String description()

      The description of the VPC link.

      Returns:
      The description of the VPC link.

    • hasTargetArns

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

    • targetArns

      public final List<String> targetArns()

      The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.

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

      Returns:
      The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.

    • status

      public final VpcLinkStatus status()

      The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

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

      Returns:
      The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

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

      Returns:
      The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
      See Also:

    • statusMessage

      public final String statusMessage()

      A description about the VPC link status.

      Returns:
      A description about the VPC link status.

    • 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 Map<String,String> tags()

      The collection of tags. Each tag element is associated with a given resource.

      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:
      The collection of tags. Each tag element is associated with a given resource.

    • toBuilder

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

    • builder

      public static VpcLink.Builder builder()

    • serializableBuilderClass

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