Class GetVpcLinkResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response
software.amazon.awssdk.services.apigatewayv2.model.GetVpcLinkResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetVpcLinkResponse.Builder,GetVpcLinkResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetVpcLinkResponse extends ApiGatewayV2Response implements ToCopyableBuilder<GetVpcLinkResponse.Builder,GetVpcLinkResponse>

  • Method Details

    • createdDate

      public final Instant createdDate()

      The timestamp when the VPC link was created.

      Returns:
      The timestamp when the VPC link was created.

    • name

      public final String name()

      The name of the VPC link.

      Returns:
      The name of the VPC link.

    • hasSecurityGroupIds

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

    • securityGroupIds

      public final List<String> securityGroupIds()

      A list of security group IDs for the VPC link.

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

      Returns:
      A list of security group IDs for the VPC link.

    • hasSubnetIds

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

    • subnetIds

      public final List<String> subnetIds()

      A list of subnet IDs to include in the VPC link.

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

      Returns:
      A list of subnet IDs to include in the VPC link.

    • 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()

      Tags for the VPC link.

      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:
      Tags for the VPC link.

    • vpcLinkId

      public final String vpcLinkId()

      The ID of the VPC link.

      Returns:
      The ID of the VPC link.

    • vpcLinkStatus

      public final VpcLinkStatus vpcLinkStatus()

      The status of the VPC link.

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

      Returns:
      The status of the VPC link.
      See Also:

    • vpcLinkStatusAsString

      public final String vpcLinkStatusAsString()

      The status of the VPC link.

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

      Returns:
      The status of the VPC link.
      See Also:

    • vpcLinkStatusMessage

      public final String vpcLinkStatusMessage()

      A message summarizing the cause of the status of the VPC link.

      Returns:
      A message summarizing the cause of the status of the VPC link.

    • vpcLinkVersion

      public final VpcLinkVersion vpcLinkVersion()

      The version of the VPC link.

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

      Returns:
      The version of the VPC link.
      See Also:

    • vpcLinkVersionAsString

      public final String vpcLinkVersionAsString()

      The version of the VPC link.

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

      Returns:
      The version of the VPC link.
      See Also:

    • toBuilder

      public GetVpcLinkResponse.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<GetVpcLinkResponse.Builder,GetVpcLinkResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetVpcLinkResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.