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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public GetSpritesRequest.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<GetSpritesRequest.Builder,GetSpritesRequest>
      Specified by:
      toBuilder in class GeoMapsRequest
      Returns:
      a builder for type T

    • 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)
      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.