software.amazon.awssdk.services.fms.model.CreateNetworkAclEntriesAction Maven / Gradle / Ivy
Show all versions of fms 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.fms.model;
import java.io.Serializable;
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;
/**
*
* Information about the CreateNetworkAclEntries action in Amazon EC2. This is a remediation option in
* RemediationAction.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateNetworkAclEntriesAction implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateNetworkAclEntriesAction::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField NETWORK_ACL_ID_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("NetworkAclId").getter(getter(CreateNetworkAclEntriesAction::networkAclId))
.setter(setter(Builder::networkAclId)).constructor(ActionTarget::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NetworkAclId").build()).build();
private static final SdkField> NETWORK_ACL_ENTRIES_TO_BE_CREATED_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("NetworkAclEntriesToBeCreated")
.getter(getter(CreateNetworkAclEntriesAction::networkAclEntriesToBeCreated))
.setter(setter(Builder::networkAclEntriesToBeCreated))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NetworkAclEntriesToBeCreated")
.build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EntryDescription::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField FMS_CAN_REMEDIATE_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("FMSCanRemediate").getter(getter(CreateNetworkAclEntriesAction::fmsCanRemediate))
.setter(setter(Builder::fmsCanRemediate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FMSCanRemediate").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESCRIPTION_FIELD,
NETWORK_ACL_ID_FIELD, NETWORK_ACL_ENTRIES_TO_BE_CREATED_FIELD, FMS_CAN_REMEDIATE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Description", DESCRIPTION_FIELD);
put("NetworkAclId", NETWORK_ACL_ID_FIELD);
put("NetworkAclEntriesToBeCreated", NETWORK_ACL_ENTRIES_TO_BE_CREATED_FIELD);
put("FMSCanRemediate", FMS_CAN_REMEDIATE_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String description;
private final ActionTarget networkAclId;
private final List networkAclEntriesToBeCreated;
private final Boolean fmsCanRemediate;
private CreateNetworkAclEntriesAction(BuilderImpl builder) {
this.description = builder.description;
this.networkAclId = builder.networkAclId;
this.networkAclEntriesToBeCreated = builder.networkAclEntriesToBeCreated;
this.fmsCanRemediate = builder.fmsCanRemediate;
}
/**
*
* Brief description of this remediation action.
*
*
* @return Brief description of this remediation action.
*/
public final String description() {
return description;
}
/**
*
* The network ACL that's associated with the remediation action.
*
*
* @return The network ACL that's associated with the remediation action.
*/
public final ActionTarget networkAclId() {
return networkAclId;
}
/**
* For responses, this returns true if the service returned a value for the NetworkAclEntriesToBeCreated 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 hasNetworkAclEntriesToBeCreated() {
return networkAclEntriesToBeCreated != null && !(networkAclEntriesToBeCreated instanceof SdkAutoConstructList);
}
/**
*
* Lists the entries that the remediation action would create.
*
*
* 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 #hasNetworkAclEntriesToBeCreated} method.
*
*
* @return Lists the entries that the remediation action would create.
*/
public final List networkAclEntriesToBeCreated() {
return networkAclEntriesToBeCreated;
}
/**
*
* Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates
* that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some
* kind.
*
*
* @return Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value
* indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a
* conflict of some kind.
*/
public final Boolean fmsCanRemediate() {
return fmsCanRemediate;
}
@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(description());
hashCode = 31 * hashCode + Objects.hashCode(networkAclId());
hashCode = 31 * hashCode + Objects.hashCode(hasNetworkAclEntriesToBeCreated() ? networkAclEntriesToBeCreated() : null);
hashCode = 31 * hashCode + Objects.hashCode(fmsCanRemediate());
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 CreateNetworkAclEntriesAction)) {
return false;
}
CreateNetworkAclEntriesAction other = (CreateNetworkAclEntriesAction) obj;
return Objects.equals(description(), other.description()) && Objects.equals(networkAclId(), other.networkAclId())
&& hasNetworkAclEntriesToBeCreated() == other.hasNetworkAclEntriesToBeCreated()
&& Objects.equals(networkAclEntriesToBeCreated(), other.networkAclEntriesToBeCreated())
&& Objects.equals(fmsCanRemediate(), other.fmsCanRemediate());
}
/**
* 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("CreateNetworkAclEntriesAction").add("Description", description())
.add("NetworkAclId", networkAclId())
.add("NetworkAclEntriesToBeCreated", hasNetworkAclEntriesToBeCreated() ? networkAclEntriesToBeCreated() : null)
.add("FMSCanRemediate", fmsCanRemediate()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "NetworkAclId":
return Optional.ofNullable(clazz.cast(networkAclId()));
case "NetworkAclEntriesToBeCreated":
return Optional.ofNullable(clazz.cast(networkAclEntriesToBeCreated()));
case "FMSCanRemediate":
return Optional.ofNullable(clazz.cast(fmsCanRemediate()));
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((CreateNetworkAclEntriesAction) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Brief description of this remediation action.
*
*
* @param description
* Brief description of this remediation action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The network ACL that's associated with the remediation action.
*
*
* @param networkAclId
* The network ACL that's associated with the remediation action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder networkAclId(ActionTarget networkAclId);
/**
*
* The network ACL that's associated with the remediation action.
*
* This is a convenience method that creates an instance of the {@link ActionTarget.Builder} avoiding the need
* to create one manually via {@link ActionTarget#builder()}.
*
*
* When the {@link Consumer} completes, {@link ActionTarget.Builder#build()} is called immediately and its
* result is passed to {@link #networkAclId(ActionTarget)}.
*
* @param networkAclId
* a consumer that will call methods on {@link ActionTarget.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #networkAclId(ActionTarget)
*/
default Builder networkAclId(Consumer networkAclId) {
return networkAclId(ActionTarget.builder().applyMutation(networkAclId).build());
}
/**
*
* Lists the entries that the remediation action would create.
*
*
* @param networkAclEntriesToBeCreated
* Lists the entries that the remediation action would create.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder networkAclEntriesToBeCreated(Collection networkAclEntriesToBeCreated);
/**
*
* Lists the entries that the remediation action would create.
*
*
* @param networkAclEntriesToBeCreated
* Lists the entries that the remediation action would create.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder networkAclEntriesToBeCreated(EntryDescription... networkAclEntriesToBeCreated);
/**
*
* Lists the entries that the remediation action would create.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fms.model.EntryDescription.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.fms.model.EntryDescription#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.fms.model.EntryDescription.Builder#build()} is called immediately and
* its result is passed to {@link #networkAclEntriesToBeCreated(List)}.
*
* @param networkAclEntriesToBeCreated
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.fms.model.EntryDescription.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #networkAclEntriesToBeCreated(java.util.Collection)
*/
Builder networkAclEntriesToBeCreated(Consumer... networkAclEntriesToBeCreated);
/**
*
* Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value
* indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a
* conflict of some kind.
*
*
* @param fmsCanRemediate
* Indicates whether it is possible for Firewall Manager to perform this remediation action. A false
* value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action
* due to a conflict of some kind.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fmsCanRemediate(Boolean fmsCanRemediate);
}
static final class BuilderImpl implements Builder {
private String description;
private ActionTarget networkAclId;
private List networkAclEntriesToBeCreated = DefaultSdkAutoConstructList.getInstance();
private Boolean fmsCanRemediate;
private BuilderImpl() {
}
private BuilderImpl(CreateNetworkAclEntriesAction model) {
description(model.description);
networkAclId(model.networkAclId);
networkAclEntriesToBeCreated(model.networkAclEntriesToBeCreated);
fmsCanRemediate(model.fmsCanRemediate);
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final ActionTarget.Builder getNetworkAclId() {
return networkAclId != null ? networkAclId.toBuilder() : null;
}
public final void setNetworkAclId(ActionTarget.BuilderImpl networkAclId) {
this.networkAclId = networkAclId != null ? networkAclId.build() : null;
}
@Override
public final Builder networkAclId(ActionTarget networkAclId) {
this.networkAclId = networkAclId;
return this;
}
public final List getNetworkAclEntriesToBeCreated() {
List result = EntriesDescriptionCopier.copyToBuilder(this.networkAclEntriesToBeCreated);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setNetworkAclEntriesToBeCreated(Collection networkAclEntriesToBeCreated) {
this.networkAclEntriesToBeCreated = EntriesDescriptionCopier.copyFromBuilder(networkAclEntriesToBeCreated);
}
@Override
public final Builder networkAclEntriesToBeCreated(Collection networkAclEntriesToBeCreated) {
this.networkAclEntriesToBeCreated = EntriesDescriptionCopier.copy(networkAclEntriesToBeCreated);
return this;
}
@Override
@SafeVarargs
public final Builder networkAclEntriesToBeCreated(EntryDescription... networkAclEntriesToBeCreated) {
networkAclEntriesToBeCreated(Arrays.asList(networkAclEntriesToBeCreated));
return this;
}
@Override
@SafeVarargs
public final Builder networkAclEntriesToBeCreated(Consumer... networkAclEntriesToBeCreated) {
networkAclEntriesToBeCreated(Stream.of(networkAclEntriesToBeCreated)
.map(c -> EntryDescription.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Boolean getFmsCanRemediate() {
return fmsCanRemediate;
}
public final void setFmsCanRemediate(Boolean fmsCanRemediate) {
this.fmsCanRemediate = fmsCanRemediate;
}
@Override
public final Builder fmsCanRemediate(Boolean fmsCanRemediate) {
this.fmsCanRemediate = fmsCanRemediate;
return this;
}
@Override
public CreateNetworkAclEntriesAction build() {
return new CreateNetworkAclEntriesAction(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}