software.amazon.awssdk.services.apigateway.model.GetVpcLinkResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apigateway Show documentation
Show all versions of apigateway Show documentation
The AWS Java SDK for Amazon API Gateway module holds the client classes that are used for communicating
with Amazon API
Gateway
/*
* Copyright 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 software.amazon.awssdk.services.apigateway.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* An 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.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetVpcLinkResponse extends ApiGatewayResponse implements
ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("id")
.getter(getter(GetVpcLinkResponse::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(GetVpcLinkResponse::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(GetVpcLinkResponse::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField> TARGET_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("targetArns")
.getter(getter(GetVpcLinkResponse::targetArns))
.setter(setter(Builder::targetArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("targetArns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(GetVpcLinkResponse::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final SdkField STATUS_MESSAGE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("statusMessage").getter(getter(GetVpcLinkResponse::statusMessage)).setter(setter(Builder::statusMessage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("statusMessage").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(GetVpcLinkResponse::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, NAME_FIELD,
DESCRIPTION_FIELD, TARGET_ARNS_FIELD, STATUS_FIELD, STATUS_MESSAGE_FIELD, TAGS_FIELD));
private final String id;
private final String name;
private final String description;
private final List targetArns;
private final String status;
private final String statusMessage;
private final Map tags;
private GetVpcLinkResponse(BuilderImpl builder) {
super(builder);
this.id = builder.id;
this.name = builder.name;
this.description = builder.description;
this.targetArns = builder.targetArns;
this.status = builder.status;
this.statusMessage = builder.statusMessage;
this.tags = builder.tags;
}
/**
*
* 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 final String id() {
return id;
}
/**
*
* The name used to label and identify the VPC link.
*
*
* @return The name used to label and identify the VPC link.
*/
public final String name() {
return name;
}
/**
*
* The description of the VPC link.
*
*
* @return The description of the VPC link.
*/
public final String description() {
return description;
}
/**
* Returns true if the TargetArns property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasTargetArns() {
return targetArns != null && !(targetArns instanceof SdkAutoConstructList);
}
/**
*
* 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.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTargetArns()} to see if a value was sent in this field.
*
*
* @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 final List targetArns() {
return 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.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link VpcLinkStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @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 final VpcLinkStatus status() {
return VpcLinkStatus.fromValue(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, {@link #status} will
* return {@link VpcLinkStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @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 final String statusAsString() {
return status;
}
/**
*
* A description about the VPC link status.
*
*
* @return A description about the VPC link status.
*/
public final String statusMessage() {
return statusMessage;
}
/**
* Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The collection of tags. Each tag element is associated with a given resource.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTags()} to see if a value was sent in this field.
*
*
* @return The collection of tags. Each tag element is associated with a given resource.
*/
public final Map tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasTargetArns() ? targetArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(statusMessage());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetVpcLinkResponse)) {
return false;
}
GetVpcLinkResponse other = (GetVpcLinkResponse) obj;
return Objects.equals(id(), other.id()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description()) && hasTargetArns() == other.hasTargetArns()
&& Objects.equals(targetArns(), other.targetArns()) && Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(statusMessage(), other.statusMessage()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("GetVpcLinkResponse").add("Id", id()).add("Name", name()).add("Description", description())
.add("TargetArns", hasTargetArns() ? targetArns() : null).add("Status", statusAsString())
.add("StatusMessage", statusMessage()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "id":
return Optional.ofNullable(clazz.cast(id()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "targetArns":
return Optional.ofNullable(clazz.cast(targetArns()));
case "status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "statusMessage":
return Optional.ofNullable(clazz.cast(statusMessage()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetVpcLinkResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ApiGatewayResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder id(String id);
/**
*
* 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.
*/
Builder name(String name);
/**
*
* 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.
*/
Builder description(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.
*
*
* @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.
*/
Builder targetArns(Collection 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetArns(String... 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.
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see VpcLinkStatus
*/
Builder status(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.
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see VpcLinkStatus
*/
Builder status(VpcLinkStatus status);
/**
*
* 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.
*/
Builder statusMessage(String statusMessage);
/**
*
* 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.
*/
Builder tags(Map tags);
}
static final class BuilderImpl extends ApiGatewayResponse.BuilderImpl implements Builder {
private String id;
private String name;
private String description;
private List targetArns = DefaultSdkAutoConstructList.getInstance();
private String status;
private String statusMessage;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetVpcLinkResponse model) {
super(model);
id(model.id);
name(model.name);
description(model.description);
targetArns(model.targetArns);
status(model.status);
statusMessage(model.statusMessage);
tags(model.tags);
}
public final String getId() {
return id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final void setId(String id) {
this.id = id;
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
public final String getDescription() {
return description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final void setDescription(String description) {
this.description = description;
}
public final Collection getTargetArns() {
if (targetArns instanceof SdkAutoConstructList) {
return null;
}
return targetArns;
}
@Override
public final Builder targetArns(Collection targetArns) {
this.targetArns = ListOfStringCopier.copy(targetArns);
return this;
}
@Override
@SafeVarargs
public final Builder targetArns(String... targetArns) {
targetArns(Arrays.asList(targetArns));
return this;
}
public final void setTargetArns(Collection targetArns) {
this.targetArns = ListOfStringCopier.copy(targetArns);
}
public final String getStatus() {
return status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(VpcLinkStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final void setStatus(String status) {
this.status = status;
}
public final String getStatusMessage() {
return statusMessage;
}
@Override
public final Builder statusMessage(String statusMessage) {
this.statusMessage = statusMessage;
return this;
}
public final void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
@Override
public final Builder tags(Map tags) {
this.tags = MapOfStringToStringCopier.copy(tags);
return this;
}
public final void setTags(Map tags) {
this.tags = MapOfStringToStringCopier.copy(tags);
}
@Override
public GetVpcLinkResponse build() {
return new GetVpcLinkResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}