software.amazon.awssdk.services.sagemakergeospatial.model

Class BandMathConfigInput

java.lang.Object

software.amazon.awssdk.services.sagemakergeospatial.model.BandMathConfigInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BandMathConfigInput.Builder,BandMathConfigInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class BandMathConfigInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BandMathConfigInput.Builder,BandMathConfigInput>

Input structure for the BandMath operation type. Defines Predefined and CustomIndices to be computed using BandMath.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BandMathConfigInput.Builder

Method Summary

Modifier and Type	Method and Description
static BandMathConfigInput.Builder	builder()
CustomIndicesInput	customIndices() CustomIndices that are computed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPredefinedIndices() For responses, this returns true if the service returned a value for the PredefinedIndices property.
List<String>	predefinedIndices() One or many of the supported predefined indices to compute.
List<SdkField<?>>	sdkFields()
static Class<? extends BandMathConfigInput.Builder>	serializableBuilderClass()
BandMathConfigInput.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

customIndices

public final CustomIndicesInput customIndices()

CustomIndices that are computed.

Returns:

CustomIndices that are computed.

hasPredefinedIndices

public final boolean hasPredefinedIndices()

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 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.

predefinedIndices

public final List<String> predefinedIndices()

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 hasPredefinedIndices() method.

Returns:

One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.

toBuilder

public BandMathConfigInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BandMathConfigInput.Builder,BandMathConfigInput>

builder

public static BandMathConfigInput.Builder builder()

serializableBuilderClass

public static Class<? extends BandMathConfigInput.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo