software.amazon.awssdk.services.networkmanager.model.Device Maven / Gradle / Ivy
Show all versions of networkmanager 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.networkmanager.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;
/**
*
* Describes a device.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Device implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DEVICE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeviceId").getter(getter(Device::deviceId)).setter(setter(Builder::deviceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceId").build()).build();
private static final SdkField DEVICE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeviceArn").getter(getter(Device::deviceArn)).setter(setter(Builder::deviceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceArn").build()).build();
private static final SdkField GLOBAL_NETWORK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GlobalNetworkId").getter(getter(Device::globalNetworkId)).setter(setter(Builder::globalNetworkId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GlobalNetworkId").build()).build();
private static final SdkField AWS_LOCATION_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("AWSLocation").getter(getter(Device::awsLocation)).setter(setter(Builder::awsLocation))
.constructor(AWSLocation::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AWSLocation").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(Device::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(Device::type)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField VENDOR_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Vendor")
.getter(getter(Device::vendor)).setter(setter(Builder::vendor))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Vendor").build()).build();
private static final SdkField MODEL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Model")
.getter(getter(Device::model)).setter(setter(Builder::model))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Model").build()).build();
private static final SdkField SERIAL_NUMBER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SerialNumber").getter(getter(Device::serialNumber)).setter(setter(Builder::serialNumber))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SerialNumber").build()).build();
private static final SdkField LOCATION_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Location").getter(getter(Device::location)).setter(setter(Builder::location))
.constructor(Location::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Location").build()).build();
private static final SdkField SITE_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("SiteId")
.getter(getter(Device::siteId)).setter(setter(Builder::siteId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SiteId").build()).build();
private static final SdkField CREATED_AT_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreatedAt").getter(getter(Device::createdAt)).setter(setter(Builder::createdAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedAt").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(Device::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(Device::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DEVICE_ID_FIELD,
DEVICE_ARN_FIELD, GLOBAL_NETWORK_ID_FIELD, AWS_LOCATION_FIELD, DESCRIPTION_FIELD, TYPE_FIELD, VENDOR_FIELD,
MODEL_FIELD, SERIAL_NUMBER_FIELD, LOCATION_FIELD, SITE_ID_FIELD, CREATED_AT_FIELD, STATE_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String deviceId;
private final String deviceArn;
private final String globalNetworkId;
private final AWSLocation awsLocation;
private final String description;
private final String type;
private final String vendor;
private final String model;
private final String serialNumber;
private final Location location;
private final String siteId;
private final Instant createdAt;
private final String state;
private final List tags;
private Device(BuilderImpl builder) {
this.deviceId = builder.deviceId;
this.deviceArn = builder.deviceArn;
this.globalNetworkId = builder.globalNetworkId;
this.awsLocation = builder.awsLocation;
this.description = builder.description;
this.type = builder.type;
this.vendor = builder.vendor;
this.model = builder.model;
this.serialNumber = builder.serialNumber;
this.location = builder.location;
this.siteId = builder.siteId;
this.createdAt = builder.createdAt;
this.state = builder.state;
this.tags = builder.tags;
}
/**
*
* The ID of the device.
*
*
* @return The ID of the device.
*/
public final String deviceId() {
return deviceId;
}
/**
*
* The Amazon Resource Name (ARN) of the device.
*
*
* @return The Amazon Resource Name (ARN) of the device.
*/
public final String deviceArn() {
return deviceArn;
}
/**
*
* The ID of the global network.
*
*
* @return The ID of the global network.
*/
public final String globalNetworkId() {
return globalNetworkId;
}
/**
*
* The Amazon Web Services location of the device.
*
*
* @return The Amazon Web Services location of the device.
*/
public final AWSLocation awsLocation() {
return awsLocation;
}
/**
*
* The description of the device.
*
*
* @return The description of the device.
*/
public final String description() {
return description;
}
/**
*
* The device type.
*
*
* @return The device type.
*/
public final String type() {
return type;
}
/**
*
* The device vendor.
*
*
* @return The device vendor.
*/
public final String vendor() {
return vendor;
}
/**
*
* The device model.
*
*
* @return The device model.
*/
public final String model() {
return model;
}
/**
*
* The device serial number.
*
*
* @return The device serial number.
*/
public final String serialNumber() {
return serialNumber;
}
/**
*
* The site location.
*
*
* @return The site location.
*/
public final Location location() {
return location;
}
/**
*
* The site ID.
*
*
* @return The site ID.
*/
public final String siteId() {
return siteId;
}
/**
*
* The date and time that the site was created.
*
*
* @return The date and time that the site was created.
*/
public final Instant createdAt() {
return createdAt;
}
/**
*
* The device state.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link DeviceState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The device state.
* @see DeviceState
*/
public final DeviceState state() {
return DeviceState.fromValue(state);
}
/**
*
* The device state.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link DeviceState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The device state.
* @see DeviceState
*/
public final String stateAsString() {
return state;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* The tags for the device.
*
*
* 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 #hasTags} method.
*
*
* @return The tags for the device.
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(deviceId());
hashCode = 31 * hashCode + Objects.hashCode(deviceArn());
hashCode = 31 * hashCode + Objects.hashCode(globalNetworkId());
hashCode = 31 * hashCode + Objects.hashCode(awsLocation());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(type());
hashCode = 31 * hashCode + Objects.hashCode(vendor());
hashCode = 31 * hashCode + Objects.hashCode(model());
hashCode = 31 * hashCode + Objects.hashCode(serialNumber());
hashCode = 31 * hashCode + Objects.hashCode(location());
hashCode = 31 * hashCode + Objects.hashCode(siteId());
hashCode = 31 * hashCode + Objects.hashCode(createdAt());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 Device)) {
return false;
}
Device other = (Device) obj;
return Objects.equals(deviceId(), other.deviceId()) && Objects.equals(deviceArn(), other.deviceArn())
&& Objects.equals(globalNetworkId(), other.globalNetworkId())
&& Objects.equals(awsLocation(), other.awsLocation()) && Objects.equals(description(), other.description())
&& Objects.equals(type(), other.type()) && Objects.equals(vendor(), other.vendor())
&& Objects.equals(model(), other.model()) && Objects.equals(serialNumber(), other.serialNumber())
&& Objects.equals(location(), other.location()) && Objects.equals(siteId(), other.siteId())
&& Objects.equals(createdAt(), other.createdAt()) && Objects.equals(stateAsString(), other.stateAsString())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("Device").add("DeviceId", deviceId()).add("DeviceArn", deviceArn())
.add("GlobalNetworkId", globalNetworkId()).add("AWSLocation", awsLocation()).add("Description", description())
.add("Type", type()).add("Vendor", vendor()).add("Model", model()).add("SerialNumber", serialNumber())
.add("Location", location() == null ? null : "*** Sensitive Data Redacted ***").add("SiteId", siteId())
.add("CreatedAt", createdAt()).add("State", stateAsString()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DeviceId":
return Optional.ofNullable(clazz.cast(deviceId()));
case "DeviceArn":
return Optional.ofNullable(clazz.cast(deviceArn()));
case "GlobalNetworkId":
return Optional.ofNullable(clazz.cast(globalNetworkId()));
case "AWSLocation":
return Optional.ofNullable(clazz.cast(awsLocation()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Type":
return Optional.ofNullable(clazz.cast(type()));
case "Vendor":
return Optional.ofNullable(clazz.cast(vendor()));
case "Model":
return Optional.ofNullable(clazz.cast(model()));
case "SerialNumber":
return Optional.ofNullable(clazz.cast(serialNumber()));
case "Location":
return Optional.ofNullable(clazz.cast(location()));
case "SiteId":
return Optional.ofNullable(clazz.cast(siteId()));
case "CreatedAt":
return Optional.ofNullable(clazz.cast(createdAt()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function