GetVpcLinkResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.apigateway.model.GetVpcLinkResult

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetVpcLinkResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable
```
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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetVpcLinkResult()

Constructors
Constructor and Description
`GetVpcLinkResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetVpcLinkResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` The description of the VPC link.
`String`	`getId()` The identifier of the VpcLink.
`String`	`getName()` The name used to label and identify the VPC link.
`String`	`getStatus()` The status of the VPC link.
`String`	`getStatusMessage()` A description about the VPC link status.
`List<String>`	`getTargetArns()` The ARNs of network load balancers of the VPC targeted by the VPC link.
`int`	`hashCode()`
`void`	`setDescription(String description)` The description of the VPC link.
`void`	`setId(String id)` The identifier of the VpcLink.
`void`	`setName(String name)` The name used to label and identify the VPC link.
`void`	`setStatus(String status)` The status of the VPC link.
`void`	`setStatusMessage(String statusMessage)` A description about the VPC link status.
`void`	`setTargetArns(Collection<String> targetArns)` The ARNs of network load balancers of the VPC targeted by the VPC link.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetVpcLinkResult`	`withDescription(String description)` The description of the VPC link.
`GetVpcLinkResult`	`withId(String id)` The identifier of the VpcLink.
`GetVpcLinkResult`	`withName(String name)` The name used to label and identify the VPC link.
`GetVpcLinkResult`	`withStatus(String status)` The status of the VPC link.
`GetVpcLinkResult`	`withStatus(VpcLinkStatus status)` The status of the VPC link.
`GetVpcLinkResult`	`withStatusMessage(String statusMessage)` A description about the VPC link status.
`GetVpcLinkResult`	`withTargetArns(Collection<String> targetArns)` The ARNs of network load balancers of the VPC targeted by the VPC link.
`GetVpcLinkResult`	`withTargetArns(String... targetArns)` The ARNs of network load balancers of the VPC targeted by the VPC link.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetVpcLinkResult
```
public GetVpcLinkResult()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
    
    Parameters:
    
    id - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
  - getId
```
public String getId()
```
    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.
  - withId
```
public GetVpcLinkResult withId(String id)
```
    The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
    
    Parameters:
    
    id - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name used to label and identify the VPC link.
    
    Parameters:
    
    name - The name used to label and identify the VPC link.
  - getName
```
public String getName()
```
    The name used to label and identify the VPC link.
    
    Returns:
    
    The name used to label and identify the VPC link.
  - withName
```
public GetVpcLinkResult withName(String name)
```
    The name used to label and identify the VPC link.
    
    Parameters:
    
    name - The name used to label and identify the VPC link.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the VPC link.
    
    Parameters:
    
    description - The description of the VPC link.
  - getDescription
```
public String getDescription()
```
    The description of the VPC link.
    
    Returns:
    
    The description of the VPC link.
  - withDescription
```
public GetVpcLinkResult withDescription(String description)
```
    The description of the VPC link.
    
    Parameters:
    
    description - The description of the VPC link.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargetArns
```
public List<String> getTargetArns()
```
    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.
    
    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.
  - setTargetArns
```
public void setTargetArns(Collection<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.
    
    Parameters:
    
    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.
  - withTargetArns
```
public GetVpcLinkResult withTargetArns(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTargetArns(java.util.Collection) or withTargetArns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargetArns
```
public GetVpcLinkResult withTargetArns(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    VpcLinkStatus
  - getStatus
```
public String getStatus()
```
    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.
    
    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
  - withStatus
```
public GetVpcLinkResult withStatus(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VpcLinkStatus
  - withStatus
```
public GetVpcLinkResult withStatus(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VpcLinkStatus
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A description about the VPC link status.
    
    Parameters:
    
    statusMessage - A description about the VPC link status.
  - getStatusMessage
```
public String getStatusMessage()
```
    A description about the VPC link status.
    
    Returns:
    
    A description about the VPC link status.
  - withStatusMessage
```
public GetVpcLinkResult withStatusMessage(String statusMessage)
```
    A description about the VPC link status.
    
    Parameters:
    
    statusMessage - A description about the VPC link status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetVpcLinkResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetVpcLinkResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetVpcLinkResult

Method Detail

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

getTargetArns

setTargetArns

withTargetArns

withTargetArns

setStatus

getStatus

withStatus

withStatus

setStatusMessage

getStatusMessage

withStatusMessage

toString

equals

hashCode

clone