software.amazon.awssdk.services.ec2.model.CreateSecurityGroupRequest Maven / Gradle / Ivy
/*
* 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.List;
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.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateSecurityGroupRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Description")
.getter(getter(CreateSecurityGroupRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupDescription")
.unmarshallLocationName("GroupDescription").build()).build();
private static final SdkField GROUP_NAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("GroupName")
.getter(getter(CreateSecurityGroupRequest::groupName))
.setter(setter(Builder::groupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupName")
.unmarshallLocationName("GroupName").build()).build();
private static final SdkField VPC_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("VpcId")
.getter(getter(CreateSecurityGroupRequest::vpcId))
.setter(setter(Builder::vpcId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcId")
.unmarshallLocationName("VpcId").build()).build();
private static final SdkField> TAG_SPECIFICATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TagSpecifications")
.getter(getter(CreateSecurityGroupRequest::tagSpecifications))
.setter(setter(Builder::tagSpecifications))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagSpecification")
.unmarshallLocationName("TagSpecification").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(TagSpecification::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESCRIPTION_FIELD,
GROUP_NAME_FIELD, VPC_ID_FIELD, TAG_SPECIFICATIONS_FIELD));
private final String description;
private final String groupName;
private final String vpcId;
private final List tagSpecifications;
private CreateSecurityGroupRequest(BuilderImpl builder) {
super(builder);
this.description = builder.description;
this.groupName = builder.groupName;
this.vpcId = builder.vpcId;
this.tagSpecifications = builder.tagSpecifications;
}
/**
*
* A description for the security group. This is informational only.
*
*
* Constraints: Up to 255 characters in length
*
*
* Constraints for EC2-Classic: ASCII characters
*
*
* Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
*
*
* @return A description for the security group. This is informational only.
*
* Constraints: Up to 255 characters in length
*
*
* Constraints for EC2-Classic: ASCII characters
*
*
* Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
*/
public String description() {
return description;
}
/**
*
* The name of the security group.
*
*
* Constraints: Up to 255 characters in length. Cannot start with sg-.
*
*
* Constraints for EC2-Classic: ASCII characters
*
*
* Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
*
*
* @return The name of the security group.
*
* Constraints: Up to 255 characters in length. Cannot start with sg-.
*
*
* Constraints for EC2-Classic: ASCII characters
*
*
* Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
*/
public String groupName() {
return groupName;
}
/**
*
* [EC2-VPC] The ID of the VPC. Required for EC2-VPC.
*
*
* @return [EC2-VPC] The ID of the VPC. Required for EC2-VPC.
*/
public String vpcId() {
return vpcId;
}
/**
* Returns true if the TagSpecifications 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 boolean hasTagSpecifications() {
return tagSpecifications != null && !(tagSpecifications instanceof SdkAutoConstructList);
}
/**
*
* The tags to assign to the security group.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTagSpecifications()} to see if a value was sent in this field.
*
*
* @return The tags to assign to the security group.
*/
public List tagSpecifications() {
return tagSpecifications;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(groupName());
hashCode = 31 * hashCode + Objects.hashCode(vpcId());
hashCode = 31 * hashCode + Objects.hashCode(tagSpecifications());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateSecurityGroupRequest)) {
return false;
}
CreateSecurityGroupRequest other = (CreateSecurityGroupRequest) obj;
return Objects.equals(description(), other.description()) && Objects.equals(groupName(), other.groupName())
&& Objects.equals(vpcId(), other.vpcId()) && Objects.equals(tagSpecifications(), other.tagSpecifications());
}
/**
* 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 String toString() {
return ToString.builder("CreateSecurityGroupRequest").add("Description", description()).add("GroupName", groupName())
.add("VpcId", vpcId()).add("TagSpecifications", tagSpecifications()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "GroupName":
return Optional.ofNullable(clazz.cast(groupName()));
case "VpcId":
return Optional.ofNullable(clazz.cast(vpcId()));
case "TagSpecifications":
return Optional.ofNullable(clazz.cast(tagSpecifications()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateSecurityGroupRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* A description for the security group. This is informational only.
*
*
* Constraints: Up to 255 characters in length
*
*
* Constraints for EC2-Classic: ASCII characters
*
*
* Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
*
*
* @param description
* A description for the security group. This is informational only.
*
* Constraints: Up to 255 characters in length
*
*
* Constraints for EC2-Classic: ASCII characters
*
*
* Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The name of the security group.
*
*
* Constraints: Up to 255 characters in length. Cannot start with sg-.
*
*
* Constraints for EC2-Classic: ASCII characters
*
*
* Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
*
*
* @param groupName
* The name of the security group.
*
* Constraints: Up to 255 characters in length. Cannot start with sg-.
*
*
* Constraints for EC2-Classic: ASCII characters
*
*
* Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupName(String groupName);
/**
*
* [EC2-VPC] The ID of the VPC. Required for EC2-VPC.
*
*
* @param vpcId
* [EC2-VPC] The ID of the VPC. Required for EC2-VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcId(String vpcId);
/**
*
* The tags to assign to the security group.
*
*
* @param tagSpecifications
* The tags to assign to the security group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagSpecifications(Collection tagSpecifications);
/**
*
* The tags to assign to the security group.
*
*
* @param tagSpecifications
* The tags to assign to the security group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagSpecifications(TagSpecification... tagSpecifications);
/**
*
* The tags to assign to the security group.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #tagSpecifications(List)}.
*
* @param tagSpecifications
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tagSpecifications(List)
*/
Builder tagSpecifications(Consumer... tagSpecifications);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Ec2Request.BuilderImpl implements Builder {
private String description;
private String groupName;
private String vpcId;
private List tagSpecifications = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateSecurityGroupRequest model) {
super(model);
description(model.description);
groupName(model.groupName);
vpcId(model.vpcId);
tagSpecifications(model.tagSpecifications);
}
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 String getGroupName() {
return groupName;
}
@Override
public final Builder groupName(String groupName) {
this.groupName = groupName;
return this;
}
public final void setGroupName(String groupName) {
this.groupName = groupName;
}
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 getTagSpecifications() {
return tagSpecifications != null ? tagSpecifications.stream().map(TagSpecification::toBuilder)
.collect(Collectors.toList()) : null;
}
@Override
public final Builder tagSpecifications(Collection tagSpecifications) {
this.tagSpecifications = TagSpecificationListCopier.copy(tagSpecifications);
return this;
}
@Override
@SafeVarargs
public final Builder tagSpecifications(TagSpecification... tagSpecifications) {
tagSpecifications(Arrays.asList(tagSpecifications));
return this;
}
@Override
@SafeVarargs
public final Builder tagSpecifications(Consumer... tagSpecifications) {
tagSpecifications(Stream.of(tagSpecifications).map(c -> TagSpecification.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setTagSpecifications(Collection tagSpecifications) {
this.tagSpecifications = TagSpecificationListCopier.copyFromBuilder(tagSpecifications);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateSecurityGroupRequest build() {
return new CreateSecurityGroupRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}