software.amazon.awssdk.services.iot.model.SearchIndexResponse Maven / Gradle / Ivy
Show all versions of iot 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.iot.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
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 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 SearchIndexResponse extends IotResponse implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(SearchIndexResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextToken").build()).build();
private static final SdkField> THINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("things")
.getter(getter(SearchIndexResponse::things))
.setter(setter(Builder::things))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("things").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ThingDocument::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> THING_GROUPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("thingGroups")
.getter(getter(SearchIndexResponse::thingGroups))
.setter(setter(Builder::thingGroups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("thingGroups").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ThingGroupDocument::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
THINGS_FIELD, THING_GROUPS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String nextToken;
private final List things;
private final List thingGroups;
private SearchIndexResponse(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.things = builder.things;
this.thingGroups = builder.thingGroups;
}
/**
*
* The token used to get the next set of results, or null if there are no additional results.
*
*
* @return The token used to get the next set of results, or null if there are no additional results.
*/
public final String nextToken() {
return nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Things 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 hasThings() {
return things != null && !(things instanceof SdkAutoConstructList);
}
/**
*
* The things that match the search query.
*
*
* 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 #hasThings} method.
*
*
* @return The things that match the search query.
*/
public final List things() {
return things;
}
/**
* For responses, this returns true if the service returned a value for the ThingGroups 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 hasThingGroups() {
return thingGroups != null && !(thingGroups instanceof SdkAutoConstructList);
}
/**
*
* The thing groups that match the search query.
*
*
* 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 #hasThingGroups} method.
*
*
* @return The thing groups that match the search query.
*/
public final List thingGroups() {
return thingGroups;
}
@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(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasThings() ? things() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasThingGroups() ? thingGroups() : 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 SearchIndexResponse)) {
return false;
}
SearchIndexResponse other = (SearchIndexResponse) obj;
return Objects.equals(nextToken(), other.nextToken()) && hasThings() == other.hasThings()
&& Objects.equals(things(), other.things()) && hasThingGroups() == other.hasThingGroups()
&& Objects.equals(thingGroups(), other.thingGroups());
}
/**
* 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("SearchIndexResponse").add("NextToken", nextToken()).add("Things", hasThings() ? things() : null)
.add("ThingGroups", hasThingGroups() ? thingGroups() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "things":
return Optional.ofNullable(clazz.cast(things()));
case "thingGroups":
return Optional.ofNullable(clazz.cast(thingGroups()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("nextToken", NEXT_TOKEN_FIELD);
map.put("things", THINGS_FIELD);
map.put("thingGroups", THING_GROUPS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((SearchIndexResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IotResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The token used to get the next set of results, or null if there are no additional results.
*
*
* @param nextToken
* The token used to get the next set of results, or null if there are no additional
* results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The things that match the search query.
*
*
* @param things
* The things that match the search query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder things(Collection things);
/**
*
* The things that match the search query.
*
*
* @param things
* The things that match the search query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder things(ThingDocument... things);
/**
*
* The things that match the search query.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iot.model.ThingDocument.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.iot.model.ThingDocument#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.iot.model.ThingDocument.Builder#build()} is called immediately and its
* result is passed to {@link #things(List)}.
*
* @param things
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.iot.model.ThingDocument.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #things(java.util.Collection)
*/
Builder things(Consumer... things);
/**
*
* The thing groups that match the search query.
*
*
* @param thingGroups
* The thing groups that match the search query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder thingGroups(Collection thingGroups);
/**
*
* The thing groups that match the search query.
*
*
* @param thingGroups
* The thing groups that match the search query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder thingGroups(ThingGroupDocument... thingGroups);
/**
*
* The thing groups that match the search query.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iot.model.ThingGroupDocument.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.iot.model.ThingGroupDocument#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.iot.model.ThingGroupDocument.Builder#build()} is called immediately
* and its result is passed to {@link #thingGroups(List)}.
*
* @param thingGroups
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.iot.model.ThingGroupDocument.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #thingGroups(java.util.Collection)
*/
Builder thingGroups(Consumer... thingGroups);
}
static final class BuilderImpl extends IotResponse.BuilderImpl implements Builder {
private String nextToken;
private List things = DefaultSdkAutoConstructList.getInstance();
private List thingGroups = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SearchIndexResponse model) {
super(model);
nextToken(model.nextToken);
things(model.things);
thingGroups(model.thingGroups);
}
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 List getThings() {
List result = ThingDocumentListCopier.copyToBuilder(this.things);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setThings(Collection things) {
this.things = ThingDocumentListCopier.copyFromBuilder(things);
}
@Override
public final Builder things(Collection things) {
this.things = ThingDocumentListCopier.copy(things);
return this;
}
@Override
@SafeVarargs
public final Builder things(ThingDocument... things) {
things(Arrays.asList(things));
return this;
}
@Override
@SafeVarargs
public final Builder things(Consumer... things) {
things(Stream.of(things).map(c -> ThingDocument.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getThingGroups() {
List result = ThingGroupDocumentListCopier.copyToBuilder(this.thingGroups);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setThingGroups(Collection thingGroups) {
this.thingGroups = ThingGroupDocumentListCopier.copyFromBuilder(thingGroups);
}
@Override
public final Builder thingGroups(Collection thingGroups) {
this.thingGroups = ThingGroupDocumentListCopier.copy(thingGroups);
return this;
}
@Override
@SafeVarargs
public final Builder thingGroups(ThingGroupDocument... thingGroups) {
thingGroups(Arrays.asList(thingGroups));
return this;
}
@Override
@SafeVarargs
public final Builder thingGroups(Consumer... thingGroups) {
thingGroups(Stream.of(thingGroups).map(c -> ThingGroupDocument.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public SearchIndexResponse build() {
return new SearchIndexResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}