software.amazon.awssdk.services.location.model

Interface GetGeofenceResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetGeofenceResponse.Builder,GetGeofenceResponse>, LocationResponse.Builder, SdkBuilder<GetGeofenceResponse.Builder,GetGeofenceResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetGeofenceResponse

public static interface GetGeofenceResponse.Builder
extends LocationResponse.Builder, SdkPojo, CopyableBuilder<GetGeofenceResponse.Builder,GetGeofenceResponse>

Method Summary

Modifier and Type	Method and Description
GetGeofenceResponse.Builder	createTime(Instant createTime) The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
GetGeofenceResponse.Builder	geofenceId(String geofenceId) The geofence identifier.
GetGeofenceResponse.Builder	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 a polygon or a circle.
GetGeofenceResponse.Builder	geometry(GeofenceGeometry geometry) Contains the geofence geometry details describing a polygon or a circle.
GetGeofenceResponse.Builder	status(String status) Identifies the state of the geofence.
GetGeofenceResponse.Builder	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.services.location.model.LocationResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

createTime

GetGeofenceResponse.Builder createTime(Instant 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.

geofenceId

GetGeofenceResponse.Builder geofenceId(String geofenceId)

The geofence identifier.

Parameters:

geofenceId - The geofence identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

geofenceProperties

GetGeofenceResponse.Builder geofenceProperties(Map<String,String> 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.

geometry

GetGeofenceResponse.Builder geometry(GeofenceGeometry geometry)

Contains the geofence geometry details describing a polygon or a circle.

Parameters:

geometry - Contains the geofence geometry details describing a polygon or a circle.

Returns:

Returns a reference to this object so that method calls can be chained together.

geometry

default GetGeofenceResponse.Builder geometry(Consumer<GeofenceGeometry.Builder> geometry)

Contains the geofence geometry details describing a polygon or a circle.

This is a convenience method that creates an instance of the GeofenceGeometry.Builder avoiding the need to create one manually via GeofenceGeometry.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to geometry(GeofenceGeometry).

Parameters:

geometry - a consumer that will call methods on GeofenceGeometry.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

geometry(GeofenceGeometry)

status

GetGeofenceResponse.Builder status(String 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.

updateTime

GetGeofenceResponse.Builder updateTime(Instant 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.