software.amazon.awssdk.services.sagemakergeospatial.model

Class ZonalStatisticsConfigInput

java.lang.Object

software.amazon.awssdk.services.sagemakergeospatial.model.ZonalStatisticsConfigInput

All Implemented Interfaces:

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

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

The structure representing input configuration of ZonalStatistics operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ZonalStatisticsConfigInput.Builder

Method Summary

Modifier and Type	Method and Description
static ZonalStatisticsConfigInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatistics() For responses, this returns true if the service returned a value for the Statistics property.
boolean	hasTargetBands() For responses, this returns true if the service returned a value for the TargetBands property.
List<SdkField<?>>	sdkFields()
static Class<? extends ZonalStatisticsConfigInput.Builder>	serializableBuilderClass()
List<ZonalStatistics>	statistics() List of zonal statistics to compute.
List<String>	statisticsAsStrings() List of zonal statistics to compute.
List<String>	targetBands() Bands used in the operation.
ZonalStatisticsConfigInput.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	zoneS3Path() The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
String	zoneS3PathKmsKeyId() The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption.

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

statistics

public final List<ZonalStatistics> statistics()

List of zonal statistics to compute.

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

Returns:

List of zonal statistics to compute.

hasStatistics

public final boolean hasStatistics()

For responses, this returns true if the service returned a value for the Statistics 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.

statisticsAsStrings

public final List<String> statisticsAsStrings()

List of zonal statistics to compute.

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

Returns:

List of zonal statistics to compute.

hasTargetBands

public final boolean hasTargetBands()

For responses, this returns true if the service returned a value for the TargetBands 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.

targetBands

public final List<String> targetBands()

Bands used in the operation. If no target bands are specified, it uses all bands available input.

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

Returns:

Bands used in the operation. If no target bands are specified, it uses all bands available input.

zoneS3Path

public final String zoneS3Path()

The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.

Returns:

The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.

zoneS3PathKmsKeyId

public final String zoneS3PathKmsKeyId()

The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

• // KMS Key ID

  "1234abcd-12ab-34cd-56ef-1234567890ab"

• // Amazon Resource Name (ARN) of a KMS Key

  "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

Returns:

The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

• // KMS Key ID

  "1234abcd-12ab-34cd-56ef-1234567890ab"

• // Amazon Resource Name (ARN) of a KMS Key

  "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

toBuilder

public ZonalStatisticsConfigInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ZonalStatisticsConfigInput.Builder,ZonalStatisticsConfigInput>

builder

public static ZonalStatisticsConfigInput.Builder builder()

serializableBuilderClass

public static Class<? extends ZonalStatisticsConfigInput.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