/* * Copyright 2018-2023 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 com.amazonaws.services.sagemakergeospatial.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* The structure representing input configuration of ZonalStatistics operation. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ZonalStatisticsConfigInput implements Serializable, Cloneable, StructuredPojo { /** *

* List of zonal statistics to compute. *

*/ private java.util.List statistics; /** *

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

*/ private java.util.List targetBands; /** *

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

*/ private String zoneS3Path; /** *

* 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: *

* *

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

*/ private String zoneS3PathKmsKeyId; /** *

* List of zonal statistics to compute. *

* * @return List of zonal statistics to compute. * @see ZonalStatistics */ public java.util.List getStatistics() { return statistics; } /** *

* List of zonal statistics to compute. *

* * @param statistics * List of zonal statistics to compute. * @see ZonalStatistics */ public void setStatistics(java.util.Collection statistics) { if (statistics == null) { this.statistics = null; return; } this.statistics = new java.util.ArrayList(statistics); } /** *

* List of zonal statistics to compute. *

*

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

* * @param statistics * List of zonal statistics to compute. * @return Returns a reference to this object so that method calls can be chained together. * @see ZonalStatistics */ public ZonalStatisticsConfigInput withStatistics(String... statistics) { if (this.statistics == null) { setStatistics(new java.util.ArrayList(statistics.length)); } for (String ele : statistics) { this.statistics.add(ele); } return this; } /** *

* List of zonal statistics to compute. *

* * @param statistics * List of zonal statistics to compute. * @return Returns a reference to this object so that method calls can be chained together. * @see ZonalStatistics */ public ZonalStatisticsConfigInput withStatistics(java.util.Collection statistics) { setStatistics(statistics); return this; } /** *

* List of zonal statistics to compute. *

* * @param statistics * List of zonal statistics to compute. * @return Returns a reference to this object so that method calls can be chained together. * @see ZonalStatistics */ public ZonalStatisticsConfigInput withStatistics(ZonalStatistics... statistics) { java.util.ArrayList statisticsCopy = new java.util.ArrayList(statistics.length); for (ZonalStatistics value : statistics) { statisticsCopy.add(value.toString()); } if (getStatistics() == null) { setStatistics(statisticsCopy); } else { getStatistics().addAll(statisticsCopy); } return this; } /** *

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

* * @return Bands used in the operation. If no target bands are specified, it uses all bands available input. */ public java.util.List getTargetBands() { return targetBands; } /** *

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

* * @param targetBands * Bands used in the operation. If no target bands are specified, it uses all bands available input. */ public void setTargetBands(java.util.Collection targetBands) { if (targetBands == null) { this.targetBands = null; return; } this.targetBands = new java.util.ArrayList(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 * {@link #setTargetBands(java.util.Collection)} or {@link #withTargetBands(java.util.Collection)} if you want to * override the existing values. *

* * @param targetBands * Bands used in the operation. If no target bands are specified, it uses all bands available input. * @return Returns a reference to this object so that method calls can be chained together. */ public ZonalStatisticsConfigInput withTargetBands(String... targetBands) { if (this.targetBands == null) { setTargetBands(new java.util.ArrayList(targetBands.length)); } for (String ele : targetBands) { this.targetBands.add(ele); } return this; } /** *

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

* * @param targetBands * Bands used in the operation. If no target bands are specified, it uses all bands available input. * @return Returns a reference to this object so that method calls can be chained together. */ public ZonalStatisticsConfigInput withTargetBands(java.util.Collection targetBands) { setTargetBands(targetBands); return this; } /** *

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

* * @param zoneS3Path * The Amazon S3 path pointing to the GeoJSON containing the polygonal zones. */ public void setZoneS3Path(String zoneS3Path) { this.zoneS3Path = zoneS3Path; } /** *

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

* * @return The Amazon S3 path pointing to the GeoJSON containing the polygonal zones. */ public String getZoneS3Path() { return this.zoneS3Path; } /** *

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

* * @param zoneS3Path * The Amazon S3 path pointing to the GeoJSON containing the polygonal zones. * @return Returns a reference to this object so that method calls can be chained together. */ public ZonalStatisticsConfigInput withZoneS3Path(String zoneS3Path) { setZoneS3Path(zoneS3Path); return this; } /** *

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

* * @param 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. */ public void setZoneS3PathKmsKeyId(String zoneS3PathKmsKeyId) { this.zoneS3PathKmsKeyId = 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. *

* * @return 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. */ public String getZoneS3PathKmsKeyId() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public ZonalStatisticsConfigInput withZoneS3PathKmsKeyId(String zoneS3PathKmsKeyId) { setZoneS3PathKmsKeyId(zoneS3PathKmsKeyId); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getStatistics() != null) sb.append("Statistics: ").append(getStatistics()).append(","); if (getTargetBands() != null) sb.append("TargetBands: ").append(getTargetBands()).append(","); if (getZoneS3Path() != null) sb.append("ZoneS3Path: ").append(getZoneS3Path()).append(","); if (getZoneS3PathKmsKeyId() != null) sb.append("ZoneS3PathKmsKeyId: ").append(getZoneS3PathKmsKeyId()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ZonalStatisticsConfigInput == false) return false; ZonalStatisticsConfigInput other = (ZonalStatisticsConfigInput) obj; if (other.getStatistics() == null ^ this.getStatistics() == null) return false; if (other.getStatistics() != null && other.getStatistics().equals(this.getStatistics()) == false) return false; if (other.getTargetBands() == null ^ this.getTargetBands() == null) return false; if (other.getTargetBands() != null && other.getTargetBands().equals(this.getTargetBands()) == false) return false; if (other.getZoneS3Path() == null ^ this.getZoneS3Path() == null) return false; if (other.getZoneS3Path() != null && other.getZoneS3Path().equals(this.getZoneS3Path()) == false) return false; if (other.getZoneS3PathKmsKeyId() == null ^ this.getZoneS3PathKmsKeyId() == null) return false; if (other.getZoneS3PathKmsKeyId() != null && other.getZoneS3PathKmsKeyId().equals(this.getZoneS3PathKmsKeyId()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStatistics() == null) ? 0 : getStatistics().hashCode()); hashCode = prime * hashCode + ((getTargetBands() == null) ? 0 : getTargetBands().hashCode()); hashCode = prime * hashCode + ((getZoneS3Path() == null) ? 0 : getZoneS3Path().hashCode()); hashCode = prime * hashCode + ((getZoneS3PathKmsKeyId() == null) ? 0 : getZoneS3PathKmsKeyId().hashCode()); return hashCode; } @Override public ZonalStatisticsConfigInput clone() { try { return (ZonalStatisticsConfigInput) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.sagemakergeospatial.model.transform.ZonalStatisticsConfigInputMarshaller.getInstance().marshall(this, protocolMarshaller); } }