Class GetStyleDescriptorRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetStyleDescriptorRequest.Builder,
GetStyleDescriptorRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ColorScheme
Sets color tone for map such as dark and light for specific map styles.final String
Sets color tone for map such as dark and light for specific map styles.final ContourDensity
Displays the shape and steepness of terrain features using elevation lines.final String
Displays the shape and steepness of terrain features using elevation lines.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TravelModes property.final String
key()
Optional: The API key to be used for authorization.final String
Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.static Class
<? extends GetStyleDescriptorRequest.Builder> final MapStyle
style()
Style specifies the desired map style.final String
Style specifies the desired map style.final Terrain
terrain()
Adjusts how physical terrain details are rendered on the map.final String
Adjusts how physical terrain details are rendered on the map.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Traffic
traffic()
Displays real-time traffic information overlay on map, such as incident events and flow events.final String
Displays real-time traffic information overlay on map, such as incident events and flow events.final List
<TravelMode> Renders additional map information relevant to selected travel modes.Renders additional map information relevant to selected travel modes.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnMapStyle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstyleAsString()
.- Returns:
- Style specifies the desired map style.
- See Also:
-
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 returnMapStyle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstyleAsString()
.- Returns:
- Style specifies the desired map style.
- See Also:
-
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 returnColorScheme.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcolorSchemeAsString()
.- 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
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 returnColorScheme.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcolorSchemeAsString()
.- 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
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
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 returnTerrain.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromterrainAsString()
.- 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
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 returnTerrain.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromterrainAsString()
.- 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
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 returnContourDensity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontourDensityAsString()
.- 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
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 returnContourDensity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontourDensityAsString()
.- 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
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 returnTraffic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrafficAsString()
.- 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
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 returnTraffic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrafficAsString()
.- 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
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<GetStyleDescriptorRequest.Builder,
GetStyleDescriptorRequest> - Specified by:
toBuilder
in classGeoMapsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-