Interface GetGeofenceResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetGeofenceResponse.Builder,
,GetGeofenceResponse> LocationResponse.Builder
,SdkBuilder<GetGeofenceResponse.Builder,
,GetGeofenceResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetGeofenceResponse
-
Method Summary
Modifier and TypeMethodDescriptioncreateTime
(Instant createTime) The timestamp for when the geofence collection was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
geofenceId
(String geofenceId) The geofence identifier.geofenceProperties
(Map<String, String> geofenceProperties) User defined properties of the geofence.default GetGeofenceResponse.Builder
geometry
(Consumer<GeofenceGeometry.Builder> geometry) Contains the geofence geometry details describing the position of the geofence.geometry
(GeofenceGeometry geometry) Contains the geofence geometry details describing the position of the geofence.Identifies the state of the geofence.updateTime
(Instant updateTime) The timestamp for when the geofence collection was last updated in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.location.model.LocationResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
geofenceId
The geofence identifier.
- Parameters:
geofenceId
- The geofence identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
geometry
Contains the geofence geometry details describing the position of the geofence. Can be a circle, a polygon, or a multipolygon.
- Parameters:
geometry
- Contains the geofence geometry details describing the position of the geofence. Can be a circle, a polygon, or a multipolygon.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
geometry
Contains the geofence geometry details describing the position of the geofence. Can be a circle, a polygon, or a multipolygon.
This is a convenience method that creates an instance of theGeofenceGeometry.Builder
avoiding the need to create one manually viaGeofenceGeometry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togeometry(GeofenceGeometry)
.- Parameters:
geometry
- a consumer that will call methods onGeofenceGeometry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
createTime
The timestamp for when the geofence collection was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
- Parameters:
createTime
- The timestamp for when the geofence collection was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updateTime
The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
- Parameters:
updateTime
- The timestamp for when the geofence collection was last updated in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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"
- Parameters:
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"
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-