software.amazon.awssdk.services.location.model.CreatePlaceIndexRequest Maven / Gradle / Ivy
/*
* 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.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 CreatePlaceIndexRequest extends LocationRequest implements
ToCopyableBuilder {
private static final SdkField DATA_SOURCE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DataSource").getter(getter(CreatePlaceIndexRequest::dataSource)).setter(setter(Builder::dataSource))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataSource").build()).build();
private static final SdkField DATA_SOURCE_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DataSourceConfiguration")
.getter(getter(CreatePlaceIndexRequest::dataSourceConfiguration)).setter(setter(Builder::dataSourceConfiguration))
.constructor(DataSourceConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataSourceConfiguration").build())
.build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreatePlaceIndexRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField INDEX_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IndexName").getter(getter(CreatePlaceIndexRequest::indexName)).setter(setter(Builder::indexName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndexName").build()).build();
private static final SdkField PRICING_PLAN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PricingPlan").getter(getter(CreatePlaceIndexRequest::pricingPlanAsString))
.setter(setter(Builder::pricingPlan))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PricingPlan").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreatePlaceIndexRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DATA_SOURCE_FIELD,
DATA_SOURCE_CONFIGURATION_FIELD, DESCRIPTION_FIELD, INDEX_NAME_FIELD, PRICING_PLAN_FIELD, TAGS_FIELD));
private final String dataSource;
private final DataSourceConfiguration dataSourceConfiguration;
private final String description;
private final String indexName;
private final String pricingPlan;
private final Map tags;
private CreatePlaceIndexRequest(BuilderImpl builder) {
super(builder);
this.dataSource = builder.dataSource;
this.dataSourceConfiguration = builder.dataSourceConfiguration;
this.description = builder.description;
this.indexName = builder.indexName;
this.pricingPlan = builder.pricingPlan;
this.tags = builder.tags;
}
/**
*
* Specifies the geospatial data provider for the new place index.
*
*
*
* This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an
* error.
*
*
*
* Valid values include:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your region of
* interest, see Esri
* details on geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional information about
* GrabMaps' coverage, see GrabMaps countries
* and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies' coverage in
* your region of interest, see HERE details on
* goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store
* results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
*
*
*
*
* For additional information , see Data providers
* on the Amazon Location Service Developer Guide.
*
*
* @return Specifies the geospatial data provider for the new place index.
*
* This field is case-sensitive. Enter the valid values as shown. For example, entering HERE
* returns an error.
*
*
*
* Valid values include:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your
* region of interest, see Esri details on
* geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional
* information about GrabMaps' coverage, see
* GrabMaps
* countries and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies'
* coverage in your region of interest, see HERE
* details on goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location
* Service.
*
*
*
*
* For additional information , see Data
* providers on the Amazon Location Service Developer Guide.
*/
public final String dataSource() {
return dataSource;
}
/**
*
* Specifies the data storage option requesting Places.
*
*
* @return Specifies the data storage option requesting Places.
*/
public final DataSourceConfiguration dataSourceConfiguration() {
return dataSourceConfiguration;
}
/**
*
* The optional description for the place index resource.
*
*
* @return The optional description for the place index resource.
*/
public final String description() {
return description;
}
/**
*
* The name of the place index resource.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*
*
* @return The name of the place index resource.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*/
public final String indexName() {
return indexName;
}
/**
*
* 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;
}
/**
* 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 place index resource. A tag is a key-value pair that helps you manage, identify,
* search, and filter your resources.
*
*
* Format: "key" : "value"
*
*
* Restrictions:
*
*
* -
*
* Maximum 50 tags per resource.
*
*
* -
*
* Each tag key must be unique and must have exactly one associated 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 place index resource. A tag is a key-value pair that helps you manage,
* identify, search, and filter your resources.
*
* Format: "key" : "value"
*
*
* Restrictions:
*
*
* -
*
* Maximum 50 tags per resource.
*
*
* -
*
* Each tag key must be unique and must have exactly one associated 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;
}
@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(dataSource());
hashCode = 31 * hashCode + Objects.hashCode(dataSourceConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(indexName());
hashCode = 31 * hashCode + Objects.hashCode(pricingPlanAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreatePlaceIndexRequest)) {
return false;
}
CreatePlaceIndexRequest other = (CreatePlaceIndexRequest) obj;
return Objects.equals(dataSource(), other.dataSource())
&& Objects.equals(dataSourceConfiguration(), other.dataSourceConfiguration())
&& Objects.equals(description(), other.description()) && Objects.equals(indexName(), other.indexName())
&& Objects.equals(pricingPlanAsString(), other.pricingPlanAsString()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreatePlaceIndexRequest").add("DataSource", dataSource())
.add("DataSourceConfiguration", dataSourceConfiguration()).add("Description", description())
.add("IndexName", indexName()).add("PricingPlan", pricingPlanAsString()).add("Tags", hasTags() ? tags() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DataSource":
return Optional.ofNullable(clazz.cast(dataSource()));
case "DataSourceConfiguration":
return Optional.ofNullable(clazz.cast(dataSourceConfiguration()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "IndexName":
return Optional.ofNullable(clazz.cast(indexName()));
case "PricingPlan":
return Optional.ofNullable(clazz.cast(pricingPlanAsString()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreatePlaceIndexRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Specifies the geospatial data provider for the new place index.
*
*
*
* This field is case-sensitive. Enter the valid values as shown. For example, entering HERE
* returns an error.
*
*
*
* Valid values include:
*
*
* -
*
* Esri – For additional information about Esri's coverage in your
* region of interest, see Esri details on
* geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional information
* about GrabMaps' coverage,
* see GrabMaps
* countries and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies' coverage
* in your region of interest, see HERE details
* on goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store
* results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location
* Service.
*
*
*
*
* For additional information , see Data
* providers on the Amazon Location Service Developer Guide.
*
*
* @param dataSource
* Specifies the geospatial data provider for the new place index.
*
* This field is case-sensitive. Enter the valid values as shown. For example, entering HERE
* returns an error.
*
*
*
* Valid values include:
*
*
* -
*
* Esri – For additional information about Esri's coverage in
* your region of interest, see Esri details on
* geocoding coverage.
*
*
* -
*
* Grab – Grab provides place index functionality for Southeast Asia. For additional
* information about GrabMaps' coverage,
* see
* GrabMaps countries and areas covered.
*
*
* -
*
* Here – For additional information about HERE Technologies'
* coverage in your region of interest, see HERE
* details on goecoding coverage.
*
*
*
* If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location
* Service.
*
*
*
*
* For additional information , see Data
* providers on the Amazon Location Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataSource(String dataSource);
/**
*
* Specifies the data storage option requesting Places.
*
*
* @param dataSourceConfiguration
* Specifies the data storage option requesting Places.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration);
/**
*
* Specifies the data storage option requesting Places.
*
* This is a convenience method that creates an instance of the {@link DataSourceConfiguration.Builder} avoiding
* the need to create one manually via {@link DataSourceConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link DataSourceConfiguration.Builder#build()} is called immediately
* and its result is passed to {@link #dataSourceConfiguration(DataSourceConfiguration)}.
*
* @param dataSourceConfiguration
* a consumer that will call methods on {@link DataSourceConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dataSourceConfiguration(DataSourceConfiguration)
*/
default Builder dataSourceConfiguration(Consumer dataSourceConfiguration) {
return dataSourceConfiguration(DataSourceConfiguration.builder().applyMutation(dataSourceConfiguration).build());
}
/**
*
* The optional description for the place index resource.
*
*
* @param description
* The optional description for the place index resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The name of the place index resource.
*
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
*
*
* @param indexName
* The name of the place index resource.
*
* Requirements:
*
*
* -
*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
*
*
* -
*
* Must be a unique place index resource name.
*
*
* -
*
* No spaces allowed. For example, ExamplePlaceIndex.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder indexName(String indexName);
/**
*
* 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);
/**
*
* Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage,
* identify, search, and filter your resources.
*
*
* Format: "key" : "value"
*
*
* Restrictions:
*
*
* -
*
* Maximum 50 tags per resource.
*
*
* -
*
* Each tag key must be unique and must have exactly one associated 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 place index resource. A tag is a key-value pair that helps you manage,
* identify, search, and filter your resources.
*
* Format: "key" : "value"
*
*
* Restrictions:
*
*
* -
*
* Maximum 50 tags per resource.
*
*
* -
*
* Each tag key must be unique and must have exactly one associated 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);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends LocationRequest.BuilderImpl implements Builder {
private String dataSource;
private DataSourceConfiguration dataSourceConfiguration;
private String description;
private String indexName;
private String pricingPlan;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreatePlaceIndexRequest model) {
super(model);
dataSource(model.dataSource);
dataSourceConfiguration(model.dataSourceConfiguration);
description(model.description);
indexName(model.indexName);
pricingPlan(model.pricingPlan);
tags(model.tags);
}
public final String getDataSource() {
return dataSource;
}
public final void setDataSource(String dataSource) {
this.dataSource = dataSource;
}
@Override
public final Builder dataSource(String dataSource) {
this.dataSource = dataSource;
return this;
}
public final DataSourceConfiguration.Builder getDataSourceConfiguration() {
return dataSourceConfiguration != null ? dataSourceConfiguration.toBuilder() : null;
}
public final void setDataSourceConfiguration(DataSourceConfiguration.BuilderImpl dataSourceConfiguration) {
this.dataSourceConfiguration = dataSourceConfiguration != null ? dataSourceConfiguration.build() : null;
}
@Override
public final Builder dataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration) {
this.dataSourceConfiguration = dataSourceConfiguration;
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 String getIndexName() {
return indexName;
}
public final void setIndexName(String indexName) {
this.indexName = indexName;
}
@Override
public final Builder indexName(String indexName) {
this.indexName = indexName;
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;
}
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreatePlaceIndexRequest build() {
return new CreatePlaceIndexRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}