com.amazonaws.services.location.model.CreateGeofenceCollectionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location Show documentation
/*
* Copyright 2019-2024 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.location.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateGeofenceCollectionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A custom name for the geofence collection.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*
*/
private String collectionName;
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*/
@Deprecated
private String pricingPlan;
/**
*
* This parameter is no longer used.
*
*/
@Deprecated
private String pricingPlanDataSource;
/**
*
* An optional description for the geofence collection.
*
*/
private String description;
/**
*
* 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.
*
*
*
*/
private java.util.Map tags;
/**
*
* A key identifier for an Amazon
* Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
*
*/
private String kmsKeyId;
/**
*
* A custom name for the geofence collection.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*
*
* @param collectionName
* A custom name for the geofence collection.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*/
public void setCollectionName(String collectionName) {
this.collectionName = collectionName;
}
/**
*
* A custom name for the geofence collection.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*
*
* @return A custom name for the geofence collection.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*/
public String getCollectionName() {
return this.collectionName;
}
/**
*
* A custom name for the geofence collection.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*
*
* @param collectionName
* A custom name for the geofence collection.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateGeofenceCollectionRequest withCollectionName(String collectionName) {
setCollectionName(collectionName);
return this;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
*/
@Deprecated
public void setPricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @return No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
*/
@Deprecated
public String getPricingPlan() {
return this.pricingPlan;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public CreateGeofenceCollectionRequest withPricingPlan(String pricingPlan) {
setPricingPlan(pricingPlan);
return this;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public CreateGeofenceCollectionRequest withPricingPlan(PricingPlan pricingPlan) {
this.pricingPlan = pricingPlan.toString();
return this;
}
/**
*
* This parameter is no longer used.
*
*
* @param pricingPlanDataSource
* This parameter is no longer used.
*/
@Deprecated
public void setPricingPlanDataSource(String pricingPlanDataSource) {
this.pricingPlanDataSource = pricingPlanDataSource;
}
/**
*
* This parameter is no longer used.
*
*
* @return This parameter is no longer used.
*/
@Deprecated
public String getPricingPlanDataSource() {
return this.pricingPlanDataSource;
}
/**
*
* This parameter is no longer used.
*
*
* @param pricingPlanDataSource
* This parameter is no longer used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public CreateGeofenceCollectionRequest withPricingPlanDataSource(String pricingPlanDataSource) {
setPricingPlanDataSource(pricingPlanDataSource);
return this;
}
/**
*
* An optional description for the geofence collection.
*
*
* @param description
* An optional description for the geofence collection.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* An optional description for the geofence collection.
*
*
* @return An optional description for the geofence collection.
*/
public String getDescription() {
return this.description;
}
/**
*
* An optional description for the geofence collection.
*
*
* @param description
* An optional description for the geofence collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateGeofenceCollectionRequest withDescription(String description) {
setDescription(description);
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.
*
*
*
*
* @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:
*
*
* -
*
* 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.
*
*
*/
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:
*
*
* -
*
* 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.
*
*
*
*
* @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.
*
*
*/
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.
*
*
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public CreateGeofenceCollectionRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateGeofenceCollectionRequest#withTags
* @returns a reference to this 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateGeofenceCollectionRequest clearTagsEntries() {
this.tags = null;
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.
*
*
* @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.
*
*
* @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 this.kmsKeyId;
}
/**
*
* A key identifier for an Amazon
* Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public CreateGeofenceCollectionRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
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 (getCollectionName() != null)
sb.append("CollectionName: ").append(getCollectionName()).append(",");
if (getPricingPlan() != null)
sb.append("PricingPlan: ").append(getPricingPlan()).append(",");
if (getPricingPlanDataSource() != null)
sb.append("PricingPlanDataSource: ").append(getPricingPlanDataSource()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId());
sb.append("}");
return sb.toString();
}
@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.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.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCollectionName() == null) ? 0 : getCollectionName().hashCode());
hashCode = prime * hashCode + ((getPricingPlan() == null) ? 0 : getPricingPlan().hashCode());
hashCode = prime * hashCode + ((getPricingPlanDataSource() == null) ? 0 : getPricingPlanDataSource().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
return hashCode;
}
@Override
public CreateGeofenceCollectionRequest clone() {
return (CreateGeofenceCollectionRequest) super.clone();
}
}