com.amazonaws.services.apigateway.model.CreateVpcLinkResult Maven / Gradle / Ivy
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.apigateway.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateVpcLinkResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*
*/
private String id;
/**
*
* The name used to label and identify the VPC link.
*
*/
private String name;
/**
*
* The description of the VPC link.
*
*/
private String description;
/**
*
* 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 AWS account of the API owner.
*
*/
private java.util.List targetArns;
/**
*
* 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.
*
*/
private String status;
/**
*
* A description about the VPC link status.
*
*/
private String statusMessage;
/**
*
* The collection of tags. Each tag element is associated with a given resource.
*
*/
private java.util.Map tags;
/**
*
* The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*
*
* @param id
* The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*
*
* @return The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*/
public String getId() {
return this.id;
}
/**
*
* The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
*
*
* @param id
* The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult withId(String id) {
setId(id);
return this;
}
/**
*
* The name used to label and identify the VPC link.
*
*
* @param name
* The name used to label and identify the VPC link.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name used to label and identify the VPC link.
*
*
* @return The name used to label and identify the VPC link.
*/
public String getName() {
return this.name;
}
/**
*
* The name used to label and identify the VPC link.
*
*
* @param name
* The name used to label and identify the VPC link.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult withName(String name) {
setName(name);
return this;
}
/**
*
* The description of the VPC link.
*
*
* @param description
* The description of the VPC link.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the VPC link.
*
*
* @return The description of the VPC link.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the VPC link.
*
*
* @param description
* The description of the VPC link.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* 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 AWS account of the API owner.
*
*
* @return 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 AWS account of the API owner.
*/
public java.util.List getTargetArns() {
return 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 AWS account of the API owner.
*
*
* @param 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 AWS account of the API owner.
*/
public void setTargetArns(java.util.Collection targetArns) {
if (targetArns == null) {
this.targetArns = null;
return;
}
this.targetArns = new java.util.ArrayList(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 AWS account of the API owner.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTargetArns(java.util.Collection)} or {@link #withTargetArns(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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 AWS account of the API owner.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult withTargetArns(String... targetArns) {
if (this.targetArns == null) {
setTargetArns(new java.util.ArrayList(targetArns.length));
}
for (String ele : targetArns) {
this.targetArns.add(ele);
}
return this;
}
/**
*
* 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 AWS account of the API owner.
*
*
* @param 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 AWS account of the API owner.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult withTargetArns(java.util.Collection targetArns) {
setTargetArns(targetArns);
return this;
}
/**
*
* 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.
*
*
* @param 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 VpcLinkStatus
*/
public void setStatus(String status) {
this.status = 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.
*
*
* @return 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 VpcLinkStatus
*/
public String getStatus() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VpcLinkStatus
*/
public CreateVpcLinkResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VpcLinkStatus
*/
public CreateVpcLinkResult withStatus(VpcLinkStatus status) {
this.status = status.toString();
return this;
}
/**
*
* A description about the VPC link status.
*
*
* @param statusMessage
* A description about the VPC link status.
*/
public void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
/**
*
* A description about the VPC link status.
*
*
* @return A description about the VPC link status.
*/
public String getStatusMessage() {
return this.statusMessage;
}
/**
*
* A description about the VPC link status.
*
*
* @param statusMessage
* A description about the VPC link status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult withStatusMessage(String statusMessage) {
setStatusMessage(statusMessage);
return this;
}
/**
*
* The collection of tags. Each tag element is associated with a given resource.
*
*
* @return The collection of tags. Each tag element is associated with a given resource.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* The collection of tags. Each tag element is associated with a given resource.
*
*
* @param tags
* The collection of tags. Each tag element is associated with a given resource.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* The collection of tags. Each tag element is associated with a given resource.
*
*
* @param tags
* The collection of tags. Each tag element is associated with a given resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateVpcLinkResult#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVpcLinkResult clearTagsEntries() {
this.tags = null;
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getTargetArns() != null)
sb.append("TargetArns: ").append(getTargetArns()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusMessage() != null)
sb.append("StatusMessage: ").append(getStatusMessage()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateVpcLinkResult == false)
return false;
CreateVpcLinkResult other = (CreateVpcLinkResult) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getTargetArns() == null ^ this.getTargetArns() == null)
return false;
if (other.getTargetArns() != null && other.getTargetArns().equals(this.getTargetArns()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStatusMessage() == null ^ this.getStatusMessage() == null)
return false;
if (other.getStatusMessage() != null && other.getStatusMessage().equals(this.getStatusMessage()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getTargetArns() == null) ? 0 : getTargetArns().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusMessage() == null) ? 0 : getStatusMessage().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateVpcLinkResult clone() {
try {
return (CreateVpcLinkResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}