software.amazon.awssdk.services.transfer.model.EndpointDetails Maven / Gradle / Ivy
Show all versions of transfer Show documentation
/*
* 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.transfer.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
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.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server.
* With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming
* internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's
* endpoint.
*
*
*
* After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon
* Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers
* with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will
* not be affected. After this date, use EndpointType=VPC.
*
*
* For more information, see
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EndpointDetails implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> ADDRESS_ALLOCATION_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AddressAllocationIds")
.getter(getter(EndpointDetails::addressAllocationIds))
.setter(setter(Builder::addressAllocationIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AddressAllocationIds").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> SUBNET_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SubnetIds")
.getter(getter(EndpointDetails::subnetIds))
.setter(setter(Builder::subnetIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubnetIds").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 VPC_ENDPOINT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VpcEndpointId").getter(getter(EndpointDetails::vpcEndpointId)).setter(setter(Builder::vpcEndpointId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcEndpointId").build()).build();
private static final SdkField VPC_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("VpcId")
.getter(getter(EndpointDetails::vpcId)).setter(setter(Builder::vpcId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcId").build()).build();
private static final SdkField> SECURITY_GROUP_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SecurityGroupIds")
.getter(getter(EndpointDetails::securityGroupIds))
.setter(setter(Builder::securityGroupIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecurityGroupIds").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ADDRESS_ALLOCATION_IDS_FIELD,
SUBNET_IDS_FIELD, VPC_ENDPOINT_ID_FIELD, VPC_ID_FIELD, SECURITY_GROUP_IDS_FIELD));
private static final long serialVersionUID = 1L;
private final List addressAllocationIds;
private final List subnetIds;
private final String vpcEndpointId;
private final String vpcId;
private final List securityGroupIds;
private EndpointDetails(BuilderImpl builder) {
this.addressAllocationIds = builder.addressAllocationIds;
this.subnetIds = builder.subnetIds;
this.vpcEndpointId = builder.vpcEndpointId;
this.vpcId = builder.vpcId;
this.securityGroupIds = builder.securityGroupIds;
}
/**
* Returns true if the AddressAllocationIds 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 hasAddressAllocationIds() {
return addressAllocationIds != null && !(addressAllocationIds instanceof SdkAutoConstructList);
}
/**
*
* A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
*
*
*
* This property can only be set when EndpointType is set to VPC and it is only valid in
* the UpdateServer API.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasAddressAllocationIds()} to see if a value was sent in this field.
*
*
* @return A list of address allocation IDs that are required to attach an Elastic IP address to your server's
* endpoint.
*
* This property can only be set when EndpointType is set to VPC and it is only
* valid in the UpdateServer API.
*
*/
public final List addressAllocationIds() {
return addressAllocationIds;
}
/**
* Returns true if the SubnetIds 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 hasSubnetIds() {
return subnetIds != null && !(subnetIds instanceof SdkAutoConstructList);
}
/**
*
* A list of subnet IDs that are required to host your server endpoint in your VPC.
*
*
*
* This property can only be set when EndpointType is set to VPC.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasSubnetIds()} to see if a value was sent in this field.
*
*
* @return A list of subnet IDs that are required to host your server endpoint in your VPC.
*
* This property can only be set when EndpointType is set to VPC.
*
*/
public final List subnetIds() {
return subnetIds;
}
/**
*
* The ID of the VPC endpoint.
*
*
*
* This property can only be set when EndpointType is set to VPC_ENDPOINT.
*
*
* For more information, see
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
*
*
*
* @return The ID of the VPC endpoint.
*
* This property can only be set when EndpointType is set to VPC_ENDPOINT.
*
*
* For more information, see
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
*
*/
public final String vpcEndpointId() {
return vpcEndpointId;
}
/**
*
* The VPC ID of the VPC in which a server's endpoint will be hosted.
*
*
*
* This property can only be set when EndpointType is set to VPC.
*
*
*
* @return The VPC ID of the VPC in which a server's endpoint will be hosted.
*
* This property can only be set when EndpointType is set to VPC.
*
*/
public final String vpcId() {
return vpcId;
}
/**
* Returns true if the SecurityGroupIds 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 hasSecurityGroupIds() {
return securityGroupIds != null && !(securityGroupIds instanceof SdkAutoConstructList);
}
/**
*
* A list of security groups IDs that are available to attach to your server's endpoint.
*
*
*
* This property can only be set when EndpointType is set to VPC.
*
*
* You can edit the SecurityGroupIds property in the UpdateServer API only if
* you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to
* VPC. To change security groups associated with your server's VPC endpoint after creation, use the
* Amazon EC2 ModifyVpcEndpoint
* API.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasSecurityGroupIds()} to see if a value was sent in this field.
*
*
* @return A list of security groups IDs that are available to attach to your server's endpoint.
*
* This property can only be set when EndpointType is set to VPC.
*
*
* You can edit the SecurityGroupIds property in the UpdateServer API
* only if you are changing the EndpointType from PUBLIC or
* VPC_ENDPOINT to VPC. To change security groups associated with your server's
* VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.
*
*/
public final List securityGroupIds() {
return securityGroupIds;
}
@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 + Objects.hashCode(hasAddressAllocationIds() ? addressAllocationIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSubnetIds() ? subnetIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(vpcEndpointId());
hashCode = 31 * hashCode + Objects.hashCode(vpcId());
hashCode = 31 * hashCode + Objects.hashCode(hasSecurityGroupIds() ? securityGroupIds() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EndpointDetails)) {
return false;
}
EndpointDetails other = (EndpointDetails) obj;
return hasAddressAllocationIds() == other.hasAddressAllocationIds()
&& Objects.equals(addressAllocationIds(), other.addressAllocationIds()) && hasSubnetIds() == other.hasSubnetIds()
&& Objects.equals(subnetIds(), other.subnetIds()) && Objects.equals(vpcEndpointId(), other.vpcEndpointId())
&& Objects.equals(vpcId(), other.vpcId()) && hasSecurityGroupIds() == other.hasSecurityGroupIds()
&& Objects.equals(securityGroupIds(), other.securityGroupIds());
}
/**
* 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("EndpointDetails")
.add("AddressAllocationIds", hasAddressAllocationIds() ? addressAllocationIds() : null)
.add("SubnetIds", hasSubnetIds() ? subnetIds() : null).add("VpcEndpointId", vpcEndpointId())
.add("VpcId", vpcId()).add("SecurityGroupIds", hasSecurityGroupIds() ? securityGroupIds() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AddressAllocationIds":
return Optional.ofNullable(clazz.cast(addressAllocationIds()));
case "SubnetIds":
return Optional.ofNullable(clazz.cast(subnetIds()));
case "VpcEndpointId":
return Optional.ofNullable(clazz.cast(vpcEndpointId()));
case "VpcId":
return Optional.ofNullable(clazz.cast(vpcId()));
case "SecurityGroupIds":
return Optional.ofNullable(clazz.cast(securityGroupIds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EndpointDetails) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
*
*
*
* This property can only be set when EndpointType is set to VPC and it is only valid
* in the UpdateServer API.
*
*
*
* @param addressAllocationIds
* A list of address allocation IDs that are required to attach an Elastic IP address to your server's
* endpoint.
*
* This property can only be set when EndpointType is set to VPC and it is only
* valid in the UpdateServer API.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder addressAllocationIds(Collection addressAllocationIds);
/**
*
* A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
*
*
*
* This property can only be set when EndpointType is set to VPC and it is only valid
* in the UpdateServer API.
*
*
*
* @param addressAllocationIds
* A list of address allocation IDs that are required to attach an Elastic IP address to your server's
* endpoint.
*
* This property can only be set when EndpointType is set to VPC and it is only
* valid in the UpdateServer API.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder addressAllocationIds(String... addressAllocationIds);
/**
*
* A list of subnet IDs that are required to host your server endpoint in your VPC.
*
*
*
* This property can only be set when EndpointType is set to VPC.
*
*
*
* @param subnetIds
* A list of subnet IDs that are required to host your server endpoint in your VPC.
*
* This property can only be set when EndpointType is set to VPC.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetIds(Collection subnetIds);
/**
*
* A list of subnet IDs that are required to host your server endpoint in your VPC.
*
*
*
* This property can only be set when EndpointType is set to VPC.
*
*
*
* @param subnetIds
* A list of subnet IDs that are required to host your server endpoint in your VPC.
*
* This property can only be set when EndpointType is set to VPC.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetIds(String... subnetIds);
/**
*
* The ID of the VPC endpoint.
*
*
*
* This property can only be set when EndpointType is set to VPC_ENDPOINT.
*
*
* For more information, see
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
*
*
*
* @param vpcEndpointId
* The ID of the VPC endpoint.
*
* This property can only be set when EndpointType is set to VPC_ENDPOINT.
*
*
* For more information, see
* https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html
* #deprecate-vpc-endpoint.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcEndpointId(String vpcEndpointId);
/**
*
* The VPC ID of the VPC in which a server's endpoint will be hosted.
*
*
*
* This property can only be set when EndpointType is set to VPC.
*
*
*
* @param vpcId
* The VPC ID of the VPC in which a server's endpoint will be hosted.
*
* This property can only be set when EndpointType is set to VPC.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcId(String vpcId);
/**
*
* A list of security groups IDs that are available to attach to your server's endpoint.
*
*
*
* This property can only be set when EndpointType is set to VPC.
*
*
* You can edit the SecurityGroupIds property in the UpdateServer API only
* if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to
* VPC. To change security groups associated with your server's VPC endpoint after creation, use
* the Amazon EC2 ModifyVpcEndpoint
* API.
*
*
*
* @param securityGroupIds
* A list of security groups IDs that are available to attach to your server's endpoint.
*
* This property can only be set when EndpointType is set to VPC.
*
*
* You can edit the SecurityGroupIds property in the UpdateServer
* API only if you are changing the EndpointType from PUBLIC or
* VPC_ENDPOINT to VPC. To change security groups associated with your server's
* VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder securityGroupIds(Collection securityGroupIds);
/**
*
* A list of security groups IDs that are available to attach to your server's endpoint.
*
*
*
* This property can only be set when EndpointType is set to VPC.
*
*
* You can edit the SecurityGroupIds property in the UpdateServer API only
* if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to
* VPC. To change security groups associated with your server's VPC endpoint after creation, use
* the Amazon EC2 ModifyVpcEndpoint
* API.
*
*
*
* @param securityGroupIds
* A list of security groups IDs that are available to attach to your server's endpoint.
*
* This property can only be set when EndpointType is set to VPC.
*
*
* You can edit the SecurityGroupIds property in the UpdateServer
* API only if you are changing the EndpointType from PUBLIC or
* VPC_ENDPOINT to VPC. To change security groups associated with your server's
* VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder securityGroupIds(String... securityGroupIds);
}
static final class BuilderImpl implements Builder {
private List addressAllocationIds = DefaultSdkAutoConstructList.getInstance();
private List subnetIds = DefaultSdkAutoConstructList.getInstance();
private String vpcEndpointId;
private String vpcId;
private List securityGroupIds = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(EndpointDetails model) {
addressAllocationIds(model.addressAllocationIds);
subnetIds(model.subnetIds);
vpcEndpointId(model.vpcEndpointId);
vpcId(model.vpcId);
securityGroupIds(model.securityGroupIds);
}
public final Collection getAddressAllocationIds() {
if (addressAllocationIds instanceof SdkAutoConstructList) {
return null;
}
return addressAllocationIds;
}
@Override
public final Builder addressAllocationIds(Collection addressAllocationIds) {
this.addressAllocationIds = AddressAllocationIdsCopier.copy(addressAllocationIds);
return this;
}
@Override
@SafeVarargs
public final Builder addressAllocationIds(String... addressAllocationIds) {
addressAllocationIds(Arrays.asList(addressAllocationIds));
return this;
}
public final void setAddressAllocationIds(Collection addressAllocationIds) {
this.addressAllocationIds = AddressAllocationIdsCopier.copy(addressAllocationIds);
}
public final Collection getSubnetIds() {
if (subnetIds instanceof SdkAutoConstructList) {
return null;
}
return subnetIds;
}
@Override
public final Builder subnetIds(Collection subnetIds) {
this.subnetIds = SubnetIdsCopier.copy(subnetIds);
return this;
}
@Override
@SafeVarargs
public final Builder subnetIds(String... subnetIds) {
subnetIds(Arrays.asList(subnetIds));
return this;
}
public final void setSubnetIds(Collection subnetIds) {
this.subnetIds = SubnetIdsCopier.copy(subnetIds);
}
public final String getVpcEndpointId() {
return vpcEndpointId;
}
@Override
public final Builder vpcEndpointId(String vpcEndpointId) {
this.vpcEndpointId = vpcEndpointId;
return this;
}
public final void setVpcEndpointId(String vpcEndpointId) {
this.vpcEndpointId = vpcEndpointId;
}
public final String getVpcId() {
return vpcId;
}
@Override
public final Builder vpcId(String vpcId) {
this.vpcId = vpcId;
return this;
}
public final void setVpcId(String vpcId) {
this.vpcId = vpcId;
}
public final Collection getSecurityGroupIds() {
if (securityGroupIds instanceof SdkAutoConstructList) {
return null;
}
return securityGroupIds;
}
@Override
public final Builder securityGroupIds(Collection securityGroupIds) {
this.securityGroupIds = SecurityGroupIdsCopier.copy(securityGroupIds);
return this;
}
@Override
@SafeVarargs
public final Builder securityGroupIds(String... securityGroupIds) {
securityGroupIds(Arrays.asList(securityGroupIds));
return this;
}
public final void setSecurityGroupIds(Collection securityGroupIds) {
this.securityGroupIds = SecurityGroupIdsCopier.copy(securityGroupIds);
}
@Override
public EndpointDetails build() {
return new EndpointDetails(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}