software.amazon.awssdk.services.location.model

Class DescribeMapResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.location.model.LocationResponse

software.amazon.awssdk.services.location.model.DescribeMapResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeMapResponse.Builder,DescribeMapResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeMapResponse
extends LocationResponse
implements ToCopyableBuilder<DescribeMapResponse.Builder,DescribeMapResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeMapResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeMapResponse.Builder	builder()
MapConfiguration	configuration() Specifies the map tile style selected from a partner data provider.
Instant	createTime() The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
String	dataSource() Specifies the data provider for the associated map tiles.
String	description() The 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	mapArn() The Amazon Resource Name (ARN) for the map resource.
String	mapName() The map style selected from an available provider.
PricingPlan	pricingPlan() The pricing plan selected for the specified map resource.
String	pricingPlanAsString() The pricing plan selected for the specified map resource.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeMapResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags() Tags associated with the map resource.
DescribeMapResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updateTime() The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 tile style selected from a partner data provider.

Returns:

Specifies the map tile style selected from a partner data provider.

createTime

public final Instant createTime()

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

dataSource

public final String dataSource()

Specifies the data provider for the associated map tiles.

Returns:

Specifies the data provider for the associated map tiles.

description

public final String description()

The optional description for the map resource.

Returns:

The optional description for the map resource.

mapArn

public final String mapArn()

The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:maps/ExampleMap

Returns:

The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:maps/ExampleMap

mapName

public final String mapName()

The map style selected from an available provider.

Returns:

The map style selected from an available provider.

pricingPlan

public final PricingPlan pricingPlan()

The pricing plan selected for the specified map resource.

  <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p> 
 

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:

The pricing plan selected for the specified map resource.

  <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p> 

See Also:

PricingPlan

pricingPlanAsString

public final String pricingPlanAsString()

The pricing plan selected for the specified map resource.

  <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p> 
 

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:

The pricing plan selected for the specified map resource.

  <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p> 

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

Tags associated with the map resource.

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:

Tags associated with the map resource.

updateTime

public final Instant updateTime()

The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

toBuilder

public DescribeMapResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeMapResponse.Builder,DescribeMapResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeMapResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeMapResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo