com.amazonaws.services.location.model.DescribeGeofenceCollectionResult 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;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeGeofenceCollectionResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The name of the geofence collection.
*
*/
private String collectionName;
/**
*
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource
* across all Amazon Web Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
*
*
*
*/
private String collectionArn;
/**
*
* The optional description for the geofence collection.
*
*/
private String description;
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*/
@Deprecated
private String pricingPlan;
/**
*
* No longer used. Always returns an empty string.
*
*/
@Deprecated
private String pricingPlanDataSource;
/**
*
* A key identifier for an Amazon
* Web Services KMS customer managed key assigned to the Amazon Location resource
*
*/
private String kmsKeyId;
/**
*
* Displays the key, value pairs of tags associated with this resource.
*
*/
private java.util.Map tags;
/**
*
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*/
private java.util.Date createTime;
/**
*
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*/
private java.util.Date updateTime;
/**
*
* The number of geofences in the geofence collection.
*
*/
private Integer geofenceCount;
/**
*
* The name of the geofence collection.
*
*
* @param collectionName
* The name of the geofence collection.
*/
public void setCollectionName(String collectionName) {
this.collectionName = collectionName;
}
/**
*
* The name of the geofence collection.
*
*
* @return The name of the geofence collection.
*/
public String getCollectionName() {
return this.collectionName;
}
/**
*
* The name of the geofence collection.
*
*
* @param collectionName
* The name of the geofence collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult withCollectionName(String collectionName) {
setCollectionName(collectionName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource
* across all Amazon Web Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
*
*
*
*
* @param collectionArn
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a
* resource across all Amazon Web Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
*
*
*/
public void setCollectionArn(String collectionArn) {
this.collectionArn = collectionArn;
}
/**
*
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource
* across all Amazon Web Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
*
*
*
*
* @return The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a
* resource across all Amazon Web Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
*
*
*/
public String getCollectionArn() {
return this.collectionArn;
}
/**
*
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource
* across all Amazon Web Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
*
*
*
*
* @param collectionArn
* The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a
* resource across all Amazon Web Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult withCollectionArn(String collectionArn) {
setCollectionArn(collectionArn);
return this;
}
/**
*
* The optional description for the geofence collection.
*
*
* @param description
* The optional description for the geofence collection.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The optional description for the geofence collection.
*
*
* @return The optional description for the geofence collection.
*/
public String getDescription() {
return this.description;
}
/**
*
* The optional description for the geofence collection.
*
*
* @param description
* The optional description for the geofence collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage.
* @see PricingPlan
*/
@Deprecated
public void setPricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @return No longer used. Always returns RequestBasedUsage.
* @see PricingPlan
*/
@Deprecated
public String getPricingPlan() {
return this.pricingPlan;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public DescribeGeofenceCollectionResult withPricingPlan(String pricingPlan) {
setPricingPlan(pricingPlan);
return this;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public DescribeGeofenceCollectionResult withPricingPlan(PricingPlan pricingPlan) {
this.pricingPlan = pricingPlan.toString();
return this;
}
/**
*
* No longer used. Always returns an empty string.
*
*
* @param pricingPlanDataSource
* No longer used. Always returns an empty string.
*/
@Deprecated
public void setPricingPlanDataSource(String pricingPlanDataSource) {
this.pricingPlanDataSource = pricingPlanDataSource;
}
/**
*
* No longer used. Always returns an empty string.
*
*
* @return No longer used. Always returns an empty string.
*/
@Deprecated
public String getPricingPlanDataSource() {
return this.pricingPlanDataSource;
}
/**
*
* No longer used. Always returns an empty string.
*
*
* @param pricingPlanDataSource
* No longer used. Always returns an empty string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public DescribeGeofenceCollectionResult withPricingPlanDataSource(String pricingPlanDataSource) {
setPricingPlanDataSource(pricingPlanDataSource);
return this;
}
/**
*
* A key identifier for an Amazon
* Web Services KMS customer managed key assigned to the Amazon Location resource
*
*
* @param kmsKeyId
* A key identifier for an Amazon Web Services KMS
* customer managed key assigned to the Amazon Location resource
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* A key identifier for an Amazon
* Web Services KMS customer managed key assigned to the Amazon Location resource
*
*
* @return A key identifier for an Amazon Web Services KMS
* customer managed key assigned to the Amazon Location resource
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* A key identifier for an Amazon
* Web Services KMS customer managed key assigned to the Amazon Location resource
*
*
* @param kmsKeyId
* A key identifier for an Amazon Web Services KMS
* customer managed key assigned to the Amazon Location resource
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* Displays the key, value pairs of tags associated with this resource.
*
*
* @return Displays the key, value pairs of tags associated with this resource.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* Displays the key, value pairs of tags associated with this resource.
*
*
* @param tags
* Displays the key, value pairs of tags associated with this resource.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* Displays the key, value pairs of tags associated with this resource.
*
*
* @param tags
* Displays the key, value pairs of tags associated with this resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see DescribeGeofenceCollectionResult#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult 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 DescribeGeofenceCollectionResult clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @param createTime
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*/
public void setCreateTime(java.util.Date createTime) {
this.createTime = createTime;
}
/**
*
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @return The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*/
public java.util.Date getCreateTime() {
return this.createTime;
}
/**
*
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @param createTime
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult withCreateTime(java.util.Date createTime) {
setCreateTime(createTime);
return this;
}
/**
*
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @param updateTime
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*/
public void setUpdateTime(java.util.Date updateTime) {
this.updateTime = updateTime;
}
/**
*
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @return The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*/
public java.util.Date getUpdateTime() {
return this.updateTime;
}
/**
*
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @param updateTime
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult withUpdateTime(java.util.Date updateTime) {
setUpdateTime(updateTime);
return this;
}
/**
*
* The number of geofences in the geofence collection.
*
*
* @param geofenceCount
* The number of geofences in the geofence collection.
*/
public void setGeofenceCount(Integer geofenceCount) {
this.geofenceCount = geofenceCount;
}
/**
*
* The number of geofences in the geofence collection.
*
*
* @return The number of geofences in the geofence collection.
*/
public Integer getGeofenceCount() {
return this.geofenceCount;
}
/**
*
* The number of geofences in the geofence collection.
*
*
* @param geofenceCount
* The number of geofences in the geofence collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGeofenceCollectionResult withGeofenceCount(Integer geofenceCount) {
setGeofenceCount(geofenceCount);
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 (getCollectionArn() != null)
sb.append("CollectionArn: ").append(getCollectionArn()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getPricingPlan() != null)
sb.append("PricingPlan: ").append(getPricingPlan()).append(",");
if (getPricingPlanDataSource() != null)
sb.append("PricingPlanDataSource: ").append(getPricingPlanDataSource()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getCreateTime() != null)
sb.append("CreateTime: ").append(getCreateTime()).append(",");
if (getUpdateTime() != null)
sb.append("UpdateTime: ").append(getUpdateTime()).append(",");
if (getGeofenceCount() != null)
sb.append("GeofenceCount: ").append(getGeofenceCount());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeGeofenceCollectionResult == false)
return false;
DescribeGeofenceCollectionResult other = (DescribeGeofenceCollectionResult) obj;
if (other.getCollectionName() == null ^ this.getCollectionName() == null)
return false;
if (other.getCollectionName() != null && other.getCollectionName().equals(this.getCollectionName()) == false)
return false;
if (other.getCollectionArn() == null ^ this.getCollectionArn() == null)
return false;
if (other.getCollectionArn() != null && other.getCollectionArn().equals(this.getCollectionArn()) == 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.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.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == 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.getCreateTime() == null ^ this.getCreateTime() == null)
return false;
if (other.getCreateTime() != null && other.getCreateTime().equals(this.getCreateTime()) == false)
return false;
if (other.getUpdateTime() == null ^ this.getUpdateTime() == null)
return false;
if (other.getUpdateTime() != null && other.getUpdateTime().equals(this.getUpdateTime()) == false)
return false;
if (other.getGeofenceCount() == null ^ this.getGeofenceCount() == null)
return false;
if (other.getGeofenceCount() != null && other.getGeofenceCount().equals(this.getGeofenceCount()) == 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 + ((getCollectionArn() == null) ? 0 : getCollectionArn().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getPricingPlan() == null) ? 0 : getPricingPlan().hashCode());
hashCode = prime * hashCode + ((getPricingPlanDataSource() == null) ? 0 : getPricingPlanDataSource().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getCreateTime() == null) ? 0 : getCreateTime().hashCode());
hashCode = prime * hashCode + ((getUpdateTime() == null) ? 0 : getUpdateTime().hashCode());
hashCode = prime * hashCode + ((getGeofenceCount() == null) ? 0 : getGeofenceCount().hashCode());
return hashCode;
}
@Override
public DescribeGeofenceCollectionResult clone() {
try {
return (DescribeGeofenceCollectionResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}