software.amazon.awssdk.services.accessanalyzer.model.CheckNoNewAccessResponse 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.accessanalyzer.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.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 CheckNoNewAccessResponse extends AccessAnalyzerResponse implements
ToCopyableBuilder {
private static final SdkField RESULT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("result")
.getter(getter(CheckNoNewAccessResponse::resultAsString)).setter(setter(Builder::result))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("result").build()).build();
private static final SdkField MESSAGE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("message")
.getter(getter(CheckNoNewAccessResponse::message)).setter(setter(Builder::message))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("message").build()).build();
private static final SdkField> REASONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("reasons")
.getter(getter(CheckNoNewAccessResponse::reasons))
.setter(setter(Builder::reasons))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("reasons").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ReasonSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESULT_FIELD, MESSAGE_FIELD,
REASONS_FIELD));
private final String result;
private final String message;
private final List reasons;
private CheckNoNewAccessResponse(BuilderImpl builder) {
super(builder);
this.result = builder.result;
this.message = builder.message;
this.reasons = builder.reasons;
}
/**
*
* The result of the check for new access. If the result is PASS, no new access is allowed by the
* updated policy. If the result is FAIL, the updated policy might allow new access.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #result} will
* return {@link CheckNoNewAccessResult#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #resultAsString}.
*
*
* @return The result of the check for new access. If the result is PASS, no new access is allowed by
* the updated policy. If the result is FAIL, the updated policy might allow new access.
* @see CheckNoNewAccessResult
*/
public final CheckNoNewAccessResult result() {
return CheckNoNewAccessResult.fromValue(result);
}
/**
*
* The result of the check for new access. If the result is PASS, no new access is allowed by the
* updated policy. If the result is FAIL, the updated policy might allow new access.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #result} will
* return {@link CheckNoNewAccessResult#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #resultAsString}.
*
*
* @return The result of the check for new access. If the result is PASS, no new access is allowed by
* the updated policy. If the result is FAIL, the updated policy might allow new access.
* @see CheckNoNewAccessResult
*/
public final String resultAsString() {
return result;
}
/**
*
* The message indicating whether the updated policy allows new access.
*
*
* @return The message indicating whether the updated policy allows new access.
*/
public final String message() {
return message;
}
/**
* For responses, this returns true if the service returned a value for the Reasons 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 hasReasons() {
return reasons != null && !(reasons instanceof SdkAutoConstructList);
}
/**
*
* A description of the reasoning of the result.
*
*
* 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 #hasReasons} method.
*
*
* @return A description of the reasoning of the result.
*/
public final List reasons() {
return reasons;
}
@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(resultAsString());
hashCode = 31 * hashCode + Objects.hashCode(message());
hashCode = 31 * hashCode + Objects.hashCode(hasReasons() ? reasons() : 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 CheckNoNewAccessResponse)) {
return false;
}
CheckNoNewAccessResponse other = (CheckNoNewAccessResponse) obj;
return Objects.equals(resultAsString(), other.resultAsString()) && Objects.equals(message(), other.message())
&& hasReasons() == other.hasReasons() && Objects.equals(reasons(), other.reasons());
}
/**
* 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("CheckNoNewAccessResponse").add("Result", resultAsString()).add("Message", message())
.add("Reasons", hasReasons() ? reasons() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "result":
return Optional.ofNullable(clazz.cast(resultAsString()));
case "message":
return Optional.ofNullable(clazz.cast(message()));
case "reasons":
return Optional.ofNullable(clazz.cast(reasons()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CheckNoNewAccessResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AccessAnalyzerResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The result of the check for new access. If the result is PASS, no new access is allowed by the
* updated policy. If the result is FAIL, the updated policy might allow new access.
*
*
* @param result
* The result of the check for new access. If the result is PASS, no new access is allowed
* by the updated policy. If the result is FAIL, the updated policy might allow new access.
* @see CheckNoNewAccessResult
* @return Returns a reference to this object so that method calls can be chained together.
* @see CheckNoNewAccessResult
*/
Builder result(String result);
/**
*
* The result of the check for new access. If the result is PASS, no new access is allowed by the
* updated policy. If the result is FAIL, the updated policy might allow new access.
*
*
* @param result
* The result of the check for new access. If the result is PASS, no new access is allowed
* by the updated policy. If the result is FAIL, the updated policy might allow new access.
* @see CheckNoNewAccessResult
* @return Returns a reference to this object so that method calls can be chained together.
* @see CheckNoNewAccessResult
*/
Builder result(CheckNoNewAccessResult result);
/**
*
* The message indicating whether the updated policy allows new access.
*
*
* @param message
* The message indicating whether the updated policy allows new access.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder message(String message);
/**
*
* A description of the reasoning of the result.
*
*
* @param reasons
* A description of the reasoning of the result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reasons(Collection reasons);
/**
*
* A description of the reasoning of the result.
*
*
* @param reasons
* A description of the reasoning of the result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reasons(ReasonSummary... reasons);
/**
*
* A description of the reasoning of the result.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.accessanalyzer.model.ReasonSummary.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.accessanalyzer.model.ReasonSummary#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.accessanalyzer.model.ReasonSummary.Builder#build()} is called
* immediately and its result is passed to {@link #reasons(List)}.
*
* @param reasons
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.accessanalyzer.model.ReasonSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #reasons(java.util.Collection)
*/
Builder reasons(Consumer... reasons);
}
static final class BuilderImpl extends AccessAnalyzerResponse.BuilderImpl implements Builder {
private String result;
private String message;
private List reasons = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CheckNoNewAccessResponse model) {
super(model);
result(model.result);
message(model.message);
reasons(model.reasons);
}
public final String getResult() {
return result;
}
public final void setResult(String result) {
this.result = result;
}
@Override
public final Builder result(String result) {
this.result = result;
return this;
}
@Override
public final Builder result(CheckNoNewAccessResult result) {
this.result(result == null ? null : result.toString());
return this;
}
public final String getMessage() {
return message;
}
public final void setMessage(String message) {
this.message = message;
}
@Override
public final Builder message(String message) {
this.message = message;
return this;
}
public final List getReasons() {
List result = ReasonSummaryListCopier.copyToBuilder(this.reasons);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setReasons(Collection reasons) {
this.reasons = ReasonSummaryListCopier.copyFromBuilder(reasons);
}
@Override
public final Builder reasons(Collection reasons) {
this.reasons = ReasonSummaryListCopier.copy(reasons);
return this;
}
@Override
@SafeVarargs
public final Builder reasons(ReasonSummary... reasons) {
reasons(Arrays.asList(reasons));
return this;
}
@Override
@SafeVarargs
public final Builder reasons(Consumer... reasons) {
reasons(Stream.of(reasons).map(c -> ReasonSummary.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public CheckNoNewAccessResponse build() {
return new CheckNoNewAccessResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}