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 reverse geocoding request sent 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 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,
MAX_RESULTS_FIELD, POSITION_FIELD));
private static final long serialVersionUID = 1L;
private final String dataSource;
private final Integer maxResults;
private final List position;
private SearchPlaceIndexForPositionSummary(BuilderImpl builder) {
this.dataSource = builder.dataSource;
this.maxResults = builder.maxResults;
this.position = builder.position;
}
/**
*
* The data provider of geospatial data for the Place index resource.
*
*
* @return The data provider of geospatial data for the Place index resource.
*/
public final String dataSource() {
return dataSource;
}
/**
*
* An optional parameter. The maximum number of results returned per request.
*
*
* Default value: 50
*
*
* @return An optional parameter. The maximum number of results returned per request.
*
* Default value: 50
*/
public final Integer maxResults() {
return maxResults;
}
/**
* Returns true if the Position property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasPosition() {
return position != null && !(position instanceof SdkAutoConstructList);
}
/**
*
* The position given in the reverse geocoding request.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasPosition()} to see if a value was sent in this field.
*
*
* @return The position given in the reverse geocoding 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(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(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("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 "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 data provider of geospatial data for the Place index resource.
*
*
* @param dataSource
* The data provider of geospatial data for the Place index resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataSource(String dataSource);
/**
*
* An optional parameter. The maximum number of results returned per request.
*
*
* Default value: 50
*
*
* @param maxResults
* An optional parameter. The maximum number of results returned per 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 given in the reverse geocoding request.
*
*
* @param position
* The position given in the reverse geocoding request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder position(Collection position);
/**
*
* The position given in the reverse geocoding request.
*
*
* @param position
* The position given in the reverse geocoding 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 Integer maxResults;
private List position = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SearchPlaceIndexForPositionSummary model) {
dataSource(model.dataSource);
maxResults(model.maxResults);
position(model.position);
}
public final String getDataSource() {
return dataSource;
}
@Override
public final Builder dataSource(String dataSource) {
this.dataSource = dataSource;
return this;
}
public final void setDataSource(String dataSource) {
this.dataSource = dataSource;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
public final Collection getPosition() {
if (position instanceof SdkAutoConstructList) {
return null;
}
return 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;
}
public final void setPosition(Collection position) {
this.position = PositionCopier.copy(position);
}
@Override
public SearchPlaceIndexForPositionSummary build() {
return new SearchPlaceIndexForPositionSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy