com.amazonaws.services.sagemakergeospatial.model

Class ZonalStatisticsConfigInput

java.lang.Object

com.amazonaws.services.sagemakergeospatial.model.ZonalStatisticsConfigInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ZonalStatisticsConfigInput
extends Object
implements Serializable, Cloneable, StructuredPojo

The structure representing input configuration of ZonalStatistics operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ZonalStatisticsConfigInput()

Method Summary

Modifier and Type	Method and Description
ZonalStatisticsConfigInput	clone()
boolean	equals(Object obj)
List<String>	getStatistics() List of zonal statistics to compute.
List<String>	getTargetBands() Bands used in the operation.
String	getZoneS3Path() The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
String	getZoneS3PathKmsKeyId() 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.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setStatistics(Collection<String> statistics) List of zonal statistics to compute.
void	setTargetBands(Collection<String> targetBands) Bands used in the operation.
void	setZoneS3Path(String zoneS3Path) The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
void	setZoneS3PathKmsKeyId(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.
String	toString() Returns a string representation of this object.
ZonalStatisticsConfigInput	withStatistics(Collection<String> statistics) List of zonal statistics to compute.
ZonalStatisticsConfigInput	withStatistics(String... statistics) List of zonal statistics to compute.
ZonalStatisticsConfigInput	withStatistics(ZonalStatistics... statistics) List of zonal statistics to compute.
ZonalStatisticsConfigInput	withTargetBands(Collection<String> targetBands) Bands used in the operation.
ZonalStatisticsConfigInput	withTargetBands(String... targetBands) Bands used in the operation.
ZonalStatisticsConfigInput	withZoneS3Path(String zoneS3Path) The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
ZonalStatisticsConfigInput	withZoneS3PathKmsKeyId(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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ZonalStatisticsConfigInput

public ZonalStatisticsConfigInput()

Method Detail

getStatistics

public List<String> getStatistics()

List of zonal statistics to compute.

Returns:

List of zonal statistics to compute.

See Also:

ZonalStatistics

setStatistics

public void setStatistics(Collection<String> statistics)

List of zonal statistics to compute.

Parameters:

statistics - List of zonal statistics to compute.

See Also:

ZonalStatistics

withStatistics

public ZonalStatisticsConfigInput withStatistics(String... statistics)

List of zonal statistics to compute.

NOTE: This method appends the values to the existing list (if any). Use setStatistics(java.util.Collection) or withStatistics(java.util.Collection) if you want to override the existing values.

Parameters:

statistics - List of zonal statistics to compute.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ZonalStatistics

withStatistics

public ZonalStatisticsConfigInput withStatistics(Collection<String> statistics)

List of zonal statistics to compute.

Parameters:

statistics - List of zonal statistics to compute.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ZonalStatistics

withStatistics

public ZonalStatisticsConfigInput withStatistics(ZonalStatistics... statistics)

List of zonal statistics to compute.

Parameters:

statistics - List of zonal statistics to compute.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ZonalStatistics

getTargetBands

public List<String> getTargetBands()

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

Returns:

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

setTargetBands

public void setTargetBands(Collection<String> targetBands)

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

Parameters:

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

withTargetBands

public ZonalStatisticsConfigInput withTargetBands(String... targetBands)

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

NOTE: This method appends the values to the existing list (if any). Use setTargetBands(java.util.Collection) or withTargetBands(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargetBands

public ZonalStatisticsConfigInput withTargetBands(Collection<String> targetBands)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setZoneS3Path

public void setZoneS3Path(String zoneS3Path)

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

Parameters:

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

getZoneS3Path

public String getZoneS3Path()

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.

withZoneS3Path

public ZonalStatisticsConfigInput withZoneS3Path(String zoneS3Path)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setZoneS3PathKmsKeyId

public void setZoneS3PathKmsKeyId(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.

Parameters:

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.

getZoneS3PathKmsKeyId

public String getZoneS3PathKmsKeyId()

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.

withZoneS3PathKmsKeyId

public ZonalStatisticsConfigInput withZoneS3PathKmsKeyId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ZonalStatisticsConfigInput clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.