software.amazon.awssdk.services.location.model.ListDevicePositionsRequest 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.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 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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListDevicePositionsRequest extends LocationRequest implements
ToCopyableBuilder {
private static final SdkField FILTER_GEOMETRY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("FilterGeometry")
.getter(getter(ListDevicePositionsRequest::filterGeometry)).setter(setter(Builder::filterGeometry))
.constructor(TrackingFilterGeometry::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FilterGeometry").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListDevicePositionsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListDevicePositionsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField TRACKER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TrackerName").getter(getter(ListDevicePositionsRequest::trackerName))
.setter(setter(Builder::trackerName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("TrackerName").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FILTER_GEOMETRY_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, TRACKER_NAME_FIELD));
private final TrackingFilterGeometry filterGeometry;
private final Integer maxResults;
private final String nextToken;
private final String trackerName;
private ListDevicePositionsRequest(BuilderImpl builder) {
super(builder);
this.filterGeometry = builder.filterGeometry;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.trackerName = builder.trackerName;
}
/**
*
* The geomerty used to filter device positions.
*
*
* @return The geomerty used to filter device positions.
*/
public final TrackingFilterGeometry filterGeometry() {
return filterGeometry;
}
/**
*
* An optional limit for the number of entries returned in a single call.
*
*
* Default value: 100
*
*
* @return An optional limit for the number of entries returned in a single call.
*
* Default value: 100
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* The pagination token specifying which page of results to return in the response. If no token is provided, the
* default page is the first page.
*
*
* Default value: null
*
*
* @return The pagination token specifying which page of results to return in the response. If no token is provided,
* the default page is the first page.
*
* Default value: null
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The tracker resource containing the requested devices.
*
*
* @return The tracker resource containing the requested devices.
*/
public final String trackerName() {
return trackerName;
}
@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(filterGeometry());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(trackerName());
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 ListDevicePositionsRequest)) {
return false;
}
ListDevicePositionsRequest other = (ListDevicePositionsRequest) obj;
return Objects.equals(filterGeometry(), other.filterGeometry()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(trackerName(), other.trackerName());
}
/**
* 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("ListDevicePositionsRequest").add("FilterGeometry", filterGeometry())
.add("MaxResults", maxResults()).add("NextToken", nextToken()).add("TrackerName", trackerName()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "FilterGeometry":
return Optional.ofNullable(clazz.cast(filterGeometry()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "TrackerName":
return Optional.ofNullable(clazz.cast(trackerName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListDevicePositionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The geomerty used to filter device positions.
*
*
* @param filterGeometry
* The geomerty used to filter device positions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filterGeometry(TrackingFilterGeometry filterGeometry);
/**
*
* The geomerty used to filter device positions.
*
* This is a convenience method that creates an instance of the {@link TrackingFilterGeometry.Builder} avoiding
* the need to create one manually via {@link TrackingFilterGeometry#builder()}.
*
*
* When the {@link Consumer} completes, {@link TrackingFilterGeometry.Builder#build()} is called immediately and
* its result is passed to {@link #filterGeometry(TrackingFilterGeometry)}.
*
* @param filterGeometry
* a consumer that will call methods on {@link TrackingFilterGeometry.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filterGeometry(TrackingFilterGeometry)
*/
default Builder filterGeometry(Consumer filterGeometry) {
return filterGeometry(TrackingFilterGeometry.builder().applyMutation(filterGeometry).build());
}
/**
*
* An optional limit for the number of entries returned in a single call.
*
*
* Default value: 100
*
*
* @param maxResults
* An optional limit for the number of entries returned in a single call.
*
* Default value: 100
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* The pagination token specifying which page of results to return in the response. If no token is provided, the
* default page is the first page.
*
*
* Default value: null
*
*
* @param nextToken
* The pagination token specifying which page of results to return in the response. If no token is
* provided, the default page is the first page.
*
* Default value: null
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The tracker resource containing the requested devices.
*
*
* @param trackerName
* The tracker resource containing the requested devices.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trackerName(String trackerName);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends LocationRequest.BuilderImpl implements Builder {
private TrackingFilterGeometry filterGeometry;
private Integer maxResults;
private String nextToken;
private String trackerName;
private BuilderImpl() {
}
private BuilderImpl(ListDevicePositionsRequest model) {
super(model);
filterGeometry(model.filterGeometry);
maxResults(model.maxResults);
nextToken(model.nextToken);
trackerName(model.trackerName);
}
public final TrackingFilterGeometry.Builder getFilterGeometry() {
return filterGeometry != null ? filterGeometry.toBuilder() : null;
}
public final void setFilterGeometry(TrackingFilterGeometry.BuilderImpl filterGeometry) {
this.filterGeometry = filterGeometry != null ? filterGeometry.build() : null;
}
@Override
public final Builder filterGeometry(TrackingFilterGeometry filterGeometry) {
this.filterGeometry = filterGeometry;
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 String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final String getTrackerName() {
return trackerName;
}
public final void setTrackerName(String trackerName) {
this.trackerName = trackerName;
}
@Override
public final Builder trackerName(String trackerName) {
this.trackerName = trackerName;
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 ListDevicePositionsRequest build() {
return new ListDevicePositionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}