Package software.amazon.awssdk.services.geomaps.model

Class GetSpritesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSpritesRequest.Builder,GetSpritesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetSpritesRequest
extends GeoMapsRequest
implements ToCopyableBuilder<GetSpritesRequest.Builder,GetSpritesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSpritesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetSpritesRequest.Builder	builder()
ColorScheme	colorScheme()	Sets color tone for map such as dark and light for specific map styles.
String	colorSchemeAsString()	Sets color tone for map such as dark and light for specific map styles.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileName()	Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?\.(png|json).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetSpritesRequest.Builder>	serializableBuilderClass()
MapStyle	style()	Style specifies the desired map style for the Sprites APIs.
String	styleAsString()	Style specifies the desired map style for the Sprites APIs.
GetSpritesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Variant	variant()	Optimizes map styles for specific use case or industry.
String	variantAsString()	Optimizes map styles for specific use case or industry.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fileName

public final String fileName()

Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?\.(png|json).

Example: sprites.png

Returns:

Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?\.(png|json).

Example: sprites.png

style

public final MapStyle style()

Style specifies the desired map style for the Sprites APIs.

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 for the Sprites APIs.

See Also:

MapStyle

styleAsString

public final String styleAsString()

Style specifies the desired map style for the Sprites APIs.

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 for the Sprites APIs.

See Also:

MapStyle

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:

ColorScheme

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:

ColorScheme

variant

public final Variant variant()

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

Valid values for Variant are case sensitive.

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

Returns:

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

Valid values for Variant are case sensitive.

See Also:

Variant

variantAsString

public final String variantAsString()

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

Valid values for Variant are case sensitive.

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

Returns:

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

Valid values for Variant are case sensitive.

See Also:

Variant

toBuilder

public GetSpritesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSpritesRequest.Builder,GetSpritesRequest>

Specified by:

toBuilder in class GeoMapsRequest

builder

public static GetSpritesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetSpritesRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo