Class DescribeGeofenceCollectionResponse
- 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.DescribeGeofenceCollectionResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeGeofenceCollectionResponse.Builder,DescribeGeofenceCollectionResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeGeofenceCollectionResponse extends LocationResponse implements ToCopyableBuilder<DescribeGeofenceCollectionResponse.Builder,DescribeGeofenceCollectionResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeGeofenceCollectionResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static DescribeGeofenceCollectionResponse.Builderbuilder()StringcollectionArn()The Amazon Resource Name (ARN) for the geofence collection resource.StringcollectionName()The name of the geofence collection.InstantcreateTime()The timestamp for when the geofence resource was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZStringdescription()The optional description for the geofence collection.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)IntegergeofenceCount()The number of geofences in the geofence collection.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringkmsKeyId()A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resourcePricingPlanpricingPlan()Deprecated.Deprecated.StringpricingPlanAsString()Deprecated.Deprecated.StringpricingPlanDataSource()Deprecated.Deprecated.List<SdkField<?>>sdkFields()static Class<? extends DescribeGeofenceCollectionResponse.Builder>serializableBuilderClass()Map<String,String>tags()Displays the key, value pairs of tags associated with this resource.DescribeGeofenceCollectionResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdateTime()The timestamp for when the geofence collection was last updated 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
-
collectionName
public final String collectionName()
The name of the geofence collection.
- Returns:
- The name of the geofence collection.
-
collectionArn
public final String collectionArn()
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.
-
Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
- Returns:
- The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a
resource across all Amazon Web Services.
-
Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
-
-
-
description
public final String description()
The optional description for the geofence collection.
- Returns:
- The optional description for the geofence collection.
-
pricingPlan
@Deprecated public final PricingPlan pricingPlan()
Deprecated.Deprecated. Always returns RequestBasedUsage.No longer used. Always returns
RequestBasedUsage.If the service returns an enum value that is not available in the current SDK version,
pricingPlanwill returnPricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompricingPlanAsString().- Returns:
- No longer used. Always returns
RequestBasedUsage. - See Also:
PricingPlan
-
pricingPlanAsString
@Deprecated public final String pricingPlanAsString()
Deprecated.Deprecated. Always returns RequestBasedUsage.No longer used. Always returns
RequestBasedUsage.If the service returns an enum value that is not available in the current SDK version,
pricingPlanwill returnPricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompricingPlanAsString().- Returns:
- No longer used. Always returns
RequestBasedUsage. - See Also:
PricingPlan
-
pricingPlanDataSource
@Deprecated public final String pricingPlanDataSource()
Deprecated.Deprecated. Unused.No longer used. Always returns an empty string.
- Returns:
- No longer used. Always returns an empty string.
-
kmsKeyId
public final String kmsKeyId()
A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource
- Returns:
- A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource
-
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 theisEmpty()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()
Displays the key, value pairs of tags associated with this 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:
- Displays the key, value pairs of tags associated with this resource.
-
createTime
public final Instant createTime()
The timestamp for when the geofence resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ- Returns:
- The timestamp for when the geofence resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
-
updateTime
public final Instant updateTime()
The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ- Returns:
- The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
-
geofenceCount
public final Integer geofenceCount()
The number of geofences in the geofence collection.
- Returns:
- The number of geofences in the geofence collection.
-
toBuilder
public DescribeGeofenceCollectionResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeGeofenceCollectionResponse.Builder,DescribeGeofenceCollectionResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeGeofenceCollectionResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeGeofenceCollectionResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-