/* * 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; public class GetGeofenceResult implements Serializable { /** *
* The timestamp for when the geofence collection was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
*
* The geofence identifier. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\p{L}\p{N}]+$
*/
private String geofenceId;
/**
*
* Contains additional user-defined properties stored with the geofence. An * array of key-value pairs. *
*/ private java.util.Map* 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.
*
* The timestamp for when the geofence collection was last updated in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
*
* The timestamp for when the geofence collection was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
*
* The timestamp for when the geofence collection was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
*
* The timestamp for when the geofence collection was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
*
* The timestamp for when the geofence collection was created in
* ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
*
* The timestamp for when the geofence collection was created in ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
*
* Returns a reference to this object so that method calls can be chained * together. * * @param createTime
* The timestamp for when the geofence collection was created in
* ISO
* 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
*
* The geofence identifier. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\p{L}\p{N}]+$
*
* @return
* The geofence identifier. *
*/ public String getGeofenceId() { return geofenceId; } /** ** The geofence identifier. *
*
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\p{L}\p{N}]+$
*
* @param geofenceId
* The geofence identifier. *
*/ public void setGeofenceId(String geofenceId) { this.geofenceId = geofenceId; } /** ** The geofence identifier. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 100
* Pattern: ^[-._\p{L}\p{N}]+$
*
* @param geofenceId
* The geofence identifier. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetGeofenceResult withGeofenceId(String geofenceId) { this.geofenceId = geofenceId; return this; } /** ** Contains additional user-defined properties stored with the geofence. An * array of key-value pairs. *
* * @return* Contains additional user-defined properties stored with the * geofence. An array of key-value pairs. *
*/ public java.util.Map* Contains additional user-defined properties stored with the geofence. An * array of key-value pairs. *
* * @param geofenceProperties* Contains additional user-defined properties stored with the * geofence. An array of key-value pairs. *
*/ public void setGeofenceProperties(java.util.Map* Contains additional user-defined properties stored with the geofence. An * array of key-value pairs. *
** Returns a reference to this object so that method calls can be chained * together. * * @param geofenceProperties
* Contains additional user-defined properties stored with the * geofence. An array of key-value pairs. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetGeofenceResult withGeofenceProperties(java.util.Map* Contains additional user-defined properties stored with the geofence. An * array of key-value pairs. *
*
* The method adds a new key-value pair into GeofenceProperties 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 GeofenceProperties.
* @param value The corresponding value of the entry to be added into
* GeofenceProperties.
* @return A reference to this updated 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
* 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.
*
* Contains the geofence geometry details describing a polygon or a
* circle.
*
* Contains the geofence geometry details describing a polygon or a circle.
*
* Contains the geofence geometry details describing a polygon or
* a circle.
*
* Contains the geofence geometry details describing a polygon or a circle.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param geometry
* Contains the geofence geometry details describing a polygon or
* a circle.
*
* Identifies the state of the geofence. A geofence will hold one of the
* following states:
*
*
*
*
*
*
* Identifies the state of the geofence. A geofence will hold one of
* the following states:
*
*
*
*
*
*
* Identifies the state of the geofence. A geofence will hold one of the
* following states:
*
*
*
*
*
*
* Identifies the state of the geofence. A geofence will hold one
* of the following states:
*
*
*
*
*
*
* Identifies the state of the geofence. A geofence will hold one of the
* following states:
*
*
*
*
*
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param status
* Identifies the state of the geofence. A geofence will hold one
* of the following states:
*
*
*
*
*
*
* The timestamp for when the geofence collection was last updated in ISO
* 8601 format:
* The timestamp for when the geofence collection was last updated
* in ISO
* 8601 format:
* The timestamp for when the geofence collection was last updated in ISO
* 8601 format:
* The timestamp for when the geofence collection was last
* updated in ISO
* 8601 format:
* The timestamp for when the geofence collection was last updated in ISO
* 8601 format:
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param updateTime
* The timestamp for when the geofence collection was last
* updated in ISO
* 8601 format:
*
*
* @return 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 status;
}
/**
* 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 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;
}
/**
* 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.
*
*
* 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 A reference to this updated object so that method calls can be
* chained together.
*/
public GetGeofenceResult withStatus(String status) {
this.status = status;
return this;
}
/**
* 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.
* YYYY-MM-DDThh:mm:ss.sssZ
* YYYY-MM-DDThh:mm:ss.sssZ
* YYYY-MM-DDThh:mm:ss.sssZ
* YYYY-MM-DDThh:mm:ss.sssZ
* YYYY-MM-DDThh:mm:ss.sssZ
* YYYY-MM-DDThh:mm:ss.sssZ
*