software.amazon.awssdk.services.shield.model.InvalidParameterException 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.shield.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
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.exception.AwsErrorDetails;
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.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes
* details in additional properties.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class InvalidParameterException extends ShieldException implements
ToCopyableBuilder {
private static final SdkField REASON_FIELD = SdkField. builder(MarshallingType.STRING).memberName("reason")
.getter(getter(InvalidParameterException::reasonAsString)).setter(setter(Builder::reason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("reason").build()).build();
private static final SdkField> FIELDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("fields")
.getter(getter(InvalidParameterException::fields))
.setter(setter(Builder::fields))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("fields").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ValidationExceptionField::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REASON_FIELD, FIELDS_FIELD));
private static final long serialVersionUID = 1L;
private final String reason;
private final List fields;
private InvalidParameterException(BuilderImpl builder) {
super(builder);
this.reason = builder.reason;
this.fields = builder.fields;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
/**
*
* Additional information about the exception.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #reason} will
* return {@link ValidationExceptionReason#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #reasonAsString}.
*
*
* @return Additional information about the exception.
* @see ValidationExceptionReason
*/
public ValidationExceptionReason reason() {
return ValidationExceptionReason.fromValue(reason);
}
/**
*
* Additional information about the exception.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #reason} will
* return {@link ValidationExceptionReason#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #reasonAsString}.
*
*
* @return Additional information about the exception.
* @see ValidationExceptionReason
*/
public String reasonAsString() {
return reason;
}
/**
* Returns true if the Fields 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 hasFields() {
return fields != null && !(fields instanceof SdkAutoConstructList);
}
/**
*
* Fields that caused the exception.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasFields()} to see if a value was sent in this field.
*
*
* @return Fields that caused the exception.
*/
public List fields() {
return fields;
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((InvalidParameterException) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder, ShieldException.Builder {
/**
*
* Additional information about the exception.
*
*
* @param reason
* Additional information about the exception.
* @see ValidationExceptionReason
* @return Returns a reference to this object so that method calls can be chained together.
* @see ValidationExceptionReason
*/
Builder reason(String reason);
/**
*
* Additional information about the exception.
*
*
* @param reason
* Additional information about the exception.
* @see ValidationExceptionReason
* @return Returns a reference to this object so that method calls can be chained together.
* @see ValidationExceptionReason
*/
Builder reason(ValidationExceptionReason reason);
/**
*
* Fields that caused the exception.
*
*
* @param fields
* Fields that caused the exception.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fields(Collection fields);
/**
*
* Fields that caused the exception.
*
*
* @param fields
* Fields that caused the exception.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fields(ValidationExceptionField... fields);
/**
*
* Fields that caused the exception.
*
* 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 #fields(List)}.
*
* @param fields
* 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 #fields(List)
*/
Builder fields(Consumer... fields);
@Override
Builder awsErrorDetails(AwsErrorDetails awsErrorDetails);
@Override
Builder message(String message);
@Override
Builder requestId(String requestId);
@Override
Builder statusCode(int statusCode);
@Override
Builder cause(Throwable cause);
}
static final class BuilderImpl extends ShieldException.BuilderImpl implements Builder {
private String reason;
private List fields = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(InvalidParameterException model) {
super(model);
reason(model.reason);
fields(model.fields);
}
public final String getReason() {
return reason;
}
@Override
public final Builder reason(String reason) {
this.reason = reason;
return this;
}
@Override
public final Builder reason(ValidationExceptionReason reason) {
this.reason(reason == null ? null : reason.toString());
return this;
}
public final void setReason(String reason) {
this.reason = reason;
}
public final List getFields() {
List result = ValidationExceptionFieldListCopier.copyToBuilder(this.fields);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder fields(Collection fields) {
this.fields = ValidationExceptionFieldListCopier.copy(fields);
return this;
}
@Override
@SafeVarargs
public final Builder fields(ValidationExceptionField... fields) {
fields(Arrays.asList(fields));
return this;
}
@Override
@SafeVarargs
public final Builder fields(Consumer... fields) {
fields(Stream.of(fields).map(c -> ValidationExceptionField.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setFields(Collection fields) {
this.fields = ValidationExceptionFieldListCopier.copyFromBuilder(fields);
}
@Override
public BuilderImpl awsErrorDetails(AwsErrorDetails awsErrorDetails) {
this.awsErrorDetails = awsErrorDetails;
return this;
}
@Override
public BuilderImpl message(String message) {
this.message = message;
return this;
}
@Override
public BuilderImpl requestId(String requestId) {
this.requestId = requestId;
return this;
}
@Override
public BuilderImpl statusCode(int statusCode) {
this.statusCode = statusCode;
return this;
}
@Override
public BuilderImpl cause(Throwable cause) {
this.cause = cause;
return this;
}
@Override
public InvalidParameterException build() {
return new InvalidParameterException(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy