VpcLink (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.VpcLink

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VpcLink
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

VpcLink()

Constructors
Constructor and Description
`VpcLink()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VpcLink`	`addTagsEntry(String key, String value)` Add a single Tags entry
`VpcLink`	`clearTagsEntries()` Removes all the entries added into Tags.
`VpcLink`	`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.
`Map<String,String>`	`getTags()` The collection of tags.
`List<String>`	`getTargetArns()` The ARN of the network load balancer of the VPC targeted by the VPC link.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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`	`setTags(Map<String,String> tags)` The collection of tags.
`void`	`setTargetArns(Collection<String> targetArns)` The ARN of the network load balancer of the VPC targeted by the VPC link.
`String`	`toString()` Returns a string representation of this object.
`VpcLink`	`withDescription(String description)` The description of the VPC link.
`VpcLink`	`withId(String id)` The identifier of the VpcLink.
`VpcLink`	`withName(String name)` The name used to label and identify the VPC link.
`VpcLink`	`withStatus(String status)` The status of the VPC link.
`VpcLink`	`withStatus(VpcLinkStatus status)` The status of the VPC link.
`VpcLink`	`withStatusMessage(String statusMessage)` A description about the VPC link status.
`VpcLink`	`withTags(Map<String,String> tags)` The collection of tags.
`VpcLink`	`withTargetArns(Collection<String> targetArns)` The ARN of the network load balancer of the VPC targeted by the VPC link.
`VpcLink`	`withTargetArns(String... targetArns)` The ARN of the network load balancer of the VPC targeted by the VPC link.

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

- Constructor Detail
  - VpcLink
```
public VpcLink()
```
- 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 VpcLink 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 VpcLink 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 VpcLink 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 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.
    
    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.
  - setTargetArns
```
public void setTargetArns(Collection<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.
    
    Parameters:
    
    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.
  - withTargetArns
```
public VpcLink withTargetArns(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.
    
    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 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargetArns
```
public VpcLink withTargetArns(Collection<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.
    
    Parameters:
    
    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.
    
    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 VpcLink 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 VpcLink 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 VpcLink 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.
  - getTags
```
public Map<String,String> getTags()
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Parameters:
    
    tags - The collection of tags. Each tag element is associated with a given resource.
  - withTags
```
public VpcLink withTags(Map<String,String> tags)
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Parameters:
    
    tags - The collection of tags. Each tag element is associated with a given resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public VpcLink addTagsEntry(String key,
                            String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public VpcLink clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 VpcLink clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class VpcLink

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VpcLink

Method Detail

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

getTargetArns

setTargetArns

withTargetArns

withTargetArns

setStatus

getStatus

withStatus

withStatus

setStatusMessage

getStatusMessage

withStatusMessage

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall