software.amazon.awssdk.services.kendra.model.BatchDeleteDocumentResponseFailedDocument Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kendra Show documentation
Show all versions of kendra Show documentation
The AWS Java SDK for Kendra module holds the client classes that are used for
communicating with Kendra.
/*
* 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.kendra.model;
import java.io.Serializable;
import java.util.Arrays;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides information about documents that could not be removed from an index by the BatchDeleteDocument
* API.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BatchDeleteDocumentResponseFailedDocument implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(BatchDeleteDocumentResponseFailedDocument::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField ERROR_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ErrorCode").getter(getter(BatchDeleteDocumentResponseFailedDocument::errorCodeAsString))
.setter(setter(Builder::errorCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ErrorCode").build()).build();
private static final SdkField ERROR_MESSAGE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ErrorMessage").getter(getter(BatchDeleteDocumentResponseFailedDocument::errorMessage))
.setter(setter(Builder::errorMessage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ErrorMessage").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ERROR_CODE_FIELD,
ERROR_MESSAGE_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String errorCode;
private final String errorMessage;
private BatchDeleteDocumentResponseFailedDocument(BuilderImpl builder) {
this.id = builder.id;
this.errorCode = builder.errorCode;
this.errorMessage = builder.errorMessage;
}
/**
*
* The identifier of the document that couldn't be removed from the index.
*
*
* @return The identifier of the document that couldn't be removed from the index.
*/
public final String id() {
return id;
}
/**
*
* The error code for why the document couldn't be removed from the index.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #errorCode} will
* return {@link ErrorCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #errorCodeAsString}.
*
*
* @return The error code for why the document couldn't be removed from the index.
* @see ErrorCode
*/
public final ErrorCode errorCode() {
return ErrorCode.fromValue(errorCode);
}
/**
*
* The error code for why the document couldn't be removed from the index.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #errorCode} will
* return {@link ErrorCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #errorCodeAsString}.
*
*
* @return The error code for why the document couldn't be removed from the index.
* @see ErrorCode
*/
public final String errorCodeAsString() {
return errorCode;
}
/**
*
* An explanation for why the document couldn't be removed from the index.
*
*
* @return An explanation for why the document couldn't be removed from the index.
*/
public final String errorMessage() {
return errorMessage;
}
@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(id());
hashCode = 31 * hashCode + Objects.hashCode(errorCodeAsString());
hashCode = 31 * hashCode + Objects.hashCode(errorMessage());
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 BatchDeleteDocumentResponseFailedDocument)) {
return false;
}
BatchDeleteDocumentResponseFailedDocument other = (BatchDeleteDocumentResponseFailedDocument) obj;
return Objects.equals(id(), other.id()) && Objects.equals(errorCodeAsString(), other.errorCodeAsString())
&& Objects.equals(errorMessage(), other.errorMessage());
}
/**
* 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("BatchDeleteDocumentResponseFailedDocument").add("Id", id())
.add("ErrorCode", errorCodeAsString()).add("ErrorMessage", errorMessage()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "ErrorCode":
return Optional.ofNullable(clazz.cast(errorCodeAsString()));
case "ErrorMessage":
return Optional.ofNullable(clazz.cast(errorMessage()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BatchDeleteDocumentResponseFailedDocument) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The identifier of the document that couldn't be removed from the index.
*
*
* @param id
* The identifier of the document that couldn't be removed from the index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The error code for why the document couldn't be removed from the index.
*
*
* @param errorCode
* The error code for why the document couldn't be removed from the index.
* @see ErrorCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ErrorCode
*/
Builder errorCode(String errorCode);
/**
*
* The error code for why the document couldn't be removed from the index.
*
*
* @param errorCode
* The error code for why the document couldn't be removed from the index.
* @see ErrorCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ErrorCode
*/
Builder errorCode(ErrorCode errorCode);
/**
*
* An explanation for why the document couldn't be removed from the index.
*
*
* @param errorMessage
* An explanation for why the document couldn't be removed from the index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorMessage(String errorMessage);
}
static final class BuilderImpl implements Builder {
private String id;
private String errorCode;
private String errorMessage;
private BuilderImpl() {
}
private BuilderImpl(BatchDeleteDocumentResponseFailedDocument model) {
id(model.id);
errorCode(model.errorCode);
errorMessage(model.errorMessage);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getErrorCode() {
return errorCode;
}
public final void setErrorCode(String errorCode) {
this.errorCode = errorCode;
}
@Override
public final Builder errorCode(String errorCode) {
this.errorCode = errorCode;
return this;
}
@Override
public final Builder errorCode(ErrorCode errorCode) {
this.errorCode(errorCode == null ? null : errorCode.toString());
return this;
}
public final String getErrorMessage() {
return errorMessage;
}
public final void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
@Override
public final Builder errorMessage(String errorMessage) {
this.errorMessage = errorMessage;
return this;
}
@Override
public BatchDeleteDocumentResponseFailedDocument build() {
return new BatchDeleteDocumentResponseFailedDocument(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}