software.amazon.awssdk.services.location.model.SearchPlaceIndexForPositionResponse 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.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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class SearchPlaceIndexForPositionResponse extends LocationResponse implements
ToCopyableBuilder {
private static final SdkField SUMMARY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Summary")
.getter(getter(SearchPlaceIndexForPositionResponse::summary)).setter(setter(Builder::summary))
.constructor(SearchPlaceIndexForPositionSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Summary").build()).build();
private static final SdkField> RESULTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Results")
.getter(getter(SearchPlaceIndexForPositionResponse::results))
.setter(setter(Builder::results))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Results").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SearchForPositionResult::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SUMMARY_FIELD, RESULTS_FIELD));
private final SearchPlaceIndexForPositionSummary summary;
private final List results;
private SearchPlaceIndexForPositionResponse(BuilderImpl builder) {
super(builder);
this.summary = builder.summary;
this.results = builder.results;
}
/**
*
* Contains a summary of the request. Echoes the input values for Position, Language,
* MaxResults, and the DataSource of the place index.
*
*
* @return Contains a summary of the request. Echoes the input values for Position,
* Language, MaxResults, and the DataSource of the place index.
*/
public final SearchPlaceIndexForPositionSummary summary() {
return summary;
}
/**
* For responses, this returns true if the service returned a value for the Results 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 hasResults() {
return results != null && !(results instanceof SdkAutoConstructList);
}
/**
*
* Returns a list of Places closest to the specified position. Each result contains additional information about the
* Places returned.
*
*
* 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 #hasResults} method.
*
*
* @return Returns a list of Places closest to the specified position. Each result contains additional information
* about the Places returned.
*/
public final List results() {
return results;
}
@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(summary());
hashCode = 31 * hashCode + Objects.hashCode(hasResults() ? results() : 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 SearchPlaceIndexForPositionResponse)) {
return false;
}
SearchPlaceIndexForPositionResponse other = (SearchPlaceIndexForPositionResponse) obj;
return Objects.equals(summary(), other.summary()) && hasResults() == other.hasResults()
&& Objects.equals(results(), other.results());
}
/**
* 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("SearchPlaceIndexForPositionResponse").add("Summary", summary())
.add("Results", hasResults() ? results() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Summary":
return Optional.ofNullable(clazz.cast(summary()));
case "Results":
return Optional.ofNullable(clazz.cast(results()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchPlaceIndexForPositionResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LocationResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Contains a summary of the request. Echoes the input values for Position, Language,
* MaxResults, and the DataSource of the place index.
*
*
* @param summary
* Contains a summary of the request. Echoes the input values for Position,
* Language, MaxResults, and the DataSource of the place index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder summary(SearchPlaceIndexForPositionSummary summary);
/**
*
* Contains a summary of the request. Echoes the input values for Position, Language,
* MaxResults, and the DataSource of the place index.
*
* This is a convenience method that creates an instance of the
* {@link SearchPlaceIndexForPositionSummary.Builder} avoiding the need to create one manually via
* {@link SearchPlaceIndexForPositionSummary#builder()}.
*
*
* When the {@link Consumer} completes, {@link SearchPlaceIndexForPositionSummary.Builder#build()} is called
* immediately and its result is passed to {@link #summary(SearchPlaceIndexForPositionSummary)}.
*
* @param summary
* a consumer that will call methods on {@link SearchPlaceIndexForPositionSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #summary(SearchPlaceIndexForPositionSummary)
*/
default Builder summary(Consumer summary) {
return summary(SearchPlaceIndexForPositionSummary.builder().applyMutation(summary).build());
}
/**
*
* Returns a list of Places closest to the specified position. Each result contains additional information about
* the Places returned.
*
*
* @param results
* Returns a list of Places closest to the specified position. Each result contains additional
* information about the Places returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder results(Collection results);
/**
*
* Returns a list of Places closest to the specified position. Each result contains additional information about
* the Places returned.
*
*
* @param results
* Returns a list of Places closest to the specified position. Each result contains additional
* information about the Places returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder results(SearchForPositionResult... results);
/**
*
* Returns a list of Places closest to the specified position. Each result contains additional information about
* the Places returned.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.location.model.SearchForPositionResult.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.location.model.SearchForPositionResult#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.location.model.SearchForPositionResult.Builder#build()} is called
* immediately and its result is passed to {@link #results(List)}.
*
* @param results
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.location.model.SearchForPositionResult.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #results(java.util.Collection)
*/
Builder results(Consumer... results);
}
static final class BuilderImpl extends LocationResponse.BuilderImpl implements Builder {
private SearchPlaceIndexForPositionSummary summary;
private List results = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SearchPlaceIndexForPositionResponse model) {
super(model);
summary(model.summary);
results(model.results);
}
public final SearchPlaceIndexForPositionSummary.Builder getSummary() {
return summary != null ? summary.toBuilder() : null;
}
public final void setSummary(SearchPlaceIndexForPositionSummary.BuilderImpl summary) {
this.summary = summary != null ? summary.build() : null;
}
@Override
public final Builder summary(SearchPlaceIndexForPositionSummary summary) {
this.summary = summary;
return this;
}
public final List getResults() {
List result = SearchForPositionResultListCopier.copyToBuilder(this.results);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setResults(Collection results) {
this.results = SearchForPositionResultListCopier.copyFromBuilder(results);
}
@Override
public final Builder results(Collection results) {
this.results = SearchForPositionResultListCopier.copy(results);
return this;
}
@Override
@SafeVarargs
public final Builder results(SearchForPositionResult... results) {
results(Arrays.asList(results));
return this;
}
@Override
@SafeVarargs
public final Builder results(Consumer... results) {
results(Stream.of(results).map(c -> SearchForPositionResult.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public SearchPlaceIndexForPositionResponse build() {
return new SearchPlaceIndexForPositionResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}