software.amazon.awssdk.services.fms.model.PutPolicyRequest 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.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.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 PutPolicyRequest extends FmsRequest implements ToCopyableBuilder {
private static final SdkField POLICY_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("Policy")
.getter(getter(PutPolicyRequest::policy)).setter(setter(Builder::policy)).constructor(Policy::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Policy").build()).build();
private static final SdkField> TAG_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TagList")
.getter(getter(PutPolicyRequest::tagList))
.setter(setter(Builder::tagList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POLICY_FIELD, TAG_LIST_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Policy", POLICY_FIELD);
put("TagList", TAG_LIST_FIELD);
}
});
private final Policy policy;
private final List tagList;
private PutPolicyRequest(BuilderImpl builder) {
super(builder);
this.policy = builder.policy;
this.tagList = builder.tagList;
}
/**
*
* The details of the Firewall Manager policy to be created.
*
*
* @return The details of the Firewall Manager policy to be created.
*/
public final Policy policy() {
return policy;
}
/**
* For responses, this returns true if the service returned a value for the TagList 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 hasTagList() {
return tagList != null && !(tagList instanceof SdkAutoConstructList);
}
/**
*
* The tags to add to the Amazon Web Services resource.
*
*
* 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 #hasTagList} method.
*
*
* @return The tags to add to the Amazon Web Services resource.
*/
public final List tagList() {
return tagList;
}
@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(policy());
hashCode = 31 * hashCode + Objects.hashCode(hasTagList() ? tagList() : 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 PutPolicyRequest)) {
return false;
}
PutPolicyRequest other = (PutPolicyRequest) obj;
return Objects.equals(policy(), other.policy()) && hasTagList() == other.hasTagList()
&& Objects.equals(tagList(), other.tagList());
}
/**
* 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("PutPolicyRequest").add("Policy", policy()).add("TagList", hasTagList() ? tagList() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Policy":
return Optional.ofNullable(clazz.cast(policy()));
case "TagList":
return Optional.ofNullable(clazz.cast(tagList()));
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((PutPolicyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends FmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The details of the Firewall Manager policy to be created.
*
*
* @param policy
* The details of the Firewall Manager policy to be created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policy(Policy policy);
/**
*
* The details of the Firewall Manager policy to be created.
*
* This is a convenience method that creates an instance of the {@link Policy.Builder} avoiding the need to
* create one manually via {@link Policy#builder()}.
*
*
* When the {@link Consumer} completes, {@link Policy.Builder#build()} is called immediately and its result is
* passed to {@link #policy(Policy)}.
*
* @param policy
* a consumer that will call methods on {@link Policy.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #policy(Policy)
*/
default Builder policy(Consumer policy) {
return policy(Policy.builder().applyMutation(policy).build());
}
/**
*
* The tags to add to the Amazon Web Services resource.
*
*
* @param tagList
* The tags to add to the Amazon Web Services resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagList(Collection tagList);
/**
*
* The tags to add to the Amazon Web Services resource.
*
*
* @param tagList
* The tags to add to the Amazon Web Services resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagList(Tag... tagList);
/**
*
* The tags to add to the Amazon Web Services resource.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fms.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.fms.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.fms.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tagList(List)}.
*
* @param tagList
* a consumer that will call methods on {@link software.amazon.awssdk.services.fms.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tagList(java.util.Collection)
*/
Builder tagList(Consumer... tagList);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends FmsRequest.BuilderImpl implements Builder {
private Policy policy;
private List tagList = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PutPolicyRequest model) {
super(model);
policy(model.policy);
tagList(model.tagList);
}
public final Policy.Builder getPolicy() {
return policy != null ? policy.toBuilder() : null;
}
public final void setPolicy(Policy.BuilderImpl policy) {
this.policy = policy != null ? policy.build() : null;
}
@Override
public final Builder policy(Policy policy) {
this.policy = policy;
return this;
}
public final List getTagList() {
List result = TagListCopier.copyToBuilder(this.tagList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTagList(Collection tagList) {
this.tagList = TagListCopier.copyFromBuilder(tagList);
}
@Override
public final Builder tagList(Collection tagList) {
this.tagList = TagListCopier.copy(tagList);
return this;
}
@Override
@SafeVarargs
public final Builder tagList(Tag... tagList) {
tagList(Arrays.asList(tagList));
return this;
}
@Override
@SafeVarargs
public final Builder tagList(Consumer... tagList) {
tagList(Stream.of(tagList).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutPolicyRequest build() {
return new PutPolicyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}