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(value="software.amazon.awssdk:codegen")
public final class CreateMapRequest
extends LocationRequest
implements ToCopyableBuilder<CreateMapRequest.Builder,CreateMapRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateMapRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateMapRequest.Builder	builder()
MapConfiguration	configuration() Specifies the map style selected from an available data provider.
String	description() An optional description for the map resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	mapName() The name for the map resource.
PricingPlan	pricingPlan() Deprecated. Deprecated. If included, the only allowed value is RequestBasedUsage.
String	pricingPlanAsString() Deprecated. Deprecated. If included, the only allowed value is RequestBasedUsage.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateMapRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Applies one or more tags to the map resource.
CreateMapRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

configuration

public final MapConfiguration configuration()

Specifies the map style selected from an available data provider.

Returns:

Specifies the map style selected from an available data provider.

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:

PricingPlan

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:

PricingPlan

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()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateMapRequest.Builder,CreateMapRequest>

Specified by:

toBuilder in class LocationRequest

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)

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