software.amazon.awssdk.services.location.model.DescribeGeofenceCollectionResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of location Show documentation
Show all versions of location Show documentation
The AWS Java SDK for Location module holds the client classes that are used for
communicating with Location.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.location.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.traits.TimestampFormatTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeGeofenceCollectionResponse extends LocationResponse implements
ToCopyableBuilder {
private static final SdkField COLLECTION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CollectionArn").getter(getter(DescribeGeofenceCollectionResponse::collectionArn))
.setter(setter(Builder::collectionArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CollectionArn").build()).build();
private static final SdkField COLLECTION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CollectionName").getter(getter(DescribeGeofenceCollectionResponse::collectionName))
.setter(setter(Builder::collectionName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CollectionName").build()).build();
private static final SdkField CREATE_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("CreateTime")
.getter(getter(DescribeGeofenceCollectionResponse::createTime))
.setter(setter(Builder::createTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateTime").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(DescribeGeofenceCollectionResponse::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField GEOFENCE_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("GeofenceCount").getter(getter(DescribeGeofenceCollectionResponse::geofenceCount))
.setter(setter(Builder::geofenceCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GeofenceCount").build()).build();
private static final SdkField KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KmsKeyId").getter(getter(DescribeGeofenceCollectionResponse::kmsKeyId))
.setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKeyId").build()).build();
private static final SdkField PRICING_PLAN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PricingPlan").getter(getter(DescribeGeofenceCollectionResponse::pricingPlanAsString))
.setter(setter(Builder::pricingPlan))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PricingPlan").build()).build();
private static final SdkField PRICING_PLAN_DATA_SOURCE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PricingPlanDataSource").getter(getter(DescribeGeofenceCollectionResponse::pricingPlanDataSource))
.setter(setter(Builder::pricingPlanDataSource))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PricingPlanDataSource").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(DescribeGeofenceCollectionResponse::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField UPDATE_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("UpdateTime")
.getter(getter(DescribeGeofenceCollectionResponse::updateTime))
.setter(setter(Builder::updateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpdateTime").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COLLECTION_ARN_FIELD,
COLLECTION_NAME_FIELD, CREATE_TIME_FIELD, DESCRIPTION_FIELD, GEOFENCE_COUNT_FIELD, KMS_KEY_ID_FIELD,
PRICING_PLAN_FIELD, PRICING_PLAN_DATA_SOURCE_FIELD, TAGS_FIELD, UPDATE_TIME_FIELD));
private final String collectionArn;
private final String collectionName;
private final Instant createTime;
private final String description;
private final Integer geofenceCount;
private final String kmsKeyId;
private final String pricingPlan;
private final String pricingPlanDataSource;
private final Map tags;
private final Instant updateTime;
private DescribeGeofenceCollectionResponse(BuilderImpl builder) {
super(builder);
this.collectionArn = builder.collectionArn;
this.collectionName = builder.collectionName;
this.createTime = builder.createTime;
this.description = builder.description;
this.geofenceCount = builder.geofenceCount;
this.kmsKeyId = builder.kmsKeyId;
this.pricingPlan = builder.pricingPlan;
this.pricingPlanDataSource = builder.pricingPlanDataSource;
this.tags = builder.tags;
this.updateTime = builder.updateTime;
}
/**
*
* 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
*
*
*
*
* @return 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
*
*
*/
public final String collectionArn() {
return collectionArn;
}
/**
*
* The name of the geofence collection.
*
*
* @return The name of the geofence collection.
*/
public final String collectionName() {
return collectionName;
}
/**
*
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @return The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*/
public final Instant createTime() {
return createTime;
}
/**
*
* The optional description for the geofence collection.
*
*
* @return The optional description for the geofence collection.
*/
public final String description() {
return description;
}
/**
*
* The number of geofences in the geofence collection.
*
*
* @return The number of geofences in the geofence collection.
*/
public final Integer geofenceCount() {
return geofenceCount;
}
/**
*
* A key identifier for an Amazon
* Web Services KMS customer managed key assigned to the Amazon Location resource
*
*
* @return A key identifier for an Amazon Web Services KMS
* customer managed key assigned to the Amazon Location resource
*/
public final String kmsKeyId() {
return kmsKeyId;
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #pricingPlan} will
* return {@link PricingPlan#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #pricingPlanAsString}.
*
*
* @return No longer used. Always returns RequestBasedUsage.
* @see PricingPlan
* @deprecated Deprecated. Always returns RequestBasedUsage.
*/
@Deprecated
public final PricingPlan pricingPlan() {
return PricingPlan.fromValue(pricingPlan);
}
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #pricingPlan} will
* return {@link PricingPlan#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #pricingPlanAsString}.
*
*
* @return No longer used. Always returns RequestBasedUsage.
* @see PricingPlan
* @deprecated Deprecated. Always returns RequestBasedUsage.
*/
@Deprecated
public final String pricingPlanAsString() {
return pricingPlan;
}
/**
*
* No longer used. Always returns an empty string.
*
*
* @return No longer used. Always returns an empty string.
* @deprecated Deprecated. Unused.
*/
@Deprecated
public final String pricingPlanDataSource() {
return pricingPlanDataSource;
}
/**
* 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 {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* 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 {@link #hasTags} method.
*
*
* @return Displays the key, value pairs of tags associated with this resource.
*/
public final Map tags() {
return tags;
}
/**
*
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @return The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*/
public final Instant updateTime() {
return updateTime;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(collectionArn());
hashCode = 31 * hashCode + Objects.hashCode(collectionName());
hashCode = 31 * hashCode + Objects.hashCode(createTime());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(geofenceCount());
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
hashCode = 31 * hashCode + Objects.hashCode(pricingPlanAsString());
hashCode = 31 * hashCode + Objects.hashCode(pricingPlanDataSource());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(updateTime());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeGeofenceCollectionResponse)) {
return false;
}
DescribeGeofenceCollectionResponse other = (DescribeGeofenceCollectionResponse) obj;
return Objects.equals(collectionArn(), other.collectionArn()) && Objects.equals(collectionName(), other.collectionName())
&& Objects.equals(createTime(), other.createTime()) && Objects.equals(description(), other.description())
&& Objects.equals(geofenceCount(), other.geofenceCount()) && Objects.equals(kmsKeyId(), other.kmsKeyId())
&& Objects.equals(pricingPlanAsString(), other.pricingPlanAsString())
&& Objects.equals(pricingPlanDataSource(), other.pricingPlanDataSource()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(updateTime(), other.updateTime());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeGeofenceCollectionResponse").add("CollectionArn", collectionArn())
.add("CollectionName", collectionName()).add("CreateTime", createTime()).add("Description", description())
.add("GeofenceCount", geofenceCount()).add("KmsKeyId", kmsKeyId()).add("PricingPlan", pricingPlanAsString())
.add("PricingPlanDataSource", pricingPlanDataSource()).add("Tags", hasTags() ? tags() : null)
.add("UpdateTime", updateTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CollectionArn":
return Optional.ofNullable(clazz.cast(collectionArn()));
case "CollectionName":
return Optional.ofNullable(clazz.cast(collectionName()));
case "CreateTime":
return Optional.ofNullable(clazz.cast(createTime()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "GeofenceCount":
return Optional.ofNullable(clazz.cast(geofenceCount()));
case "KmsKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
case "PricingPlan":
return Optional.ofNullable(clazz.cast(pricingPlanAsString()));
case "PricingPlanDataSource":
return Optional.ofNullable(clazz.cast(pricingPlanDataSource()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "UpdateTime":
return Optional.ofNullable(clazz.cast(updateTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeGeofenceCollectionResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LocationResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* 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
*
*
*
*
* @param 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder collectionArn(String collectionArn);
/**
*
* The name of the geofence collection.
*
*
* @param collectionName
* The name of the geofence collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder collectionName(String collectionName);
/**
*
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @param createTime
* The timestamp for when the geofence resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createTime(Instant createTime);
/**
*
* The optional description for the geofence collection.
*
*
* @param description
* The optional description for the geofence collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The number of geofences in the geofence collection.
*
*
* @param geofenceCount
* The number of geofences in the geofence collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder geofenceCount(Integer geofenceCount);
/**
*
* A key identifier for an Amazon Web Services KMS
* customer managed key assigned to the Amazon Location resource
*
*
* @param kmsKeyId
* A key identifier for an Amazon Web Services KMS
* customer managed key assigned to the Amazon Location resource
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage.
* @see PricingPlan
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
* @deprecated Deprecated. Always returns RequestBasedUsage.
*/
@Deprecated
Builder pricingPlan(String pricingPlan);
/**
*
* No longer used. Always returns RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. Always returns RequestBasedUsage.
* @see PricingPlan
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
* @deprecated Deprecated. Always returns RequestBasedUsage.
*/
@Deprecated
Builder pricingPlan(PricingPlan pricingPlan);
/**
*
* No longer used. Always returns an empty string.
*
*
* @param pricingPlanDataSource
* No longer used. Always returns an empty string.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated Deprecated. Unused.
*/
@Deprecated
Builder pricingPlanDataSource(String pricingPlanDataSource);
/**
*
* Displays the key, value pairs of tags associated with this resource.
*
*
* @param tags
* Displays the key, value pairs of tags associated with this resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
*
*
* @param updateTime
* The timestamp for when the geofence collection was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updateTime(Instant updateTime);
}
static final class BuilderImpl extends LocationResponse.BuilderImpl implements Builder {
private String collectionArn;
private String collectionName;
private Instant createTime;
private String description;
private Integer geofenceCount;
private String kmsKeyId;
private String pricingPlan;
private String pricingPlanDataSource;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private Instant updateTime;
private BuilderImpl() {
}
private BuilderImpl(DescribeGeofenceCollectionResponse model) {
super(model);
collectionArn(model.collectionArn);
collectionName(model.collectionName);
createTime(model.createTime);
description(model.description);
geofenceCount(model.geofenceCount);
kmsKeyId(model.kmsKeyId);
pricingPlan(model.pricingPlan);
pricingPlanDataSource(model.pricingPlanDataSource);
tags(model.tags);
updateTime(model.updateTime);
}
public final String getCollectionArn() {
return collectionArn;
}
public final void setCollectionArn(String collectionArn) {
this.collectionArn = collectionArn;
}
@Override
public final Builder collectionArn(String collectionArn) {
this.collectionArn = collectionArn;
return this;
}
public final String getCollectionName() {
return collectionName;
}
public final void setCollectionName(String collectionName) {
this.collectionName = collectionName;
}
@Override
public final Builder collectionName(String collectionName) {
this.collectionName = collectionName;
return this;
}
public final Instant getCreateTime() {
return createTime;
}
public final void setCreateTime(Instant createTime) {
this.createTime = createTime;
}
@Override
public final Builder createTime(Instant createTime) {
this.createTime = createTime;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final Integer getGeofenceCount() {
return geofenceCount;
}
public final void setGeofenceCount(Integer geofenceCount) {
this.geofenceCount = geofenceCount;
}
@Override
public final Builder geofenceCount(Integer geofenceCount) {
this.geofenceCount = geofenceCount;
return this;
}
public final String getKmsKeyId() {
return kmsKeyId;
}
public final void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
@Override
public final Builder kmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
return this;
}
@Deprecated
public final String getPricingPlan() {
return pricingPlan;
}
@Deprecated
public final void setPricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
}
@Override
@Deprecated
public final Builder pricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
return this;
}
@Override
@Deprecated
public final Builder pricingPlan(PricingPlan pricingPlan) {
this.pricingPlan(pricingPlan == null ? null : pricingPlan.toString());
return this;
}
@Deprecated
public final String getPricingPlanDataSource() {
return pricingPlanDataSource;
}
@Deprecated
public final void setPricingPlanDataSource(String pricingPlanDataSource) {
this.pricingPlanDataSource = pricingPlanDataSource;
}
@Override
@Deprecated
public final Builder pricingPlanDataSource(String pricingPlanDataSource) {
this.pricingPlanDataSource = pricingPlanDataSource;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
public final Instant getUpdateTime() {
return updateTime;
}
public final void setUpdateTime(Instant updateTime) {
this.updateTime = updateTime;
}
@Override
public final Builder updateTime(Instant updateTime) {
this.updateTime = updateTime;
return this;
}
@Override
public DescribeGeofenceCollectionResponse build() {
return new DescribeGeofenceCollectionResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy