software.amazon.awssdk.services.textract.model.Warning Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of textract Show documentation
Show all versions of textract Show documentation
The AWS Java SDK for Textract module holds the client classes that are used for
communicating with Textract.
/*
* 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.textract.model;
import java.io.Serializable;
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;
/**
*
* A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or
* asynchronous document text detection (StartDocumentTextDetection).
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Warning implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ERROR_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ErrorCode").getter(getter(Warning::errorCode)).setter(setter(Builder::errorCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ErrorCode").build()).build();
private static final SdkField> PAGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Pages")
.getter(getter(Warning::pages))
.setter(setter(Builder::pages))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Pages").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.INTEGER)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(ERROR_CODE_FIELD, PAGES_FIELD));
private static final long serialVersionUID = 1L;
private final String errorCode;
private final List pages;
private Warning(BuilderImpl builder) {
this.errorCode = builder.errorCode;
this.pages = builder.pages;
}
/**
*
* The error code for the warning.
*
*
* @return The error code for the warning.
*/
public final String errorCode() {
return errorCode;
}
/**
* For responses, this returns true if the service returned a value for the Pages 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 hasPages() {
return pages != null && !(pages instanceof SdkAutoConstructList);
}
/**
*
* A list of the pages that the warning applies to.
*
*
* 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 #hasPages} method.
*
*
* @return A list of the pages that the warning applies to.
*/
public final List pages() {
return pages;
}
@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(errorCode());
hashCode = 31 * hashCode + Objects.hashCode(hasPages() ? pages() : null);
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 Warning)) {
return false;
}
Warning other = (Warning) obj;
return Objects.equals(errorCode(), other.errorCode()) && hasPages() == other.hasPages()
&& Objects.equals(pages(), other.pages());
}
/**
* 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("Warning").add("ErrorCode", errorCode()).add("Pages", hasPages() ? pages() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ErrorCode":
return Optional.ofNullable(clazz.cast(errorCode()));
case "Pages":
return Optional.ofNullable(clazz.cast(pages()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Warning) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The error code for the warning.
*
*
* @param errorCode
* The error code for the warning.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorCode(String errorCode);
/**
*
* A list of the pages that the warning applies to.
*
*
* @param pages
* A list of the pages that the warning applies to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pages(Collection pages);
/**
*
* A list of the pages that the warning applies to.
*
*
* @param pages
* A list of the pages that the warning applies to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pages(Integer... pages);
}
static final class BuilderImpl implements Builder {
private String errorCode;
private List pages = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Warning model) {
errorCode(model.errorCode);
pages(model.pages);
}
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;
}
public final Collection getPages() {
if (pages instanceof SdkAutoConstructList) {
return null;
}
return pages;
}
public final void setPages(Collection pages) {
this.pages = PagesCopier.copy(pages);
}
@Override
public final Builder pages(Collection pages) {
this.pages = PagesCopier.copy(pages);
return this;
}
@Override
@SafeVarargs
public final Builder pages(Integer... pages) {
pages(Arrays.asList(pages));
return this;
}
@Override
public Warning build() {
return new Warning(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}