/* * Copyright 2010-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.geo.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Creates a geofence collection, which manages and stores geofences. *

*/ public class CreateGeofenceCollectionRequest extends AmazonWebServiceRequest implements Serializable { /** *

* A custom name for the geofence collection. *

*

* Requirements: *

* *

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
*/ private String collectionName; /** *

* An optional description for the geofence collection. *

*

* Constraints:
* Length: 0 - 1000
*/ private String description; /** *

* A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key * ARN, alias name, or alias ARN. *

*

* Constraints:
* Length: 1 - 2048
*/ private String kmsKeyId; /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement */ private String pricingPlan; /** *

* This parameter is no longer used. *

*/ private String pricingPlanDataSource; /** *

* Applies one or more tags to the geofence collection. A tag is a key-value * pair helps manage, identify, search, and filter your resources by * labelling them. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* */ private java.util.Map tags; /** *

* A custom name for the geofence collection. *

*

* Requirements: *

* *

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @return

* A custom name for the geofence collection. *

*

* Requirements: *

* */ public String getCollectionName() { return collectionName; } /** *

* A custom name for the geofence collection. *

*

* Requirements: *

* *

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @param collectionName

* A custom name for the geofence collection. *

*

* Requirements: *

* */ public void setCollectionName(String collectionName) { this.collectionName = collectionName; } /** *

* A custom name for the geofence collection. *

*

* Requirements: *

* *

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

* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\w]+$
* * @param collectionName

* A custom name for the geofence collection. *

*

* Requirements: *

* * @return A reference to this updated object so that method calls can be * chained together. */ public CreateGeofenceCollectionRequest withCollectionName(String collectionName) { this.collectionName = collectionName; return this; } /** *

* An optional description for the geofence collection. *

*

* Constraints:
* Length: 0 - 1000
* * @return

* An optional description for the geofence collection. *

*/ public String getDescription() { return description; } /** *

* An optional description for the geofence collection. *

*

* Constraints:
* Length: 0 - 1000
* * @param description

* An optional description for the geofence collection. *

*/ public void setDescription(String description) { this.description = description; } /** *

* An optional description for the geofence collection. *

*

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

* Constraints:
* Length: 0 - 1000
* * @param description

* An optional description for the geofence collection. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateGeofenceCollectionRequest withDescription(String description) { this.description = description; return this; } /** *

* A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key * ARN, alias name, or alias ARN. *

*

* Constraints:
* Length: 1 - 2048
* * @return

* A key identifier for an Amazon Web Services KMS customer managed key. Enter a key * ID, key ARN, alias name, or alias ARN. *

*/ public String getKmsKeyId() { return kmsKeyId; } /** *

* A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key * ARN, alias name, or alias ARN. *

*

* Constraints:
* Length: 1 - 2048
* * @param kmsKeyId

* A key identifier for an Amazon Web Services KMS customer managed key. Enter a key * ID, key ARN, alias name, or alias ARN. *

*/ public void setKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; } /** *

* A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key * ARN, alias name, or alias ARN. *

*

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

* Constraints:
* Length: 1 - 2048
* * @param kmsKeyId

* A key identifier for an Amazon Web Services KMS customer managed key. Enter a key * ID, key ARN, alias name, or alias ARN. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateGeofenceCollectionRequest withKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; return this; } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @return

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @see PricingPlan */ public String getPricingPlan() { return pricingPlan; } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @param pricingPlan

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @see PricingPlan */ public void setPricingPlan(String pricingPlan) { this.pricingPlan = pricingPlan; } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

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

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @param pricingPlan

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @return A reference to this updated object so that method calls can be * chained together. * @see PricingPlan */ public CreateGeofenceCollectionRequest withPricingPlan(String pricingPlan) { this.pricingPlan = pricingPlan; return this; } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @param pricingPlan

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @see PricingPlan */ public void setPricingPlan(PricingPlan pricingPlan) { this.pricingPlan = pricingPlan.toString(); } /** *

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

*

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

* Constraints:
* Allowed Values: RequestBasedUsage, MobileAssetTracking, * MobileAssetManagement * * @param pricingPlan

* No longer used. If included, the only allowed value is * RequestBasedUsage. *

* @return A reference to this updated object so that method calls can be * chained together. * @see PricingPlan */ public CreateGeofenceCollectionRequest withPricingPlan(PricingPlan pricingPlan) { this.pricingPlan = pricingPlan.toString(); return this; } /** *

* This parameter is no longer used. *

* * @return

* This parameter is no longer used. *

*/ public String getPricingPlanDataSource() { return pricingPlanDataSource; } /** *

* This parameter is no longer used. *

* * @param pricingPlanDataSource

* This parameter is no longer used. *

*/ public void setPricingPlanDataSource(String pricingPlanDataSource) { this.pricingPlanDataSource = pricingPlanDataSource; } /** *

* This parameter is no longer used. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param pricingPlanDataSource

* This parameter is no longer used. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateGeofenceCollectionRequest withPricingPlanDataSource(String pricingPlanDataSource) { this.pricingPlanDataSource = pricingPlanDataSource; return this; } /** *

* Applies one or more tags to the geofence collection. A tag is a key-value * pair helps manage, identify, search, and filter your resources by * labelling them. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* * * @return

* Applies one or more tags to the geofence collection. A tag is a * key-value pair helps manage, identify, search, and filter your * resources by labelling them. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* */ public java.util.Map getTags() { return tags; } /** *

* Applies one or more tags to the geofence collection. A tag is a key-value * pair helps manage, identify, search, and filter your resources by * labelling them. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* * * @param tags

* Applies one or more tags to the geofence collection. A tag is * a key-value pair helps manage, identify, search, and filter * your resources by labelling them. *

*

* Format: "key" : "value" *

*

* Restrictions: *

* */ public void setTags(java.util.Map tags) { this.tags = tags; } /** *

* Applies one or more tags to the geofence collection. A tag is a key-value * pair helps manage, identify, search, and filter your resources by * labelling them. *

*

* Format: "key" : "value" *

*

* Restrictions: *

*
    *
  • *

    * Maximum 50 tags per resource *

    *
    • *
  • *

    * Each resource tag must be unique with a maximum of one value. *

    *
    • *
  • *

    * Maximum key length: 128 Unicode characters in UTF-8 *

    *
    • *
  • *

    * Maximum value length: 256 Unicode characters in UTF-8 *

    *
    • *
  • *

    * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following * characters: + - = . _ : / @. *

    *
    • *
  • *

    * Cannot use "aws:" as a prefix for a key. *

    *
    • *
*

* Returns a reference to this object so that method calls can be chained * together. * * @param tags

* Applies one or more tags to the geofence collection. A tag is * a key-value pair helps manage, identify, search, and filter * your resources by labelling them. *

*

* Format: "key" : "value" *

*

* Restrictions: *

*
    *
  • *

    * Maximum 50 tags per resource *

    *
    • *
  • *

    * Each resource tag must be unique with a maximum of one value. *

    *
    • *
  • *

    * Maximum key length: 128 Unicode characters in UTF-8 *

    *
    • *
  • *

    * Maximum value length: 256 Unicode characters in UTF-8 *

    *
    • *
  • *

    * Can use alphanumeric characters (A–Z, a–z, 0–9), and the * following characters: + - = . _ : / @. *

    *
    • *
  • *

    * Cannot use "aws:" as a prefix for a key. *

    *
    • *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreateGeofenceCollectionRequest withTags(java.util.Map tags) { this.tags = tags; return this; } /** *

* Applies one or more tags to the geofence collection. A tag is a key-value * pair helps manage, identify, search, and filter your resources by * labelling them. *

*

* Format: "key" : "value" *

*

* Restrictions: *

*
    *
  • *

    * Maximum 50 tags per resource *

    *
    • *
  • *

    * Each resource tag must be unique with a maximum of one value. *

    *
    • *
  • *

    * Maximum key length: 128 Unicode characters in UTF-8 *

    *
    • *
  • *

    * Maximum value length: 256 Unicode characters in UTF-8 *

    *
    • *
  • *

    * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following * characters: + - = . _ : / @. *

    *
    • *
  • *

    * Cannot use "aws:" as a prefix for a key. *

    *
    • *
*

* The method adds a new key-value pair into Tags parameter, and returns a * reference to this object so that method calls can be chained together. * * @param key The key of the entry to be added into Tags. * @param value The corresponding value of the entry to be added into Tags. * @return A reference to this updated object so that method calls can be * chained together. */ public CreateGeofenceCollectionRequest addTagsEntry(String key, String value) { if (null == this.tags) { this.tags = new java.util.HashMap(); } if (this.tags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.tags.put(key, value); return this; } /** * Removes all the entries added into Tags. *

* Returns a reference to this object so that method calls can be chained * together. */ public CreateGeofenceCollectionRequest clearTagsEntries() { this.tags = null; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getCollectionName() != null) sb.append("CollectionName: " + getCollectionName() + ","); if (getDescription() != null) sb.append("Description: " + getDescription() + ","); if (getKmsKeyId() != null) sb.append("KmsKeyId: " + getKmsKeyId() + ","); if (getPricingPlan() != null) sb.append("PricingPlan: " + getPricingPlan() + ","); if (getPricingPlanDataSource() != null) sb.append("PricingPlanDataSource: " + getPricingPlanDataSource() + ","); if (getTags() != null) sb.append("Tags: " + getTags()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getCollectionName() == null) ? 0 : getCollectionName().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode()); hashCode = prime * hashCode + ((getPricingPlan() == null) ? 0 : getPricingPlan().hashCode()); hashCode = prime * hashCode + ((getPricingPlanDataSource() == null) ? 0 : getPricingPlanDataSource().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateGeofenceCollectionRequest == false) return false; CreateGeofenceCollectionRequest other = (CreateGeofenceCollectionRequest) obj; if (other.getCollectionName() == null ^ this.getCollectionName() == null) return false; if (other.getCollectionName() != null && other.getCollectionName().equals(this.getCollectionName()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null) return false; if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false) return false; if (other.getPricingPlan() == null ^ this.getPricingPlan() == null) return false; if (other.getPricingPlan() != null && other.getPricingPlan().equals(this.getPricingPlan()) == false) return false; if (other.getPricingPlanDataSource() == null ^ this.getPricingPlanDataSource() == null) return false; if (other.getPricingPlanDataSource() != null && other.getPricingPlanDataSource().equals(this.getPricingPlanDataSource()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } }