software.amazon.awssdk.services.workmail.model.GetAccessControlEffectResponse Maven / Gradle / Ivy
Show all versions of workmail 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.workmail.model;
import java.beans.Transient;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetAccessControlEffectResponse extends WorkMailResponse implements
ToCopyableBuilder {
private static final SdkField EFFECT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Effect")
.getter(getter(GetAccessControlEffectResponse::effectAsString)).setter(setter(Builder::effect))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Effect").build()).build();
private static final SdkField> MATCHED_RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MatchedRules")
.getter(getter(GetAccessControlEffectResponse::matchedRules))
.setter(setter(Builder::matchedRules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MatchedRules").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(EFFECT_FIELD,
MATCHED_RULES_FIELD));
private final String effect;
private final List matchedRules;
private GetAccessControlEffectResponse(BuilderImpl builder) {
super(builder);
this.effect = builder.effect;
this.matchedRules = builder.matchedRules;
}
/**
*
* The rule effect.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #effect} will
* return {@link AccessControlRuleEffect#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #effectAsString}.
*
*
* @return The rule effect.
* @see AccessControlRuleEffect
*/
public final AccessControlRuleEffect effect() {
return AccessControlRuleEffect.fromValue(effect);
}
/**
*
* The rule effect.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #effect} will
* return {@link AccessControlRuleEffect#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #effectAsString}.
*
*
* @return The rule effect.
* @see AccessControlRuleEffect
*/
public final String effectAsString() {
return effect;
}
/**
* For responses, this returns true if the service returned a value for the MatchedRules 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 hasMatchedRules() {
return matchedRules != null && !(matchedRules instanceof SdkAutoConstructList);
}
/**
*
* The rules that match the given parameters, resulting in an effect.
*
*
* 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 #hasMatchedRules} method.
*
*
* @return The rules that match the given parameters, resulting in an effect.
*/
public final List matchedRules() {
return matchedRules;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(effectAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasMatchedRules() ? matchedRules() : 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 GetAccessControlEffectResponse)) {
return false;
}
GetAccessControlEffectResponse other = (GetAccessControlEffectResponse) obj;
return Objects.equals(effectAsString(), other.effectAsString()) && hasMatchedRules() == other.hasMatchedRules()
&& Objects.equals(matchedRules(), other.matchedRules());
}
/**
* 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("GetAccessControlEffectResponse").add("Effect", effectAsString())
.add("MatchedRules", hasMatchedRules() ? matchedRules() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Effect":
return Optional.ofNullable(clazz.cast(effectAsString()));
case "MatchedRules":
return Optional.ofNullable(clazz.cast(matchedRules()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function