com.amazonaws.services.location.model.GetGeofenceResult 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 GetGeofenceResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The geofence identifier.
*
*/
private String geofenceId;
/**
*
* Contains the geofence geometry details describing a polygon or a circle.
*
*/
private GeofenceGeometry geometry;
/**
*
* Identifies the state of the geofence. A geofence will hold one of the following states:
*
*
* -
*
* ACTIVE — The geofence has been indexed by the system.
*
*
* -
*
* PENDING — The geofence is being processed by the system.
*
*
* -
*
* FAILED — The geofence failed to be indexed by the system.
*
*
* -
*
* DELETED — The geofence has been deleted from the system index.
*
*
* -
*
* DELETING — The geofence is being deleted from the system index.
*
*
*
*/
private String status;
/**
*
* The timestamp for when the geofence collection 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;
/**
*
* User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any
* geofence event triggered with that geofence.
*
*
* Format: "key" : "value"
*
*/
private java.util.Map geofenceProperties;
/**
*
* The geofence identifier.
*
*
* @param geofenceId
* The geofence identifier.
*/
public void setGeofenceId(String geofenceId) {
this.geofenceId = geofenceId;
}
/**
*
* The geofence identifier.
*
*
* @return The geofence identifier.
*/
public String getGeofenceId() {
return this.geofenceId;
}
/**
*
* The geofence identifier.
*
*
* @param geofenceId
* The geofence identifier.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetGeofenceResult withGeofenceId(String geofenceId) {
setGeofenceId(geofenceId);
return this;
}
/**
*
* Contains the geofence geometry details describing a polygon or a circle.
*
*
* @param geometry
* Contains the geofence geometry details describing a polygon or a circle.
*/
public void setGeometry(GeofenceGeometry geometry) {
this.geometry = geometry;
}
/**
*
* Contains the geofence geometry details describing a polygon or a circle.
*
*
* @return Contains the geofence geometry details describing a polygon or a circle.
*/
public GeofenceGeometry getGeometry() {
return this.geometry;
}
/**
*
* Contains the geofence geometry details describing a polygon or a circle.
*
*
* @param geometry
* Contains the geofence geometry details describing a polygon or a circle.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetGeofenceResult withGeometry(GeofenceGeometry geometry) {
setGeometry(geometry);
return this;
}
/**
*
* Identifies the state of the geofence. A geofence will hold one of the following states:
*
*
* -
*
* ACTIVE — The geofence has been indexed by the system.
*
*
* -
*
* PENDING — The geofence is being processed by the system.
*
*
* -
*
* FAILED — The geofence failed to be indexed by the system.
*
*
* -
*
* DELETED — The geofence has been deleted from the system index.
*
*
* -
*
* DELETING — The geofence is being deleted from the system index.
*
*
*
*
* @param status
* Identifies the state of the geofence. A geofence will hold one of the following states:
*
* -
*
* ACTIVE — The geofence has been indexed by the system.
*
*
* -
*
* PENDING — The geofence is being processed by the system.
*
*
* -
*
* FAILED — The geofence failed to be indexed by the system.
*
*
* -
*
* DELETED — The geofence has been deleted from the system index.
*
*
* -
*
* DELETING — The geofence is being deleted from the system index.
*
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* Identifies the state of the geofence. A geofence will hold one of the following states:
*
*
* -
*
* ACTIVE — The geofence has been indexed by the system.
*
*
* -
*
* PENDING — The geofence is being processed by the system.
*
*
* -
*
* FAILED — The geofence failed to be indexed by the system.
*
*
* -
*
* DELETED — The geofence has been deleted from the system index.
*
*
* -
*
* DELETING — The geofence is being deleted from the system index.
*
*
*
*
* @return Identifies the state of the geofence. A geofence will hold one of the following states:
*
* -
*
* ACTIVE — The geofence has been indexed by the system.
*
*
* -
*
* PENDING — The geofence is being processed by the system.
*
*
* -
*
* FAILED — The geofence failed to be indexed by the system.
*
*
* -
*
* DELETED — The geofence has been deleted from the system index.
*
*
* -
*
* DELETING — The geofence is being deleted from the system index.
*
*
*/
public String getStatus() {
return this.status;
}
/**
*
* Identifies the state of the geofence. A geofence will hold one of the following states:
*
*
* -
*
* ACTIVE — The geofence has been indexed by the system.
*
*
* -
*
* PENDING — The geofence is being processed by the system.
*
*
* -
*
* FAILED — The geofence failed to be indexed by the system.
*
*
* -
*
* DELETED — The geofence has been deleted from the system index.
*
*
* -
*
* DELETING — The geofence is being deleted from the system index.
*
*
*
*
* @param status
* Identifies the state of the geofence. A geofence will hold one of the following states:
*
* -
*
* ACTIVE — The geofence has been indexed by the system.
*
*
* -
*
* PENDING — The geofence is being processed by the system.
*
*
* -
*
* FAILED — The geofence failed to be indexed by the system.
*
*
* -
*
* DELETED — The geofence has been deleted from the system index.
*
*
* -
*
* DELETING — The geofence is being deleted from the system index.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetGeofenceResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The timestamp for when the geofence collection was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @param createTime
* The timestamp for when the geofence collection 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 collection was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @return The timestamp for when the geofence collection 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 collection was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @param createTime
* The timestamp for when the geofence collection 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 GetGeofenceResult 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 GetGeofenceResult withUpdateTime(java.util.Date updateTime) {
setUpdateTime(updateTime);
return this;
}
/**
*
* User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any
* geofence event triggered with that geofence.
*
*
* Format: "key" : "value"
*
*
* @return User defined properties of the geofence. A property is a key-value pair stored with the geofence and
* added to any geofence event triggered with that geofence.
*
* Format: "key" : "value"
*/
public java.util.Map getGeofenceProperties() {
return geofenceProperties;
}
/**
*
* User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any
* geofence event triggered with that geofence.
*
*
* Format: "key" : "value"
*
*
* @param geofenceProperties
* User defined properties of the geofence. A property is a key-value pair stored with the geofence and added
* to any geofence event triggered with that geofence.
*
* Format: "key" : "value"
*/
public void setGeofenceProperties(java.util.Map geofenceProperties) {
this.geofenceProperties = geofenceProperties;
}
/**
*
* User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any
* geofence event triggered with that geofence.
*
*
* Format: "key" : "value"
*
*
* @param geofenceProperties
* User defined properties of the geofence. A property is a key-value pair stored with the geofence and added
* to any geofence event triggered with that geofence.
*
* Format: "key" : "value"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetGeofenceResult withGeofenceProperties(java.util.Map geofenceProperties) {
setGeofenceProperties(geofenceProperties);
return this;
}
/**
* Add a single GeofenceProperties entry
*
* @see GetGeofenceResult#withGeofenceProperties
* @returns a reference to this object so that method calls can be chained together.
*/
public GetGeofenceResult addGeofencePropertiesEntry(String key, String value) {
if (null == this.geofenceProperties) {
this.geofenceProperties = new java.util.HashMap();
}
if (this.geofenceProperties.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.geofenceProperties.put(key, value);
return this;
}
/**
* Removes all the entries added into GeofenceProperties.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetGeofenceResult clearGeofencePropertiesEntries() {
this.geofenceProperties = null;
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 (getGeofenceId() != null)
sb.append("GeofenceId: ").append(getGeofenceId()).append(",");
if (getGeometry() != null)
sb.append("Geometry: ").append(getGeometry()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreateTime() != null)
sb.append("CreateTime: ").append(getCreateTime()).append(",");
if (getUpdateTime() != null)
sb.append("UpdateTime: ").append(getUpdateTime()).append(",");
if (getGeofenceProperties() != null)
sb.append("GeofenceProperties: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetGeofenceResult == false)
return false;
GetGeofenceResult other = (GetGeofenceResult) obj;
if (other.getGeofenceId() == null ^ this.getGeofenceId() == null)
return false;
if (other.getGeofenceId() != null && other.getGeofenceId().equals(this.getGeofenceId()) == false)
return false;
if (other.getGeometry() == null ^ this.getGeometry() == null)
return false;
if (other.getGeometry() != null && other.getGeometry().equals(this.getGeometry()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == 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.getGeofenceProperties() == null ^ this.getGeofenceProperties() == null)
return false;
if (other.getGeofenceProperties() != null && other.getGeofenceProperties().equals(this.getGeofenceProperties()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGeofenceId() == null) ? 0 : getGeofenceId().hashCode());
hashCode = prime * hashCode + ((getGeometry() == null) ? 0 : getGeometry().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreateTime() == null) ? 0 : getCreateTime().hashCode());
hashCode = prime * hashCode + ((getUpdateTime() == null) ? 0 : getUpdateTime().hashCode());
hashCode = prime * hashCode + ((getGeofenceProperties() == null) ? 0 : getGeofenceProperties().hashCode());
return hashCode;
}
@Override
public GetGeofenceResult clone() {
try {
return (GetGeofenceResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}