Interface GetStyleDescriptorRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetStyleDescriptorRequest.Builder,GetStyleDescriptorRequest>, GeoMapsRequest.Builder, SdkBuilder<GetStyleDescriptorRequest.Builder,GetStyleDescriptorRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetStyleDescriptorRequest
@Mutable @NotThreadSafe public static interface GetStyleDescriptorRequest.Builder extends GeoMapsRequest.Builder, SdkPojo, CopyableBuilder<GetStyleDescriptorRequest.Builder,GetStyleDescriptorRequest>

  • Method Details

    • style

      GetStyleDescriptorRequest.Builder style(String style)

      Style specifies the desired map style. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the Standard and Monochrome values.

      Parameters:
      style - Style specifies the desired map style. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the Standard and Monochrome values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • style

      GetStyleDescriptorRequest.Builder style(MapStyle style)

      Style specifies the desired map style. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the Standard and Monochrome values.

      Parameters:
      style - Style specifies the desired map style. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the Standard and Monochrome values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • colorScheme

      GetStyleDescriptorRequest.Builder colorScheme(String colorScheme)

      Sets the color tone for the map, such as dark and light.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

      Parameters:
      colorScheme - Sets the color tone for the map, such as dark and light.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

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

    • colorScheme

      GetStyleDescriptorRequest.Builder colorScheme(ColorScheme colorScheme)

      Sets the color tone for the map, such as dark and light.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

      Parameters:
      colorScheme - Sets the color tone for the map, such as dark and light.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

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

    • politicalView

      GetStyleDescriptorRequest.Builder politicalView(String politicalView)

      Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      The following political views are currently supported:

      • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

      • EGY: Egypt's view on Bir Tawil

      • IND: India's view on Gilgit-Baltistan

      • KEN: Kenya's view on the Ilemi Triangle

      • MAR: Morocco's view on Western Sahara

      • RUS: Russia's view on Crimea

      • SDN: Sudan's view on the Halaib Triangle

      • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

      • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

      • SYR: Syria's view on the Golan Heights

      • TUR: Turkey's view on Cyprus and Northern Cyprus

      • TZA: Tanzania's view on Lake Malawi

      • URY: Uruguay's view on Rincon de Artigas

      • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

      Parameters:
      politicalView - Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      The following political views are currently supported:

      • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

      • EGY: Egypt's view on Bir Tawil

      • IND: India's view on Gilgit-Baltistan

      • KEN: Kenya's view on the Ilemi Triangle

      • MAR: Morocco's view on Western Sahara

      • RUS: Russia's view on Crimea

      • SDN: Sudan's view on the Halaib Triangle

      • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

      • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

      • SYR: Syria's view on the Golan Heights

      • TUR: Turkey's view on Cyprus and Northern Cyprus

      • TZA: Tanzania's view on Lake Malawi

      • URY: Uruguay's view on Rincon de Artigas

      • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

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

    • terrain

      GetStyleDescriptorRequest.Builder terrain(String terrain)

      Adjusts how physical terrain details are rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      The following terrain styles are currently supported:

      • Hillshade: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.

      • Terrain3D: Displays physical terrain details and elevations as a three-dimensional model.

      Hillshade is valid only for the Standard and Monochrome map styles.

      Parameters:
      terrain - Adjusts how physical terrain details are rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      The following terrain styles are currently supported:

      • Hillshade: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.

      • Terrain3D: Displays physical terrain details and elevations as a three-dimensional model.

      Hillshade is valid only for the Standard and Monochrome map styles.

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

    • terrain

      GetStyleDescriptorRequest.Builder terrain(Terrain terrain)

      Adjusts how physical terrain details are rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      The following terrain styles are currently supported:

      • Hillshade: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.

      • Terrain3D: Displays physical terrain details and elevations as a three-dimensional model.

      Hillshade is valid only for the Standard and Monochrome map styles.

      Parameters:
      terrain - Adjusts how physical terrain details are rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      The following terrain styles are currently supported:

      • Hillshade: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.

      • Terrain3D: Displays physical terrain details and elevations as a three-dimensional model.

      Hillshade is valid only for the Standard and Monochrome map styles.

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

    • contourDensity

      GetStyleDescriptorRequest.Builder contourDensity(String contourDensity)

      Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

      Parameters:
      contourDensity - Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

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

    • contourDensity

      GetStyleDescriptorRequest.Builder contourDensity(ContourDensity contourDensity)

      Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

      Parameters:
      contourDensity - Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

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

    • traffic

      GetStyleDescriptorRequest.Builder traffic(String traffic)

      Displays real-time traffic information overlay on map, such as incident events and flow events. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

      Parameters:
      traffic - Displays real-time traffic information overlay on map, such as incident events and flow events. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

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

    • traffic

      GetStyleDescriptorRequest.Builder traffic(Traffic traffic)

      Displays real-time traffic information overlay on map, such as incident events and flow events. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

      Parameters:
      traffic - Displays real-time traffic information overlay on map, such as incident events and flow events. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

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

    • travelModesWithStrings

      GetStyleDescriptorRequest.Builder travelModesWithStrings(Collection<String> travelModes)

      Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

      Parameters:
      travelModes - Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

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

    • travelModesWithStrings

      GetStyleDescriptorRequest.Builder travelModesWithStrings(String... travelModes)

      Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

      Parameters:
      travelModes - Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

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

    • travelModes

      GetStyleDescriptorRequest.Builder travelModes(Collection<TravelMode> travelModes)

      Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

      Parameters:
      travelModes - Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

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

    • travelModes

      GetStyleDescriptorRequest.Builder travelModes(TravelMode... travelModes)

      Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

      Parameters:
      travelModes - Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      This parameter is valid for all map styles except Satellite.

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

    • buildings

      GetStyleDescriptorRequest.Builder buildings(String buildings)

      Adjusts how building details are rendered on the map.

      The following building styles are currently supported:

      • Buildings3D: Displays buildings as three-dimensional extrusions on the map.

      Buildings3D is valid only for the Standard and Monochrome map styles.

      Parameters:
      buildings - Adjusts how building details are rendered on the map.

      The following building styles are currently supported:

      • Buildings3D: Displays buildings as three-dimensional extrusions on the map.

      Buildings3D is valid only for the Standard and Monochrome map styles.

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

    • buildings

      GetStyleDescriptorRequest.Builder buildings(Buildings buildings)

      Adjusts how building details are rendered on the map.

      The following building styles are currently supported:

      • Buildings3D: Displays buildings as three-dimensional extrusions on the map.

      Buildings3D is valid only for the Standard and Monochrome map styles.

      Parameters:
      buildings - Adjusts how building details are rendered on the map.

      The following building styles are currently supported:

      • Buildings3D: Displays buildings as three-dimensional extrusions on the map.

      Buildings3D is valid only for the Standard and Monochrome map styles.

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

    • poiDensity

      GetStyleDescriptorRequest.Builder poiDensity(String poiDensity)

      Controls how densely points of interest are rendered on the map. The density value controls the zoom level at which each category of points of interest appears, and how quickly less prominent points of interest are revealed as you zoom in. Denser values display more points of interest at lower zoom levels.

      Use Off to hide all points of interest. When you omit this parameter, the map renders at Default density.

      The difference between density values is most noticeable at mid-range zoom levels. At high zoom levels, all density values converge on displaying every available point of interest.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

      Parameters:
      poiDensity - Controls how densely points of interest are rendered on the map. The density value controls the zoom level at which each category of points of interest appears, and how quickly less prominent points of interest are revealed as you zoom in. Denser values display more points of interest at lower zoom levels.

      Use Off to hide all points of interest. When you omit this parameter, the map renders at Default density.

      The difference between density values is most noticeable at mid-range zoom levels. At high zoom levels, all density values converge on displaying every available point of interest.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

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

    • poiDensity

      GetStyleDescriptorRequest.Builder poiDensity(PoiDensity poiDensity)

      Controls how densely points of interest are rendered on the map. The density value controls the zoom level at which each category of points of interest appears, and how quickly less prominent points of interest are revealed as you zoom in. Denser values display more points of interest at lower zoom levels.

      Use Off to hide all points of interest. When you omit this parameter, the map renders at Default density.

      The difference between density values is most noticeable at mid-range zoom levels. At high zoom levels, all density values converge on displaying every available point of interest.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

      Parameters:
      poiDensity - Controls how densely points of interest are rendered on the map. The density value controls the zoom level at which each category of points of interest appears, and how quickly less prominent points of interest are revealed as you zoom in. Denser values display more points of interest at lower zoom levels.

      Use Off to hide all points of interest. When you omit this parameter, the map renders at Default density.

      The difference between density values is most noticeable at mid-range zoom levels. At high zoom levels, all density values converge on displaying every available point of interest.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

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

    • poiCategoriesWithStrings

      GetStyleDescriptorRequest.Builder poiCategoriesWithStrings(Collection<String> poiCategories)

      Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

      The following categories are currently supported:

      • FoodAndDrink

      • Entertainment

      • SightsAndMuseums

      • Transportation

      • Accommodations

      • LeisureAndOutdoor

      • Shopping

      • BusinessAndServices

      • FacilitiesAndBuildings

      Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

      This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

      Parameters:
      poiCategories - Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

      The following categories are currently supported:

      • FoodAndDrink

      • Entertainment

      • SightsAndMuseums

      • Transportation

      • Accommodations

      • LeisureAndOutdoor

      • Shopping

      • BusinessAndServices

      • FacilitiesAndBuildings

      Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

      This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

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

    • poiCategoriesWithStrings

      GetStyleDescriptorRequest.Builder poiCategoriesWithStrings(String... poiCategories)

      Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

      The following categories are currently supported:

      • FoodAndDrink

      • Entertainment

      • SightsAndMuseums

      • Transportation

      • Accommodations

      • LeisureAndOutdoor

      • Shopping

      • BusinessAndServices

      • FacilitiesAndBuildings

      Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

      This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

      Parameters:
      poiCategories - Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

      The following categories are currently supported:

      • FoodAndDrink

      • Entertainment

      • SightsAndMuseums

      • Transportation

      • Accommodations

      • LeisureAndOutdoor

      • Shopping

      • BusinessAndServices

      • FacilitiesAndBuildings

      Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

      This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

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

    • poiCategories

      GetStyleDescriptorRequest.Builder poiCategories(Collection<PoiCategory> poiCategories)

      Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

      The following categories are currently supported:

      • FoodAndDrink

      • Entertainment

      • SightsAndMuseums

      • Transportation

      • Accommodations

      • LeisureAndOutdoor

      • Shopping

      • BusinessAndServices

      • FacilitiesAndBuildings

      Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

      This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

      Parameters:
      poiCategories - Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

      The following categories are currently supported:

      • FoodAndDrink

      • Entertainment

      • SightsAndMuseums

      • Transportation

      • Accommodations

      • LeisureAndOutdoor

      • Shopping

      • BusinessAndServices

      • FacilitiesAndBuildings

      Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

      This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

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

    • poiCategories

      GetStyleDescriptorRequest.Builder poiCategories(PoiCategory... poiCategories)

      Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

      The following categories are currently supported:

      • FoodAndDrink

      • Entertainment

      • SightsAndMuseums

      • Transportation

      • Accommodations

      • LeisureAndOutdoor

      • Shopping

      • BusinessAndServices

      • FacilitiesAndBuildings

      Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

      This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

      Parameters:
      poiCategories - Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

      The following categories are currently supported:

      • FoodAndDrink

      • Entertainment

      • SightsAndMuseums

      • Transportation

      • Accommodations

      • LeisureAndOutdoor

      • Shopping

      • BusinessAndServices

      • FacilitiesAndBuildings

      Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

      This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

      This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

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

    • key

      GetStyleDescriptorRequest.Builder key(String key)

      Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

      Parameters:
      key - Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetStyleDescriptorRequest.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

      GetStyleDescriptorRequest.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.