software.amazon.awssdk.services.alexaforbusiness.model.DeviceStatusInfo Maven / Gradle / Ivy
Show all versions of alexaforbusiness 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.alexaforbusiness.model;
import java.io.Serializable;
import java.time.Instant;
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;
/**
*
* Detailed information about a device's status.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeviceStatusInfo implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> DEVICE_STATUS_DETAILS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DeviceStatusDetails")
.getter(getter(DeviceStatusInfo::deviceStatusDetails))
.setter(setter(Builder::deviceStatusDetails))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceStatusDetails").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DeviceStatusDetail::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CONNECTION_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConnectionStatus").getter(getter(DeviceStatusInfo::connectionStatusAsString))
.setter(setter(Builder::connectionStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConnectionStatus").build()).build();
private static final SdkField CONNECTION_STATUS_UPDATED_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("ConnectionStatusUpdatedTime")
.getter(getter(DeviceStatusInfo::connectionStatusUpdatedTime))
.setter(setter(Builder::connectionStatusUpdatedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConnectionStatusUpdatedTime")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DEVICE_STATUS_DETAILS_FIELD,
CONNECTION_STATUS_FIELD, CONNECTION_STATUS_UPDATED_TIME_FIELD));
private static final long serialVersionUID = 1L;
private final List deviceStatusDetails;
private final String connectionStatus;
private final Instant connectionStatusUpdatedTime;
private DeviceStatusInfo(BuilderImpl builder) {
this.deviceStatusDetails = builder.deviceStatusDetails;
this.connectionStatus = builder.connectionStatus;
this.connectionStatusUpdatedTime = builder.connectionStatusUpdatedTime;
}
/**
* For responses, this returns true if the service returned a value for the DeviceStatusDetails 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 hasDeviceStatusDetails() {
return deviceStatusDetails != null && !(deviceStatusDetails instanceof SdkAutoConstructList);
}
/**
*
* One or more device status detail descriptions.
*
*
* 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 #hasDeviceStatusDetails} method.
*
*
* @return One or more device status detail descriptions.
*/
public final List deviceStatusDetails() {
return deviceStatusDetails;
}
/**
*
* The latest available information about the connection status of a device.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #connectionStatus}
* will return {@link ConnectionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #connectionStatusAsString}.
*
*
* @return The latest available information about the connection status of a device.
* @see ConnectionStatus
*/
public final ConnectionStatus connectionStatus() {
return ConnectionStatus.fromValue(connectionStatus);
}
/**
*
* The latest available information about the connection status of a device.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #connectionStatus}
* will return {@link ConnectionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #connectionStatusAsString}.
*
*
* @return The latest available information about the connection status of a device.
* @see ConnectionStatus
*/
public final String connectionStatusAsString() {
return connectionStatus;
}
/**
*
* The time (in epoch) when the device connection status changed.
*
*
* @return The time (in epoch) when the device connection status changed.
*/
public final Instant connectionStatusUpdatedTime() {
return connectionStatusUpdatedTime;
}
@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(hasDeviceStatusDetails() ? deviceStatusDetails() : null);
hashCode = 31 * hashCode + Objects.hashCode(connectionStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(connectionStatusUpdatedTime());
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 DeviceStatusInfo)) {
return false;
}
DeviceStatusInfo other = (DeviceStatusInfo) obj;
return hasDeviceStatusDetails() == other.hasDeviceStatusDetails()
&& Objects.equals(deviceStatusDetails(), other.deviceStatusDetails())
&& Objects.equals(connectionStatusAsString(), other.connectionStatusAsString())
&& Objects.equals(connectionStatusUpdatedTime(), other.connectionStatusUpdatedTime());
}
/**
* 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("DeviceStatusInfo")
.add("DeviceStatusDetails", hasDeviceStatusDetails() ? deviceStatusDetails() : null)
.add("ConnectionStatus", connectionStatusAsString())
.add("ConnectionStatusUpdatedTime", connectionStatusUpdatedTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DeviceStatusDetails":
return Optional.ofNullable(clazz.cast(deviceStatusDetails()));
case "ConnectionStatus":
return Optional.ofNullable(clazz.cast(connectionStatusAsString()));
case "ConnectionStatusUpdatedTime":
return Optional.ofNullable(clazz.cast(connectionStatusUpdatedTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeviceStatusInfo) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* One or more device status detail descriptions.
*
*
* @param deviceStatusDetails
* One or more device status detail descriptions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceStatusDetails(Collection deviceStatusDetails);
/**
*
* One or more device status detail descriptions.
*
*
* @param deviceStatusDetails
* One or more device status detail descriptions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceStatusDetails(DeviceStatusDetail... deviceStatusDetails);
/**
*
* One or more device status detail descriptions.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.alexaforbusiness.model.DeviceStatusDetail.Builder} avoiding the need
* to create one manually via
* {@link software.amazon.awssdk.services.alexaforbusiness.model.DeviceStatusDetail#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.alexaforbusiness.model.DeviceStatusDetail.Builder#build()} is called
* immediately and its result is passed to {@link #deviceStatusDetails(List)}.
*
* @param deviceStatusDetails
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.alexaforbusiness.model.DeviceStatusDetail.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #deviceStatusDetails(java.util.Collection)
*/
Builder deviceStatusDetails(Consumer... deviceStatusDetails);
/**
*
* The latest available information about the connection status of a device.
*
*
* @param connectionStatus
* The latest available information about the connection status of a device.
* @see ConnectionStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionStatus
*/
Builder connectionStatus(String connectionStatus);
/**
*
* The latest available information about the connection status of a device.
*
*
* @param connectionStatus
* The latest available information about the connection status of a device.
* @see ConnectionStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionStatus
*/
Builder connectionStatus(ConnectionStatus connectionStatus);
/**
*
* The time (in epoch) when the device connection status changed.
*
*
* @param connectionStatusUpdatedTime
* The time (in epoch) when the device connection status changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder connectionStatusUpdatedTime(Instant connectionStatusUpdatedTime);
}
static final class BuilderImpl implements Builder {
private List deviceStatusDetails = DefaultSdkAutoConstructList.getInstance();
private String connectionStatus;
private Instant connectionStatusUpdatedTime;
private BuilderImpl() {
}
private BuilderImpl(DeviceStatusInfo model) {
deviceStatusDetails(model.deviceStatusDetails);
connectionStatus(model.connectionStatus);
connectionStatusUpdatedTime(model.connectionStatusUpdatedTime);
}
public final List getDeviceStatusDetails() {
List result = DeviceStatusDetailsCopier.copyToBuilder(this.deviceStatusDetails);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDeviceStatusDetails(Collection deviceStatusDetails) {
this.deviceStatusDetails = DeviceStatusDetailsCopier.copyFromBuilder(deviceStatusDetails);
}
@Override
public final Builder deviceStatusDetails(Collection deviceStatusDetails) {
this.deviceStatusDetails = DeviceStatusDetailsCopier.copy(deviceStatusDetails);
return this;
}
@Override
@SafeVarargs
public final Builder deviceStatusDetails(DeviceStatusDetail... deviceStatusDetails) {
deviceStatusDetails(Arrays.asList(deviceStatusDetails));
return this;
}
@Override
@SafeVarargs
public final Builder deviceStatusDetails(Consumer... deviceStatusDetails) {
deviceStatusDetails(Stream.of(deviceStatusDetails).map(c -> DeviceStatusDetail.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getConnectionStatus() {
return connectionStatus;
}
public final void setConnectionStatus(String connectionStatus) {
this.connectionStatus = connectionStatus;
}
@Override
public final Builder connectionStatus(String connectionStatus) {
this.connectionStatus = connectionStatus;
return this;
}
@Override
public final Builder connectionStatus(ConnectionStatus connectionStatus) {
this.connectionStatus(connectionStatus == null ? null : connectionStatus.toString());
return this;
}
public final Instant getConnectionStatusUpdatedTime() {
return connectionStatusUpdatedTime;
}
public final void setConnectionStatusUpdatedTime(Instant connectionStatusUpdatedTime) {
this.connectionStatusUpdatedTime = connectionStatusUpdatedTime;
}
@Override
public final Builder connectionStatusUpdatedTime(Instant connectionStatusUpdatedTime) {
this.connectionStatusUpdatedTime = connectionStatusUpdatedTime;
return this;
}
@Override
public DeviceStatusInfo build() {
return new DeviceStatusInfo(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}