/* * 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.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 timestamp for when the geofence collection was created in ISO 8601 format: * YYYY-MM-DDThh:mm:ss.sssZ *

*/ private java.util.Date createTime; /** *

* The geofence identifier. *

*/ private String geofenceId; /** *

* 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; /** *

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

* */ private String status; /** *

* 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 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 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; } /** *

* 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; } /** *

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

* * * @param status * Identifies the state of the geofence. A geofence will hold one of the following states:

*