Interface PutGeofenceRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>,LocationRequest.Builder,SdkBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- PutGeofenceRequest
public static interface PutGeofenceRequest.Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description PutGeofenceRequest.BuildercollectionName(String collectionName)The geofence collection to store the geofence in.PutGeofenceRequest.BuildergeofenceId(String geofenceId)An identifier for the geofence.PutGeofenceRequest.BuildergeofenceProperties(Map<String,String> geofenceProperties)Associates one of more properties with the geofence.default PutGeofenceRequest.Buildergeometry(Consumer<GeofenceGeometry.Builder> geometry)Contains the details to specify the position of the geofence.PutGeofenceRequest.Buildergeometry(GeofenceGeometry geometry)Contains the details to specify the position of the geofence.PutGeofenceRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)PutGeofenceRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
collectionName
PutGeofenceRequest.Builder collectionName(String collectionName)
The geofence collection to store the geofence in.
- Parameters:
collectionName- The geofence collection to store the geofence in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
geofenceId
PutGeofenceRequest.Builder geofenceId(String geofenceId)
An identifier for the geofence. For example,
ExampleGeofence-1.- Parameters:
geofenceId- An identifier for the geofence. For example,ExampleGeofence-1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
geofenceProperties
PutGeofenceRequest.Builder geofenceProperties(Map<String,String> geofenceProperties)
Associates one of more properties with 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- Associates one of more properties with 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
PutGeofenceRequest.Builder geometry(GeofenceGeometry geometry)
Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.
Each geofence polygon can have a maximum of 1,000 vertices.
- Parameters:
geometry- Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.Each geofence polygon can have a maximum of 1,000 vertices.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
geometry
default PutGeofenceRequest.Builder geometry(Consumer<GeofenceGeometry.Builder> geometry)
Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.
This is a convenience method that creates an instance of theEach geofence polygon can have a maximum of 1,000 vertices.
GeofenceGeometry.Builderavoiding the need to create one manually viaGeofenceGeometry.builder().When the
Consumercompletes,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:
geometry(GeofenceGeometry)
-
overrideConfiguration
PutGeofenceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
PutGeofenceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-