software.amazon.awssdk.services.networkmanager.model.CreateDeviceRequest 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.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.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 CreateDeviceRequest extends NetworkManagerRequest implements
ToCopyableBuilder {
private static final SdkField GLOBAL_NETWORK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GlobalNetworkId").getter(getter(CreateDeviceRequest::globalNetworkId))
.setter(setter(Builder::globalNetworkId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("globalNetworkId").build()).build();
private static final SdkField AWS_LOCATION_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("AWSLocation").getter(getter(CreateDeviceRequest::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(CreateDeviceRequest::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(CreateDeviceRequest::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(CreateDeviceRequest::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(CreateDeviceRequest::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(CreateDeviceRequest::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(CreateDeviceRequest::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(CreateDeviceRequest::siteId)).setter(setter(Builder::siteId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SiteId").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateDeviceRequest::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(GLOBAL_NETWORK_ID_FIELD,
AWS_LOCATION_FIELD, DESCRIPTION_FIELD, TYPE_FIELD, VENDOR_FIELD, MODEL_FIELD, SERIAL_NUMBER_FIELD, LOCATION_FIELD,
SITE_ID_FIELD, TAGS_FIELD));
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 List tags;
private CreateDeviceRequest(BuilderImpl builder) {
super(builder);
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.tags = builder.tags;
}
/**
*
* 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, if applicable. For an on-premises device, you can omit this
* parameter.
*
*
* @return The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit
* this parameter.
*/
public final AWSLocation awsLocation() {
return awsLocation;
}
/**
*
* A description of the device.
*
*
* Constraints: Maximum length of 256 characters.
*
*
* @return A description of the device.
*
* Constraints: Maximum length of 256 characters.
*/
public final String description() {
return description;
}
/**
*
* The type of the device.
*
*
* @return The type of the device.
*/
public final String type() {
return type;
}
/**
*
* The vendor of the device.
*
*
* Constraints: Maximum length of 128 characters.
*
*
* @return The vendor of the device.
*
* Constraints: Maximum length of 128 characters.
*/
public final String vendor() {
return vendor;
}
/**
*
* The model of the device.
*
*
* Constraints: Maximum length of 128 characters.
*
*
* @return The model of the device.
*
* Constraints: Maximum length of 128 characters.
*/
public final String model() {
return model;
}
/**
*
* The serial number of the device.
*
*
* Constraints: Maximum length of 128 characters.
*
*
* @return The serial number of the device.
*
* Constraints: Maximum length of 128 characters.
*/
public final String serialNumber() {
return serialNumber;
}
/**
*
* The location of the device.
*
*
* @return The location of the device.
*/
public final Location location() {
return location;
}
/**
*
* The ID of the site.
*
*
* @return The ID of the site.
*/
public final String siteId() {
return siteId;
}
/**
* 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 to apply to the resource during creation.
*
*
* 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 to apply to the resource during creation.
*/
public final List tags() {
return tags;
}
@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(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(hasTags() ? tags() : 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 CreateDeviceRequest)) {
return false;
}
CreateDeviceRequest other = (CreateDeviceRequest) obj;
return 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()) && 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("CreateDeviceRequest").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("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
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 "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateDeviceRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends NetworkManagerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the global network.
*
*
* @param globalNetworkId
* The ID of the global network.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder globalNetworkId(String globalNetworkId);
/**
*
* The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this
* parameter.
*
*
* @param awsLocation
* The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit
* this parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder awsLocation(AWSLocation awsLocation);
/**
*
* The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this
* parameter.
*
* This is a convenience method that creates an instance of the {@link AWSLocation.Builder} avoiding the need to
* create one manually via {@link AWSLocation#builder()}.
*
*
* When the {@link Consumer} completes, {@link AWSLocation.Builder#build()} is called immediately and its result
* is passed to {@link #awsLocation(AWSLocation)}.
*
* @param awsLocation
* a consumer that will call methods on {@link AWSLocation.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #awsLocation(AWSLocation)
*/
default Builder awsLocation(Consumer awsLocation) {
return awsLocation(AWSLocation.builder().applyMutation(awsLocation).build());
}
/**
*
* A description of the device.
*
*
* Constraints: Maximum length of 256 characters.
*
*
* @param description
* A description of the device.
*
* Constraints: Maximum length of 256 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The type of the device.
*
*
* @param type
* The type of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder type(String type);
/**
*
* The vendor of the device.
*
*
* Constraints: Maximum length of 128 characters.
*
*
* @param vendor
* The vendor of the device.
*
* Constraints: Maximum length of 128 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vendor(String vendor);
/**
*
* The model of the device.
*
*
* Constraints: Maximum length of 128 characters.
*
*
* @param model
* The model of the device.
*
* Constraints: Maximum length of 128 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder model(String model);
/**
*
* The serial number of the device.
*
*
* Constraints: Maximum length of 128 characters.
*
*
* @param serialNumber
* The serial number of the device.
*
* Constraints: Maximum length of 128 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serialNumber(String serialNumber);
/**
*
* The location of the device.
*
*
* @param location
* The location of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder location(Location location);
/**
*
* The location of the device.
*
* This is a convenience method that creates an instance of the {@link Location.Builder} avoiding the need to
* create one manually via {@link Location#builder()}.
*
*
* When the {@link Consumer} completes, {@link Location.Builder#build()} is called immediately and its result is
* passed to {@link #location(Location)}.
*
* @param location
* a consumer that will call methods on {@link Location.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #location(Location)
*/
default Builder location(Consumer location) {
return location(Location.builder().applyMutation(location).build());
}
/**
*
* The ID of the site.
*
*
* @param siteId
* The ID of the site.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder siteId(String siteId);
/**
*
* The tags to apply to the resource during creation.
*
*
* @param tags
* The tags to apply to the resource during creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* The tags to apply to the resource during creation.
*
*
* @param tags
* The tags to apply to the resource during creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* The tags to apply to the resource during creation.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.networkmanager.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.networkmanager.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.networkmanager.model.Tag.Builder#build()} is called immediately and
* its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.networkmanager.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends NetworkManagerRequest.BuilderImpl implements Builder {
private String globalNetworkId;
private AWSLocation awsLocation;
private String description;
private String type;
private String vendor;
private String model;
private String serialNumber;
private Location location;
private String siteId;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateDeviceRequest model) {
super(model);
globalNetworkId(model.globalNetworkId);
awsLocation(model.awsLocation);
description(model.description);
type(model.type);
vendor(model.vendor);
model(model.model);
serialNumber(model.serialNumber);
location(model.location);
siteId(model.siteId);
tags(model.tags);
}
public final String getGlobalNetworkId() {
return globalNetworkId;
}
public final void setGlobalNetworkId(String globalNetworkId) {
this.globalNetworkId = globalNetworkId;
}
@Override
public final Builder globalNetworkId(String globalNetworkId) {
this.globalNetworkId = globalNetworkId;
return this;
}
public final AWSLocation.Builder getAwsLocation() {
return awsLocation != null ? awsLocation.toBuilder() : null;
}
public final void setAwsLocation(AWSLocation.BuilderImpl awsLocation) {
this.awsLocation = awsLocation != null ? awsLocation.build() : null;
}
@Override
public final Builder awsLocation(AWSLocation awsLocation) {
this.awsLocation = awsLocation;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
public final String getVendor() {
return vendor;
}
public final void setVendor(String vendor) {
this.vendor = vendor;
}
@Override
public final Builder vendor(String vendor) {
this.vendor = vendor;
return this;
}
public final String getModel() {
return model;
}
public final void setModel(String model) {
this.model = model;
}
@Override
public final Builder model(String model) {
this.model = model;
return this;
}
public final String getSerialNumber() {
return serialNumber;
}
public final void setSerialNumber(String serialNumber) {
this.serialNumber = serialNumber;
}
@Override
public final Builder serialNumber(String serialNumber) {
this.serialNumber = serialNumber;
return this;
}
public final Location.Builder getLocation() {
return location != null ? location.toBuilder() : null;
}
public final void setLocation(Location.BuilderImpl location) {
this.location = location != null ? location.build() : null;
}
@Override
public final Builder location(Location location) {
this.location = location;
return this;
}
public final String getSiteId() {
return siteId;
}
public final void setSiteId(String siteId) {
this.siteId = siteId;
}
@Override
public final Builder siteId(String siteId) {
this.siteId = siteId;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 CreateDeviceRequest build() {
return new CreateDeviceRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}