software.amazon.awssdk.services.location.model.SearchPlaceIndexForPositionSummary 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.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A summary of the request sent by using SearchPlaceIndexForPosition.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SearchPlaceIndexForPositionSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DATA_SOURCE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DataSource").getter(getter(SearchPlaceIndexForPositionSummary::dataSource))
.setter(setter(Builder::dataSource))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataSource").build()).build();
private static final SdkField LANGUAGE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Language").getter(getter(SearchPlaceIndexForPositionSummary::language))
.setter(setter(Builder::language))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Language").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(SearchPlaceIndexForPositionSummary::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField> POSITION_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Position")
.getter(getter(SearchPlaceIndexForPositionSummary::position))
.setter(setter(Builder::position))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Position").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.DOUBLE)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DATA_SOURCE_FIELD,
LANGUAGE_FIELD, MAX_RESULTS_FIELD, POSITION_FIELD));
private static final long serialVersionUID = 1L;
private final String dataSource;
private final String language;
private final Integer maxResults;
private final List position;
private SearchPlaceIndexForPositionSummary(BuilderImpl builder) {
this.dataSource = builder.dataSource;
this.language = builder.language;
this.maxResults = builder.maxResults;
this.position = builder.position;
}
/**
*
* The geospatial data provider attached to the place index resource specified in the request. Values can be one of
* the following:
*
*
* -
*
* Esri
*
*
* -
*
* Here
*
*
*
*
* For more information about data providers, see Amazon Location
* Service data providers.
*
*
* @return The geospatial data provider attached to the place index resource specified in the request. Values can be
* one of the following:
*
* -
*
* Esri
*
*
* -
*
* Here
*
*
*
*
* For more information about data providers, see Amazon
* Location Service data providers.
*/
public final String dataSource() {
return dataSource;
}
/**
*
* The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
*
*
* @return The preferred language used to return results. Matches the language in the request. The value is a valid
* BCP 47 language tag, for example, en for
* English.
*/
public final String language() {
return language;
}
/**
*
* Contains the optional result count limit that is specified in the request.
*
*
* Default value: 50
*
*
* @return Contains the optional result count limit that is specified in the request.
*
* Default value: 50
*/
public final Integer maxResults() {
return maxResults;
}
/**
* For responses, this returns true if the service returned a value for the Position 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 hasPosition() {
return position != null && !(position instanceof SdkAutoConstructList);
}
/**
*
* The position specified in the request.
*
*
* 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 #hasPosition} method.
*
*
* @return The position specified in the request.
*/
public final List position() {
return position;
}
@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 + Objects.hashCode(dataSource());
hashCode = 31 * hashCode + Objects.hashCode(language());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(hasPosition() ? position() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SearchPlaceIndexForPositionSummary)) {
return false;
}
SearchPlaceIndexForPositionSummary other = (SearchPlaceIndexForPositionSummary) obj;
return Objects.equals(dataSource(), other.dataSource()) && Objects.equals(language(), other.language())
&& Objects.equals(maxResults(), other.maxResults()) && hasPosition() == other.hasPosition()
&& Objects.equals(position(), other.position());
}
/**
* 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("SearchPlaceIndexForPositionSummary").add("DataSource", dataSource()).add("Language", language())
.add("MaxResults", maxResults()).add("Position", position() == null ? null : "*** Sensitive Data Redacted ***")
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DataSource":
return Optional.ofNullable(clazz.cast(dataSource()));
case "Language":
return Optional.ofNullable(clazz.cast(language()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "Position":
return Optional.ofNullable(clazz.cast(position()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchPlaceIndexForPositionSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The geospatial data provider attached to the place index resource specified in the request. Values can be one
* of the following:
*
*
* -
*
* Esri
*
*
* -
*
* Here
*
*
*
*
* For more information about data providers, see Amazon Location
* Service data providers.
*
*
* @param dataSource
* The geospatial data provider attached to the place index resource specified in the request. Values can
* be one of the following:
*
* -
*
* Esri
*
*
* -
*
* Here
*
*
*
*
* For more information about data providers, see Amazon
* Location Service data providers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataSource(String dataSource);
/**
*
* The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
*
*
* @param language
* The preferred language used to return results. Matches the language in the request. The value is a
* valid BCP 47 language tag, for example,
* en for English.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder language(String language);
/**
*
* Contains the optional result count limit that is specified in the request.
*
*
* Default value: 50
*
*
* @param maxResults
* Contains the optional result count limit that is specified in the request.
*
* Default value: 50
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* The position specified in the request.
*
*
* @param position
* The position specified in the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder position(Collection position);
/**
*
* The position specified in the request.
*
*
* @param position
* The position specified in the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder position(Double... position);
}
static final class BuilderImpl implements Builder {
private String dataSource;
private String language;
private Integer maxResults;
private List position = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SearchPlaceIndexForPositionSummary model) {
dataSource(model.dataSource);
language(model.language);
maxResults(model.maxResults);
position(model.position);
}
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 String getLanguage() {
return language;
}
public final void setLanguage(String language) {
this.language = language;
}
@Override
public final Builder language(String language) {
this.language = language;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final Collection getPosition() {
if (position instanceof SdkAutoConstructList) {
return null;
}
return position;
}
public final void setPosition(Collection position) {
this.position = PositionCopier.copy(position);
}
@Override
public final Builder position(Collection position) {
this.position = PositionCopier.copy(position);
return this;
}
@Override
@SafeVarargs
public final Builder position(Double... position) {
position(Arrays.asList(position));
return this;
}
@Override
public SearchPlaceIndexForPositionSummary build() {
return new SearchPlaceIndexForPositionSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}