Class GetStyleDescriptorRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.geomaps.model.GeoMapsRequest
software.amazon.awssdk.services.geomaps.model.GetStyleDescriptorRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetStyleDescriptorRequest.Builder,GetStyleDescriptorRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetStyleDescriptorRequest extends GeoMapsRequest implements ToCopyableBuilder<GetStyleDescriptorRequest.Builder,GetStyleDescriptorRequest>

  • Method Details

    • style

      public final MapStyle style()

      Style specifies the desired map style.

      If the service returns an enum value that is not available in the current SDK version, style will return MapStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from styleAsString().

      Returns:
      Style specifies the desired map style.
      See Also:

    • styleAsString

      public final String styleAsString()

      Style specifies the desired map style.

      If the service returns an enum value that is not available in the current SDK version, style will return MapStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from styleAsString().

      Returns:
      Style specifies the desired map style.
      See Also:

    • colorScheme

      public final ColorScheme colorScheme()

      Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

      If the service returns an enum value that is not available in the current SDK version, colorScheme will return ColorScheme.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorSchemeAsString().

      Returns:
      Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

      See Also:

    • colorSchemeAsString

      public final String colorSchemeAsString()

      Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

      If the service returns an enum value that is not available in the current SDK version, colorScheme will return ColorScheme.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from colorSchemeAsString().

      Returns:
      Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

      See Also:

    • politicalView

      public final String politicalView()

      Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.

      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:
      Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.

      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

    • terrain

      public final Terrain terrain()

      Adjusts how physical terrain details are rendered on the map.

      The following terrain styles are currently supported:

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

      This parameter is valid only for the Standard map style.

      If the service returns an enum value that is not available in the current SDK version, terrain will return Terrain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from terrainAsString().

      Returns:
      Adjusts how physical terrain details are rendered on the map.

      The following terrain styles are currently supported:

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

      This parameter is valid only for the Standard map style.

      See Also:

    • terrainAsString

      public final String terrainAsString()

      Adjusts how physical terrain details are rendered on the map.

      The following terrain styles are currently supported:

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

      This parameter is valid only for the Standard map style.

      If the service returns an enum value that is not available in the current SDK version, terrain will return Terrain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from terrainAsString().

      Returns:
      Adjusts how physical terrain details are rendered on the map.

      The following terrain styles are currently supported:

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

      This parameter is valid only for the Standard map style.

      See Also:

    • contourDensity

      public final 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.

      This parameter is valid only for the Standard map style.

      If the service returns an enum value that is not available in the current SDK version, contourDensity will return ContourDensity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contourDensityAsString().

      Returns:
      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.

      This parameter is valid only for the Standard map style.

      See Also:

    • contourDensityAsString

      public final String contourDensityAsString()

      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.

      This parameter is valid only for the Standard map style.

      If the service returns an enum value that is not available in the current SDK version, contourDensity will return ContourDensity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contourDensityAsString().

      Returns:
      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.

      This parameter is valid only for the Standard map style.

      See Also:

    • traffic

      public final Traffic traffic()

      Displays real-time traffic information overlay on map, such as incident events and flow events.

      This parameter is valid only for the Standard map style.

      If the service returns an enum value that is not available in the current SDK version, traffic will return Traffic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficAsString().

      Returns:
      Displays real-time traffic information overlay on map, such as incident events and flow events.

      This parameter is valid only for the Standard map style.

      See Also:

    • trafficAsString

      public final String trafficAsString()

      Displays real-time traffic information overlay on map, such as incident events and flow events.

      This parameter is valid only for the Standard map style.

      If the service returns an enum value that is not available in the current SDK version, traffic will return Traffic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trafficAsString().

      Returns:
      Displays real-time traffic information overlay on map, such as incident events and flow events.

      This parameter is valid only for the Standard map style.

      See Also:

    • travelModes

      public final List<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.

      This parameter is valid only for the Standard map style.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTravelModes() method.

      Returns:
      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.

      This parameter is valid only for the Standard map style.

    • hasTravelModes

      public final boolean hasTravelModes()
      For responses, this returns true if the service returned a value for the TravelModes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • travelModesAsStrings

      public final List<String> travelModesAsStrings()

      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.

      This parameter is valid only for the Standard map style.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTravelModes() method.

      Returns:
      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.

      This parameter is valid only for the Standard map style.

    • key

      public final 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.

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

    • toBuilder

      public GetStyleDescriptorRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetStyleDescriptorRequest.Builder,GetStyleDescriptorRequest>
      Specified by:
      toBuilder in class GeoMapsRequest
      Returns:
      a builder for type T

    • builder

      public static GetStyleDescriptorRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetStyleDescriptorRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.