CreateVpcLinkResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
    - - software.amazon.awssdk.services.apigateway.model.CreateVpcLinkResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateVpcLinkResponse.Builder,CreateVpcLinkResponse>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class CreateVpcLinkResponse
extends ApiGatewayResponse
implements ToCopyableBuilder<CreateVpcLinkResponse.Builder,CreateVpcLinkResponse>
```
A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateVpcLinkResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateVpcLinkResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateVpcLinkResponse.Builder`	`builder()`
`String`	`description()` The description of the VPC link.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`String`	`id()` The identifier of the VpcLink.
`String`	`name()` The name used to label and identify the VPC link.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateVpcLinkResponse.Builder>`	`serializableBuilderClass()`
`VpcLinkStatus`	`status()` The status of the VPC link.
`String`	`statusAsString()` The status of the VPC link.
`String`	`statusMessage()` A description about the VPC link status.
`List<String>`	`targetArns()` The ARNs of network load balancers of the VPC targeted by the VPC link.
`CreateVpcLinkResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public 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 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 String description()
```
    The description of the VPC link.
    
    Returns:
    
    The description of the VPC link.
  - targetArns
```
public List<String> targetArns()
```
    The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
  - status
```
public 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:
    
    VpcLinkStatus
  - statusAsString
```
public 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:
    
    VpcLinkStatus
  - statusMessage
```
public String statusMessage()
```
    A description about the VPC link status.
    
    Returns:
    
    A description about the VPC link status.
  - toBuilder
```
public CreateVpcLinkResponse.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<CreateVpcLinkResponse.Builder,CreateVpcLinkResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateVpcLinkResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateVpcLinkResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class CreateVpcLinkResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

name

description

targetArns

status

statusAsString

statusMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields