software.amazon.awssdk.services.sagemakergeospatial.model.BandMathConfigInput Maven / Gradle / Ivy
Show all versions of sagemakergeospatial 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.sagemakergeospatial.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.Consumer;
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;
/**
*
* Input structure for the BandMath operation type. Defines Predefined and CustomIndices to be computed using BandMath.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BandMathConfigInput implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CUSTOM_INDICES_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("CustomIndices")
.getter(getter(BandMathConfigInput::customIndices)).setter(setter(Builder::customIndices))
.constructor(CustomIndicesInput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomIndices").build()).build();
private static final SdkField> PREDEFINED_INDICES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PredefinedIndices")
.getter(getter(BandMathConfigInput::predefinedIndices))
.setter(setter(Builder::predefinedIndices))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PredefinedIndices").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(CUSTOM_INDICES_FIELD,
PREDEFINED_INDICES_FIELD));
private static final long serialVersionUID = 1L;
private final CustomIndicesInput customIndices;
private final List predefinedIndices;
private BandMathConfigInput(BuilderImpl builder) {
this.customIndices = builder.customIndices;
this.predefinedIndices = builder.predefinedIndices;
}
/**
*
* CustomIndices that are computed.
*
*
* @return CustomIndices that are computed.
*/
public final CustomIndicesInput customIndices() {
return customIndices;
}
/**
* For responses, this returns true if the service returned a value for the PredefinedIndices 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 hasPredefinedIndices() {
return predefinedIndices != null && !(predefinedIndices instanceof SdkAutoConstructList);
}
/**
*
* One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2,
* MSAVI, NDWI, NDMI, NDSI, and WDRVI.
*
*
* 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 #hasPredefinedIndices} method.
*
*
* @return One or many of the supported predefined indices to compute. Allowed values: NDVI,
* EVI2, MSAVI, NDWI, NDMI, NDSI, and
* WDRVI.
*/
public final List predefinedIndices() {
return predefinedIndices;
}
@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(customIndices());
hashCode = 31 * hashCode + Objects.hashCode(hasPredefinedIndices() ? predefinedIndices() : 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 BandMathConfigInput)) {
return false;
}
BandMathConfigInput other = (BandMathConfigInput) obj;
return Objects.equals(customIndices(), other.customIndices()) && hasPredefinedIndices() == other.hasPredefinedIndices()
&& Objects.equals(predefinedIndices(), other.predefinedIndices());
}
/**
* 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("BandMathConfigInput").add("CustomIndices", customIndices())
.add("PredefinedIndices", hasPredefinedIndices() ? predefinedIndices() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CustomIndices":
return Optional.ofNullable(clazz.cast(customIndices()));
case "PredefinedIndices":
return Optional.ofNullable(clazz.cast(predefinedIndices()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BandMathConfigInput) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* CustomIndices that are computed.
*
*
* @param customIndices
* CustomIndices that are computed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customIndices(CustomIndicesInput customIndices);
/**
*
* CustomIndices that are computed.
*
* This is a convenience method that creates an instance of the {@link CustomIndicesInput.Builder} avoiding the
* need to create one manually via {@link CustomIndicesInput#builder()}.
*
*
* When the {@link Consumer} completes, {@link CustomIndicesInput.Builder#build()} is called immediately and its
* result is passed to {@link #customIndices(CustomIndicesInput)}.
*
* @param customIndices
* a consumer that will call methods on {@link CustomIndicesInput.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #customIndices(CustomIndicesInput)
*/
default Builder customIndices(Consumer customIndices) {
return customIndices(CustomIndicesInput.builder().applyMutation(customIndices).build());
}
/**
*
* One or many of the supported predefined indices to compute. Allowed values: NDVI,
* EVI2, MSAVI, NDWI, NDMI, NDSI, and
* WDRVI.
*
*
* @param predefinedIndices
* One or many of the supported predefined indices to compute. Allowed values: NDVI,
* EVI2, MSAVI, NDWI, NDMI, NDSI, and
* WDRVI.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder predefinedIndices(Collection predefinedIndices);
/**
*
* One or many of the supported predefined indices to compute. Allowed values: NDVI,
* EVI2, MSAVI, NDWI, NDMI, NDSI, and
* WDRVI.
*
*
* @param predefinedIndices
* One or many of the supported predefined indices to compute. Allowed values: NDVI,
* EVI2, MSAVI, NDWI, NDMI, NDSI, and
* WDRVI.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder predefinedIndices(String... predefinedIndices);
}
static final class BuilderImpl implements Builder {
private CustomIndicesInput customIndices;
private List predefinedIndices = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BandMathConfigInput model) {
customIndices(model.customIndices);
predefinedIndices(model.predefinedIndices);
}
public final CustomIndicesInput.Builder getCustomIndices() {
return customIndices != null ? customIndices.toBuilder() : null;
}
public final void setCustomIndices(CustomIndicesInput.BuilderImpl customIndices) {
this.customIndices = customIndices != null ? customIndices.build() : null;
}
@Override
public final Builder customIndices(CustomIndicesInput customIndices) {
this.customIndices = customIndices;
return this;
}
public final Collection getPredefinedIndices() {
if (predefinedIndices instanceof SdkAutoConstructList) {
return null;
}
return predefinedIndices;
}
public final void setPredefinedIndices(Collection predefinedIndices) {
this.predefinedIndices = StringListInputCopier.copy(predefinedIndices);
}
@Override
public final Builder predefinedIndices(Collection predefinedIndices) {
this.predefinedIndices = StringListInputCopier.copy(predefinedIndices);
return this;
}
@Override
@SafeVarargs
public final Builder predefinedIndices(String... predefinedIndices) {
predefinedIndices(Arrays.asList(predefinedIndices));
return this;
}
@Override
public BandMathConfigInput build() {
return new BandMathConfigInput(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}