software.amazon.awssdk.services.iot.model.UpdateThingGroupsForThingRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of iot Show documentation
Show all versions of iot Show documentation
The AWS Java SDK for AWS Iot Service module holds the client classes that are used for communicating
with AWS IoT Service
The newest version!
/*
* 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.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.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 UpdateThingGroupsForThingRequest extends IotRequest implements
ToCopyableBuilder {
private static final SdkField THING_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("thingName").getter(getter(UpdateThingGroupsForThingRequest::thingName))
.setter(setter(Builder::thingName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("thingName").build()).build();
private static final SdkField> THING_GROUPS_TO_ADD_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("thingGroupsToAdd")
.getter(getter(UpdateThingGroupsForThingRequest::thingGroupsToAdd))
.setter(setter(Builder::thingGroupsToAdd))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("thingGroupsToAdd").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> THING_GROUPS_TO_REMOVE_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("thingGroupsToRemove")
.getter(getter(UpdateThingGroupsForThingRequest::thingGroupsToRemove))
.setter(setter(Builder::thingGroupsToRemove))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("thingGroupsToRemove").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField OVERRIDE_DYNAMIC_GROUPS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("overrideDynamicGroups").getter(getter(UpdateThingGroupsForThingRequest::overrideDynamicGroups))
.setter(setter(Builder::overrideDynamicGroups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("overrideDynamicGroups").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(THING_NAME_FIELD,
THING_GROUPS_TO_ADD_FIELD, THING_GROUPS_TO_REMOVE_FIELD, OVERRIDE_DYNAMIC_GROUPS_FIELD));
private final String thingName;
private final List thingGroupsToAdd;
private final List thingGroupsToRemove;
private final Boolean overrideDynamicGroups;
private UpdateThingGroupsForThingRequest(BuilderImpl builder) {
super(builder);
this.thingName = builder.thingName;
this.thingGroupsToAdd = builder.thingGroupsToAdd;
this.thingGroupsToRemove = builder.thingGroupsToRemove;
this.overrideDynamicGroups = builder.overrideDynamicGroups;
}
/**
*
* The thing whose group memberships will be updated.
*
*
* @return The thing whose group memberships will be updated.
*/
public final String thingName() {
return thingName;
}
/**
* For responses, this returns true if the service returned a value for the ThingGroupsToAdd 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 hasThingGroupsToAdd() {
return thingGroupsToAdd != null && !(thingGroupsToAdd instanceof SdkAutoConstructList);
}
/**
*
* The groups to which the thing will be added.
*
*
* 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 #hasThingGroupsToAdd} method.
*
*
* @return The groups to which the thing will be added.
*/
public final List thingGroupsToAdd() {
return thingGroupsToAdd;
}
/**
* For responses, this returns true if the service returned a value for the ThingGroupsToRemove 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 hasThingGroupsToRemove() {
return thingGroupsToRemove != null && !(thingGroupsToRemove instanceof SdkAutoConstructList);
}
/**
*
* The groups from which the thing will be removed.
*
*
* 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 #hasThingGroupsToRemove} method.
*
*
* @return The groups from which the thing will be removed.
*/
public final List thingGroupsToRemove() {
return thingGroupsToRemove;
}
/**
*
* Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10
* thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes
* the thing from the last dynamic group.
*
*
* @return Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs
* to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static
* group removes the thing from the last dynamic group.
*/
public final Boolean overrideDynamicGroups() {
return overrideDynamicGroups;
}
@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(thingName());
hashCode = 31 * hashCode + Objects.hashCode(hasThingGroupsToAdd() ? thingGroupsToAdd() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasThingGroupsToRemove() ? thingGroupsToRemove() : null);
hashCode = 31 * hashCode + Objects.hashCode(overrideDynamicGroups());
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 UpdateThingGroupsForThingRequest)) {
return false;
}
UpdateThingGroupsForThingRequest other = (UpdateThingGroupsForThingRequest) obj;
return Objects.equals(thingName(), other.thingName()) && hasThingGroupsToAdd() == other.hasThingGroupsToAdd()
&& Objects.equals(thingGroupsToAdd(), other.thingGroupsToAdd())
&& hasThingGroupsToRemove() == other.hasThingGroupsToRemove()
&& Objects.equals(thingGroupsToRemove(), other.thingGroupsToRemove())
&& Objects.equals(overrideDynamicGroups(), other.overrideDynamicGroups());
}
/**
* 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("UpdateThingGroupsForThingRequest").add("ThingName", thingName())
.add("ThingGroupsToAdd", hasThingGroupsToAdd() ? thingGroupsToAdd() : null)
.add("ThingGroupsToRemove", hasThingGroupsToRemove() ? thingGroupsToRemove() : null)
.add("OverrideDynamicGroups", overrideDynamicGroups()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "thingName":
return Optional.ofNullable(clazz.cast(thingName()));
case "thingGroupsToAdd":
return Optional.ofNullable(clazz.cast(thingGroupsToAdd()));
case "thingGroupsToRemove":
return Optional.ofNullable(clazz.cast(thingGroupsToRemove()));
case "overrideDynamicGroups":
return Optional.ofNullable(clazz.cast(overrideDynamicGroups()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateThingGroupsForThingRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The thing whose group memberships will be updated.
*
*
* @param thingName
* The thing whose group memberships will be updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder thingName(String thingName);
/**
*
* The groups to which the thing will be added.
*
*
* @param thingGroupsToAdd
* The groups to which the thing will be added.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder thingGroupsToAdd(Collection thingGroupsToAdd);
/**
*
* The groups to which the thing will be added.
*
*
* @param thingGroupsToAdd
* The groups to which the thing will be added.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder thingGroupsToAdd(String... thingGroupsToAdd);
/**
*
* The groups from which the thing will be removed.
*
*
* @param thingGroupsToRemove
* The groups from which the thing will be removed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder thingGroupsToRemove(Collection thingGroupsToRemove);
/**
*
* The groups from which the thing will be removed.
*
*
* @param thingGroupsToRemove
* The groups from which the thing will be removed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder thingGroupsToRemove(String... thingGroupsToRemove);
/**
*
* Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to
* 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group
* removes the thing from the last dynamic group.
*
*
* @param overrideDynamicGroups
* Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing
* belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing
* to a static group removes the thing from the last dynamic group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder overrideDynamicGroups(Boolean overrideDynamicGroups);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IotRequest.BuilderImpl implements Builder {
private String thingName;
private List thingGroupsToAdd = DefaultSdkAutoConstructList.getInstance();
private List thingGroupsToRemove = DefaultSdkAutoConstructList.getInstance();
private Boolean overrideDynamicGroups;
private BuilderImpl() {
}
private BuilderImpl(UpdateThingGroupsForThingRequest model) {
super(model);
thingName(model.thingName);
thingGroupsToAdd(model.thingGroupsToAdd);
thingGroupsToRemove(model.thingGroupsToRemove);
overrideDynamicGroups(model.overrideDynamicGroups);
}
public final String getThingName() {
return thingName;
}
public final void setThingName(String thingName) {
this.thingName = thingName;
}
@Override
public final Builder thingName(String thingName) {
this.thingName = thingName;
return this;
}
public final Collection getThingGroupsToAdd() {
if (thingGroupsToAdd instanceof SdkAutoConstructList) {
return null;
}
return thingGroupsToAdd;
}
public final void setThingGroupsToAdd(Collection thingGroupsToAdd) {
this.thingGroupsToAdd = ThingGroupListCopier.copy(thingGroupsToAdd);
}
@Override
public final Builder thingGroupsToAdd(Collection thingGroupsToAdd) {
this.thingGroupsToAdd = ThingGroupListCopier.copy(thingGroupsToAdd);
return this;
}
@Override
@SafeVarargs
public final Builder thingGroupsToAdd(String... thingGroupsToAdd) {
thingGroupsToAdd(Arrays.asList(thingGroupsToAdd));
return this;
}
public final Collection getThingGroupsToRemove() {
if (thingGroupsToRemove instanceof SdkAutoConstructList) {
return null;
}
return thingGroupsToRemove;
}
public final void setThingGroupsToRemove(Collection thingGroupsToRemove) {
this.thingGroupsToRemove = ThingGroupListCopier.copy(thingGroupsToRemove);
}
@Override
public final Builder thingGroupsToRemove(Collection thingGroupsToRemove) {
this.thingGroupsToRemove = ThingGroupListCopier.copy(thingGroupsToRemove);
return this;
}
@Override
@SafeVarargs
public final Builder thingGroupsToRemove(String... thingGroupsToRemove) {
thingGroupsToRemove(Arrays.asList(thingGroupsToRemove));
return this;
}
public final Boolean getOverrideDynamicGroups() {
return overrideDynamicGroups;
}
public final void setOverrideDynamicGroups(Boolean overrideDynamicGroups) {
this.overrideDynamicGroups = overrideDynamicGroups;
}
@Override
public final Builder overrideDynamicGroups(Boolean overrideDynamicGroups) {
this.overrideDynamicGroups = overrideDynamicGroups;
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 UpdateThingGroupsForThingRequest build() {
return new UpdateThingGroupsForThingRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}