software.amazon.awssdk.services.ec2.model.DescribeNetworkInterfaceAttributeResponse Maven / Gradle / Ivy
Show all versions of ec2 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.ec2.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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;
/**
*
* Contains the output of DescribeNetworkInterfaceAttribute.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeNetworkInterfaceAttributeResponse extends Ec2Response implements
ToCopyableBuilder {
private static final SdkField ATTACHMENT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("Attachment")
.getter(getter(DescribeNetworkInterfaceAttributeResponse::attachment))
.setter(setter(Builder::attachment))
.constructor(NetworkInterfaceAttachment::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Attachment")
.unmarshallLocationName("attachment").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("Description")
.getter(getter(DescribeNetworkInterfaceAttributeResponse::description))
.setter(setter(Builder::description))
.constructor(AttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description")
.unmarshallLocationName("description").build()).build();
private static final SdkField> GROUPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Groups")
.getter(getter(DescribeNetworkInterfaceAttributeResponse::groups))
.setter(setter(Builder::groups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupSet")
.unmarshallLocationName("groupSet").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(GroupIdentifier::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField NETWORK_INTERFACE_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NetworkInterfaceId")
.getter(getter(DescribeNetworkInterfaceAttributeResponse::networkInterfaceId))
.setter(setter(Builder::networkInterfaceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NetworkInterfaceId")
.unmarshallLocationName("networkInterfaceId").build()).build();
private static final SdkField SOURCE_DEST_CHECK_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("SourceDestCheck")
.getter(getter(DescribeNetworkInterfaceAttributeResponse::sourceDestCheck))
.setter(setter(Builder::sourceDestCheck))
.constructor(AttributeBooleanValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceDestCheck")
.unmarshallLocationName("sourceDestCheck").build()).build();
private static final SdkField ASSOCIATE_PUBLIC_IP_ADDRESS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("AssociatePublicIpAddress")
.getter(getter(DescribeNetworkInterfaceAttributeResponse::associatePublicIpAddress))
.setter(setter(Builder::associatePublicIpAddress))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AssociatePublicIpAddress")
.unmarshallLocationName("associatePublicIpAddress").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ATTACHMENT_FIELD,
DESCRIPTION_FIELD, GROUPS_FIELD, NETWORK_INTERFACE_ID_FIELD, SOURCE_DEST_CHECK_FIELD,
ASSOCIATE_PUBLIC_IP_ADDRESS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Attachment", ATTACHMENT_FIELD);
put("Description", DESCRIPTION_FIELD);
put("GroupSet", GROUPS_FIELD);
put("NetworkInterfaceId", NETWORK_INTERFACE_ID_FIELD);
put("SourceDestCheck", SOURCE_DEST_CHECK_FIELD);
put("AssociatePublicIpAddress", ASSOCIATE_PUBLIC_IP_ADDRESS_FIELD);
}
});
private final NetworkInterfaceAttachment attachment;
private final AttributeValue description;
private final List groups;
private final String networkInterfaceId;
private final AttributeBooleanValue sourceDestCheck;
private final Boolean associatePublicIpAddress;
private DescribeNetworkInterfaceAttributeResponse(BuilderImpl builder) {
super(builder);
this.attachment = builder.attachment;
this.description = builder.description;
this.groups = builder.groups;
this.networkInterfaceId = builder.networkInterfaceId;
this.sourceDestCheck = builder.sourceDestCheck;
this.associatePublicIpAddress = builder.associatePublicIpAddress;
}
/**
*
* The attachment (if any) of the network interface.
*
*
* @return The attachment (if any) of the network interface.
*/
public final NetworkInterfaceAttachment attachment() {
return attachment;
}
/**
*
* The description of the network interface.
*
*
* @return The description of the network interface.
*/
public final AttributeValue description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the Groups property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasGroups() {
return groups != null && !(groups instanceof SdkAutoConstructList);
}
/**
*
* The security groups associated with the network interface.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasGroups} method.
*
*
* @return The security groups associated with the network interface.
*/
public final List groups() {
return groups;
}
/**
*
* The ID of the network interface.
*
*
* @return The ID of the network interface.
*/
public final String networkInterfaceId() {
return networkInterfaceId;
}
/**
*
* Indicates whether source/destination checking is enabled.
*
*
* @return Indicates whether source/destination checking is enabled.
*/
public final AttributeBooleanValue sourceDestCheck() {
return sourceDestCheck;
}
/**
*
* Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any
* network interface but will only apply to the primary network interface (eth0).
*
*
* @return Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for
* any network interface but will only apply to the primary network interface (eth0).
*/
public final Boolean associatePublicIpAddress() {
return associatePublicIpAddress;
}
@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(attachment());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasGroups() ? groups() : null);
hashCode = 31 * hashCode + Objects.hashCode(networkInterfaceId());
hashCode = 31 * hashCode + Objects.hashCode(sourceDestCheck());
hashCode = 31 * hashCode + Objects.hashCode(associatePublicIpAddress());
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 DescribeNetworkInterfaceAttributeResponse)) {
return false;
}
DescribeNetworkInterfaceAttributeResponse other = (DescribeNetworkInterfaceAttributeResponse) obj;
return Objects.equals(attachment(), other.attachment()) && Objects.equals(description(), other.description())
&& hasGroups() == other.hasGroups() && Objects.equals(groups(), other.groups())
&& Objects.equals(networkInterfaceId(), other.networkInterfaceId())
&& Objects.equals(sourceDestCheck(), other.sourceDestCheck())
&& Objects.equals(associatePublicIpAddress(), other.associatePublicIpAddress());
}
/**
* 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("DescribeNetworkInterfaceAttributeResponse").add("Attachment", attachment())
.add("Description", description()).add("Groups", hasGroups() ? groups() : null)
.add("NetworkInterfaceId", networkInterfaceId()).add("SourceDestCheck", sourceDestCheck())
.add("AssociatePublicIpAddress", associatePublicIpAddress()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Attachment":
return Optional.ofNullable(clazz.cast(attachment()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Groups":
return Optional.ofNullable(clazz.cast(groups()));
case "NetworkInterfaceId":
return Optional.ofNullable(clazz.cast(networkInterfaceId()));
case "SourceDestCheck":
return Optional.ofNullable(clazz.cast(sourceDestCheck()));
case "AssociatePublicIpAddress":
return Optional.ofNullable(clazz.cast(associatePublicIpAddress()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeNetworkInterfaceAttributeResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Response.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The attachment (if any) of the network interface.
*
*
* @param attachment
* The attachment (if any) of the network interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attachment(NetworkInterfaceAttachment attachment);
/**
*
* The attachment (if any) of the network interface.
*
* This is a convenience method that creates an instance of the {@link NetworkInterfaceAttachment.Builder}
* avoiding the need to create one manually via {@link NetworkInterfaceAttachment#builder()}.
*
*
* When the {@link Consumer} completes, {@link NetworkInterfaceAttachment.Builder#build()} is called immediately
* and its result is passed to {@link #attachment(NetworkInterfaceAttachment)}.
*
* @param attachment
* a consumer that will call methods on {@link NetworkInterfaceAttachment.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #attachment(NetworkInterfaceAttachment)
*/
default Builder attachment(Consumer attachment) {
return attachment(NetworkInterfaceAttachment.builder().applyMutation(attachment).build());
}
/**
*
* The description of the network interface.
*
*
* @param description
* The description of the network interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(AttributeValue description);
/**
*
* The description of the network interface.
*
* This is a convenience method that creates an instance of the {@link AttributeValue.Builder} avoiding the need
* to create one manually via {@link AttributeValue#builder()}.
*
*
* When the {@link Consumer} completes, {@link AttributeValue.Builder#build()} is called immediately and its
* result is passed to {@link #description(AttributeValue)}.
*
* @param description
* a consumer that will call methods on {@link AttributeValue.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #description(AttributeValue)
*/
default Builder description(Consumer description) {
return description(AttributeValue.builder().applyMutation(description).build());
}
/**
*
* The security groups associated with the network interface.
*
*
* @param groups
* The security groups associated with the network interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groups(Collection groups);
/**
*
* The security groups associated with the network interface.
*
*
* @param groups
* The security groups associated with the network interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groups(GroupIdentifier... groups);
/**
*
* The security groups associated with the network interface.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ec2.model.GroupIdentifier.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ec2.model.GroupIdentifier#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ec2.model.GroupIdentifier.Builder#build()} is called immediately and
* its result is passed to {@link #groups(List)}.
*
* @param groups
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ec2.model.GroupIdentifier.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #groups(java.util.Collection)
*/
Builder groups(Consumer... groups);
/**
*
* The ID of the network interface.
*
*
* @param networkInterfaceId
* The ID of the network interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder networkInterfaceId(String networkInterfaceId);
/**
*
* Indicates whether source/destination checking is enabled.
*
*
* @param sourceDestCheck
* Indicates whether source/destination checking is enabled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceDestCheck(AttributeBooleanValue sourceDestCheck);
/**
*
* Indicates whether source/destination checking is enabled.
*
* This is a convenience method that creates an instance of the {@link AttributeBooleanValue.Builder} avoiding
* the need to create one manually via {@link AttributeBooleanValue#builder()}.
*
*
* When the {@link Consumer} completes, {@link AttributeBooleanValue.Builder#build()} is called immediately and
* its result is passed to {@link #sourceDestCheck(AttributeBooleanValue)}.
*
* @param sourceDestCheck
* a consumer that will call methods on {@link AttributeBooleanValue.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #sourceDestCheck(AttributeBooleanValue)
*/
default Builder sourceDestCheck(Consumer sourceDestCheck) {
return sourceDestCheck(AttributeBooleanValue.builder().applyMutation(sourceDestCheck).build());
}
/**
*
* Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any
* network interface but will only apply to the primary network interface (eth0).
*
*
* @param associatePublicIpAddress
* Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled
* for any network interface but will only apply to the primary network interface (eth0).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder associatePublicIpAddress(Boolean associatePublicIpAddress);
}
static final class BuilderImpl extends Ec2Response.BuilderImpl implements Builder {
private NetworkInterfaceAttachment attachment;
private AttributeValue description;
private List groups = DefaultSdkAutoConstructList.getInstance();
private String networkInterfaceId;
private AttributeBooleanValue sourceDestCheck;
private Boolean associatePublicIpAddress;
private BuilderImpl() {
}
private BuilderImpl(DescribeNetworkInterfaceAttributeResponse model) {
super(model);
attachment(model.attachment);
description(model.description);
groups(model.groups);
networkInterfaceId(model.networkInterfaceId);
sourceDestCheck(model.sourceDestCheck);
associatePublicIpAddress(model.associatePublicIpAddress);
}
public final NetworkInterfaceAttachment.Builder getAttachment() {
return attachment != null ? attachment.toBuilder() : null;
}
public final void setAttachment(NetworkInterfaceAttachment.BuilderImpl attachment) {
this.attachment = attachment != null ? attachment.build() : null;
}
@Override
public final Builder attachment(NetworkInterfaceAttachment attachment) {
this.attachment = attachment;
return this;
}
public final AttributeValue.Builder getDescription() {
return description != null ? description.toBuilder() : null;
}
public final void setDescription(AttributeValue.BuilderImpl description) {
this.description = description != null ? description.build() : null;
}
@Override
public final Builder description(AttributeValue description) {
this.description = description;
return this;
}
public final List getGroups() {
List result = GroupIdentifierListCopier.copyToBuilder(this.groups);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setGroups(Collection groups) {
this.groups = GroupIdentifierListCopier.copyFromBuilder(groups);
}
@Override
public final Builder groups(Collection groups) {
this.groups = GroupIdentifierListCopier.copy(groups);
return this;
}
@Override
@SafeVarargs
public final Builder groups(GroupIdentifier... groups) {
groups(Arrays.asList(groups));
return this;
}
@Override
@SafeVarargs
public final Builder groups(Consumer... groups) {
groups(Stream.of(groups).map(c -> GroupIdentifier.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getNetworkInterfaceId() {
return networkInterfaceId;
}
public final void setNetworkInterfaceId(String networkInterfaceId) {
this.networkInterfaceId = networkInterfaceId;
}
@Override
public final Builder networkInterfaceId(String networkInterfaceId) {
this.networkInterfaceId = networkInterfaceId;
return this;
}
public final AttributeBooleanValue.Builder getSourceDestCheck() {
return sourceDestCheck != null ? sourceDestCheck.toBuilder() : null;
}
public final void setSourceDestCheck(AttributeBooleanValue.BuilderImpl sourceDestCheck) {
this.sourceDestCheck = sourceDestCheck != null ? sourceDestCheck.build() : null;
}
@Override
public final Builder sourceDestCheck(AttributeBooleanValue sourceDestCheck) {
this.sourceDestCheck = sourceDestCheck;
return this;
}
public final Boolean getAssociatePublicIpAddress() {
return associatePublicIpAddress;
}
public final void setAssociatePublicIpAddress(Boolean associatePublicIpAddress) {
this.associatePublicIpAddress = associatePublicIpAddress;
}
@Override
public final Builder associatePublicIpAddress(Boolean associatePublicIpAddress) {
this.associatePublicIpAddress = associatePublicIpAddress;
return this;
}
@Override
public DescribeNetworkInterfaceAttributeResponse build() {
return new DescribeNetworkInterfaceAttributeResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}