Package software.amazon.awssdk.services.location.model

Interface CreateGeofenceCollectionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateGeofenceCollectionRequest.Builder,CreateGeofenceCollectionRequest>, LocationRequest.Builder, SdkBuilder<CreateGeofenceCollectionRequest.Builder,CreateGeofenceCollectionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGeofenceCollectionRequest
public static interface CreateGeofenceCollectionRequest.Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder<CreateGeofenceCollectionRequest.Builder,CreateGeofenceCollectionRequest>

  • Method Details

    • collectionName

      CreateGeofenceCollectionRequest.Builder collectionName(String collectionName)

      A custom name for the geofence collection.

      Requirements:

      • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

      • Must be a unique geofence collection name.

      • No spaces allowed. For example, ExampleGeofenceCollection.

      Parameters:
      collectionName - A custom name for the geofence collection.

      Requirements:

      • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

      • Must be a unique geofence collection name.

      • No spaces allowed. For example, ExampleGeofenceCollection.

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

    • description

      CreateGeofenceCollectionRequest.Builder description(String description)

      An optional description for the geofence collection.

      Parameters:
      description - An optional description for the geofence collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateGeofenceCollectionRequest.Builder kmsKeyId(String kmsKeyId)

      A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

      Parameters:
      kmsKeyId - A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pricingPlan

      @Deprecated CreateGeofenceCollectionRequest.Builder pricingPlan(String pricingPlan)
      Deprecated.
      Deprecated. If included, the only allowed value is RequestBasedUsage.

      No longer used. If included, the only allowed value is RequestBasedUsage.

      Parameters:
      pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pricingPlan

      @Deprecated CreateGeofenceCollectionRequest.Builder pricingPlan(PricingPlan pricingPlan)
      Deprecated.
      Deprecated. If included, the only allowed value is RequestBasedUsage.

      No longer used. If included, the only allowed value is RequestBasedUsage.

      Parameters:
      pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pricingPlanDataSource

      @Deprecated CreateGeofenceCollectionRequest.Builder pricingPlanDataSource(String pricingPlanDataSource)
      Deprecated.
      Deprecated. No longer allowed.

      This parameter is no longer used.

      Parameters:
      pricingPlanDataSource - This parameter is no longer used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateGeofenceCollectionRequest.Builder tags(Map<String,String> tags)

      Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

      Format: "key" : "value"

      Restrictions:

      • Maximum 50 tags per resource

      • Each resource tag must be unique with a maximum of one value.

      • Maximum key length: 128 Unicode characters in UTF-8

      • Maximum value length: 256 Unicode characters in UTF-8

      • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

      • Cannot use "aws:" as a prefix for a key.

      Parameters:
      tags - Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

      Format: "key" : "value"

      Restrictions:

      • Maximum 50 tags per resource

      • Each resource tag must be unique with a maximum of one value.

      • Maximum key length: 128 Unicode characters in UTF-8

      • Maximum value length: 256 Unicode characters in UTF-8

      • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

      • Cannot use "aws:" as a prefix for a key.

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

    • overrideConfiguration

      CreateGeofenceCollectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateGeofenceCollectionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.