Package software.amazon.awssdk.services.location.model

Class CreateMapRequest

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

  • Method Details

    • configuration

      public final MapConfiguration configuration()

      Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

      Returns:
      Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

    • description

      public final String description()

      An optional description for the map resource.

      Returns:
      An optional description for the map resource.

    • mapName

      public final String mapName()

      The name for the map resource.

      Requirements:

      • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

      • Must be a unique map resource name.

      • No spaces allowed. For example, ExampleMap.

      Returns:
      The name for the map resource.

      Requirements:

      • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

      • Must be a unique map resource name.

      • No spaces allowed. For example, ExampleMap.

    • pricingPlan

      @Deprecated public final PricingPlan pricingPlan()
      Deprecated.
      Deprecated. If included, the only allowed value is RequestBasedUsage.

      No longer used. If included, the only allowed value is RequestBasedUsage.

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

      Returns:
      No longer used. If included, the only allowed value is RequestBasedUsage.
      See Also:

    • pricingPlanAsString

      @Deprecated public final String pricingPlanAsString()
      Deprecated.
      Deprecated. If included, the only allowed value is RequestBasedUsage.

      No longer used. If included, the only allowed value is RequestBasedUsage.

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

      Returns:
      No longer used. If included, the only allowed value is RequestBasedUsage.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

      Format: "key" : "value"

      Restrictions:

      • Maximum 50 tags per resource

      • Each resource tag must be unique with a maximum of one value.

      • Maximum key length: 128 Unicode characters in UTF-8

      • Maximum value length: 256 Unicode characters in UTF-8

      • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

      • Cannot use "aws:" as a prefix for a key.

      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 hasTags() method.

      Returns:
      Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

      Format: "key" : "value"

      Restrictions:

      • Maximum 50 tags per resource

      • Each resource tag must be unique with a maximum of one value.

      • Maximum key length: 128 Unicode characters in UTF-8

      • Maximum value length: 256 Unicode characters in UTF-8

      • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

      • Cannot use "aws:" as a prefix for a key.

    • toBuilder

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

    • builder

      public static CreateMapRequest.Builder builder()

    • serializableBuilderClass

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