software.amazon.awssdk.services.location.model.CreateGeofenceCollectionRequest Maven / Gradle / Ivy
Show all versions of location Show documentation
/*
* 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.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.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 CreateGeofenceCollectionRequest extends LocationRequest implements
ToCopyableBuilder {
private static final SdkField COLLECTION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CollectionName").getter(getter(CreateGeofenceCollectionRequest::collectionName))
.setter(setter(Builder::collectionName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CollectionName").build()).build();
private static final SdkField PRICING_PLAN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PricingPlan").getter(getter(CreateGeofenceCollectionRequest::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(CreateGeofenceCollectionRequest::pricingPlanDataSource))
.setter(setter(Builder::pricingPlanDataSource))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PricingPlanDataSource").build())
.build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateGeofenceCollectionRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateGeofenceCollectionRequest::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 KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KmsKeyId").getter(getter(CreateGeofenceCollectionRequest::kmsKeyId)).setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKeyId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COLLECTION_NAME_FIELD,
PRICING_PLAN_FIELD, PRICING_PLAN_DATA_SOURCE_FIELD, DESCRIPTION_FIELD, TAGS_FIELD, KMS_KEY_ID_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String collectionName;
private final String pricingPlan;
private final String pricingPlanDataSource;
private final String description;
private final Map tags;
private final String kmsKeyId;
private CreateGeofenceCollectionRequest(BuilderImpl builder) {
super(builder);
this.collectionName = builder.collectionName;
this.pricingPlan = builder.pricingPlan;
this.pricingPlanDataSource = builder.pricingPlanDataSource;
this.description = builder.description;
this.tags = builder.tags;
this.kmsKeyId = builder.kmsKeyId;
}
/**
*
* A custom name for the geofence collection.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*
*
* @return A custom name for the geofence collection.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*/
public final String collectionName() {
return collectionName;
}
/**
*
* 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, {@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. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
* @deprecated Deprecated. If included, the only allowed value is RequestBasedUsage.
*/
@Deprecated
public final PricingPlan pricingPlan() {
return PricingPlan.fromValue(pricingPlan);
}
/**
*
* 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, {@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. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
* @deprecated Deprecated. If included, the only allowed value is RequestBasedUsage.
*/
@Deprecated
public final String pricingPlanAsString() {
return pricingPlan;
}
/**
*
* This parameter is no longer used.
*
*
* @return This parameter is no longer used.
* @deprecated Deprecated. No longer allowed.
*/
@Deprecated
public final String pricingPlanDataSource() {
return pricingPlanDataSource;
}
/**
*
* An optional description for the geofence collection.
*
*
* @return An optional description for the geofence collection.
*/
public final String description() {
return description;
}
/**
* 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);
}
/**
*
* Applies one or more tags to the geofence collection. 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 {@link #hasTags} method.
*
*
* @return Applies one or more tags to the geofence collection. 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.
*
*
*/
public final Map tags() {
return tags;
}
/**
*
* A key identifier for an Amazon
* Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
*
*
* @return A key identifier for an Amazon Web Services KMS
* customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
*/
public final String kmsKeyId() {
return kmsKeyId;
}
@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(collectionName());
hashCode = 31 * hashCode + Objects.hashCode(pricingPlanAsString());
hashCode = 31 * hashCode + Objects.hashCode(pricingPlanDataSource());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
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 CreateGeofenceCollectionRequest)) {
return false;
}
CreateGeofenceCollectionRequest other = (CreateGeofenceCollectionRequest) obj;
return Objects.equals(collectionName(), other.collectionName())
&& Objects.equals(pricingPlanAsString(), other.pricingPlanAsString())
&& Objects.equals(pricingPlanDataSource(), other.pricingPlanDataSource())
&& Objects.equals(description(), other.description()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(kmsKeyId(), other.kmsKeyId());
}
/**
* 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("CreateGeofenceCollectionRequest").add("CollectionName", collectionName())
.add("PricingPlan", pricingPlanAsString()).add("PricingPlanDataSource", pricingPlanDataSource())
.add("Description", description()).add("Tags", hasTags() ? tags() : null).add("KmsKeyId", kmsKeyId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CollectionName":
return Optional.ofNullable(clazz.cast(collectionName()));
case "PricingPlan":
return Optional.ofNullable(clazz.cast(pricingPlanAsString()));
case "PricingPlanDataSource":
return Optional.ofNullable(clazz.cast(pricingPlanDataSource()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "KmsKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("CollectionName", COLLECTION_NAME_FIELD);
map.put("PricingPlan", PRICING_PLAN_FIELD);
map.put("PricingPlanDataSource", PRICING_PLAN_DATA_SOURCE_FIELD);
map.put("Description", DESCRIPTION_FIELD);
map.put("Tags", TAGS_FIELD);
map.put("KmsKeyId", KMS_KEY_ID_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((CreateGeofenceCollectionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A custom name for the geofence collection.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
*
*
* @param collectionName
* A custom name for the geofence collection.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique geofence collection name.
*
*
* -
*
* No spaces allowed. For example, ExampleGeofenceCollection.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder collectionName(String collectionName);
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
* @deprecated Deprecated. If included, the only allowed value is RequestBasedUsage.
*/
@Deprecated
Builder pricingPlan(String pricingPlan);
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage.
*
*
* @param pricingPlan
* No longer used. If included, the only allowed value is RequestBasedUsage.
* @see PricingPlan
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
* @deprecated Deprecated. If included, the only allowed value is RequestBasedUsage.
*/
@Deprecated
Builder pricingPlan(PricingPlan pricingPlan);
/**
*
* This parameter is no longer used.
*
*
* @param pricingPlanDataSource
* This parameter is no longer used.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated Deprecated. No longer allowed.
*/
@Deprecated
Builder pricingPlanDataSource(String pricingPlanDataSource);
/**
*
* An optional description for the geofence collection.
*
*
* @param description
* An 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);
/**
*
* Applies one or more tags to the geofence collection. 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.
*
*
*
*
* @param tags
* Applies one or more tags to the geofence collection. 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* A key identifier for an Amazon Web Services KMS
* customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
*
*
* @param kmsKeyId
* A key identifier for an Amazon Web Services KMS
* customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends LocationRequest.BuilderImpl implements Builder {
private String collectionName;
private String pricingPlan;
private String pricingPlanDataSource;
private String description;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String kmsKeyId;
private BuilderImpl() {
}
private BuilderImpl(CreateGeofenceCollectionRequest model) {
super(model);
collectionName(model.collectionName);
pricingPlan(model.pricingPlan);
pricingPlanDataSource(model.pricingPlanDataSource);
description(model.description);
tags(model.tags);
kmsKeyId(model.kmsKeyId);
}
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;
}
@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 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 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 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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateGeofenceCollectionRequest build() {
return new CreateGeofenceCollectionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}