software.amazon.awssdk.services.iotfleetwise.model.CreateVehicleRequestItem Maven / Gradle / Ivy
Show all versions of iotfleetwise 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.iotfleetwise.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
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.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about the vehicle to create.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateVehicleRequestItem implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField VEHICLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("vehicleName").getter(getter(CreateVehicleRequestItem::vehicleName)).setter(setter(Builder::vehicleName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("vehicleName").build()).build();
private static final SdkField MODEL_MANIFEST_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("modelManifestArn").getter(getter(CreateVehicleRequestItem::modelManifestArn))
.setter(setter(Builder::modelManifestArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("modelManifestArn").build()).build();
private static final SdkField DECODER_MANIFEST_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("decoderManifestArn").getter(getter(CreateVehicleRequestItem::decoderManifestArn))
.setter(setter(Builder::decoderManifestArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("decoderManifestArn").build())
.build();
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("attributes")
.getter(getter(CreateVehicleRequestItem::attributes))
.setter(setter(Builder::attributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("attributes").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField ASSOCIATION_BEHAVIOR_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("associationBehavior").getter(getter(CreateVehicleRequestItem::associationBehaviorAsString))
.setter(setter(Builder::associationBehavior))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("associationBehavior").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateVehicleRequestItem::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(VEHICLE_NAME_FIELD,
MODEL_MANIFEST_ARN_FIELD, DECODER_MANIFEST_ARN_FIELD, ATTRIBUTES_FIELD, ASSOCIATION_BEHAVIOR_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String vehicleName;
private final String modelManifestArn;
private final String decoderManifestArn;
private final Map attributes;
private final String associationBehavior;
private final List tags;
private CreateVehicleRequestItem(BuilderImpl builder) {
this.vehicleName = builder.vehicleName;
this.modelManifestArn = builder.modelManifestArn;
this.decoderManifestArn = builder.decoderManifestArn;
this.attributes = builder.attributes;
this.associationBehavior = builder.associationBehavior;
this.tags = builder.tags;
}
/**
*
* The unique ID of the vehicle to create.
*
*
* @return The unique ID of the vehicle to create.
*/
public final String vehicleName() {
return vehicleName;
}
/**
*
* The ARN of the vehicle model (model manifest) to create the vehicle from.
*
*
* @return The ARN of the vehicle model (model manifest) to create the vehicle from.
*/
public final String modelManifestArn() {
return modelManifestArn;
}
/**
*
* The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
*
*
* @return The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
*/
public final String decoderManifestArn() {
return decoderManifestArn;
}
/**
* For responses, this returns true if the service returned a value for the Attributes 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 hasAttributes() {
return attributes != null && !(attributes instanceof SdkAutoConstructMap);
}
/**
*
* Static information about a vehicle in a key-value pair. For example: "engine Type" :
* "v6"
*
*
* 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 #hasAttributes} method.
*
*
* @return Static information about a vehicle in a key-value pair. For example: "engine Type" :
* "v6"
*/
public final Map attributes() {
return attributes;
}
/**
*
* An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing
* as a vehicle.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #associationBehavior} will return {@link VehicleAssociationBehavior#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #associationBehaviorAsString}.
*
*
* @return An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an
* existing thing as a vehicle.
* @see VehicleAssociationBehavior
*/
public final VehicleAssociationBehavior associationBehavior() {
return VehicleAssociationBehavior.fromValue(associationBehavior);
}
/**
*
* An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing
* as a vehicle.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #associationBehavior} will return {@link VehicleAssociationBehavior#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #associationBehaviorAsString}.
*
*
* @return An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an
* existing thing as a vehicle.
* @see VehicleAssociationBehavior
*/
public final String associationBehaviorAsString() {
return associationBehavior;
}
/**
* 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);
}
/**
*
* Metadata which can be used to manage the vehicle.
*
*
* 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 Metadata which can be used to manage the vehicle.
*/
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 + Objects.hashCode(vehicleName());
hashCode = 31 * hashCode + Objects.hashCode(modelManifestArn());
hashCode = 31 * hashCode + Objects.hashCode(decoderManifestArn());
hashCode = 31 * hashCode + Objects.hashCode(hasAttributes() ? attributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(associationBehaviorAsString());
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 CreateVehicleRequestItem)) {
return false;
}
CreateVehicleRequestItem other = (CreateVehicleRequestItem) obj;
return Objects.equals(vehicleName(), other.vehicleName()) && Objects.equals(modelManifestArn(), other.modelManifestArn())
&& Objects.equals(decoderManifestArn(), other.decoderManifestArn()) && hasAttributes() == other.hasAttributes()
&& Objects.equals(attributes(), other.attributes())
&& Objects.equals(associationBehaviorAsString(), other.associationBehaviorAsString())
&& 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("CreateVehicleRequestItem").add("VehicleName", vehicleName())
.add("ModelManifestArn", modelManifestArn()).add("DecoderManifestArn", decoderManifestArn())
.add("Attributes", hasAttributes() ? attributes() : null)
.add("AssociationBehavior", associationBehaviorAsString()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "vehicleName":
return Optional.ofNullable(clazz.cast(vehicleName()));
case "modelManifestArn":
return Optional.ofNullable(clazz.cast(modelManifestArn()));
case "decoderManifestArn":
return Optional.ofNullable(clazz.cast(decoderManifestArn()));
case "attributes":
return Optional.ofNullable(clazz.cast(attributes()));
case "associationBehavior":
return Optional.ofNullable(clazz.cast(associationBehaviorAsString()));
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((CreateVehicleRequestItem) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique ID of the vehicle to create.
*
*
* @param vehicleName
* The unique ID of the vehicle to create.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vehicleName(String vehicleName);
/**
*
* The ARN of the vehicle model (model manifest) to create the vehicle from.
*
*
* @param modelManifestArn
* The ARN of the vehicle model (model manifest) to create the vehicle from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelManifestArn(String modelManifestArn);
/**
*
* The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
*
*
* @param decoderManifestArn
* The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder decoderManifestArn(String decoderManifestArn);
/**
*
* Static information about a vehicle in a key-value pair. For example: "engine Type" :
* "v6"
*
*
* @param attributes
* Static information about a vehicle in a key-value pair. For example: "engine Type" :
* "v6"
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Map attributes);
/**
*
* An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing
* thing as a vehicle.
*
*
* @param associationBehavior
* An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an
* existing thing as a vehicle.
* @see VehicleAssociationBehavior
* @return Returns a reference to this object so that method calls can be chained together.
* @see VehicleAssociationBehavior
*/
Builder associationBehavior(String associationBehavior);
/**
*
* An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing
* thing as a vehicle.
*
*
* @param associationBehavior
* An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an
* existing thing as a vehicle.
* @see VehicleAssociationBehavior
* @return Returns a reference to this object so that method calls can be chained together.
* @see VehicleAssociationBehavior
*/
Builder associationBehavior(VehicleAssociationBehavior associationBehavior);
/**
*
* Metadata which can be used to manage the vehicle.
*
*
* @param tags
* Metadata which can be used to manage the vehicle.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* Metadata which can be used to manage the vehicle.
*
*
* @param tags
* Metadata which can be used to manage the vehicle.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* Metadata which can be used to manage the vehicle.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iotfleetwise.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.iotfleetwise.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.iotfleetwise.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.iotfleetwise.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);
}
static final class BuilderImpl implements Builder {
private String vehicleName;
private String modelManifestArn;
private String decoderManifestArn;
private Map attributes = DefaultSdkAutoConstructMap.getInstance();
private String associationBehavior;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateVehicleRequestItem model) {
vehicleName(model.vehicleName);
modelManifestArn(model.modelManifestArn);
decoderManifestArn(model.decoderManifestArn);
attributes(model.attributes);
associationBehavior(model.associationBehavior);
tags(model.tags);
}
public final String getVehicleName() {
return vehicleName;
}
public final void setVehicleName(String vehicleName) {
this.vehicleName = vehicleName;
}
@Override
public final Builder vehicleName(String vehicleName) {
this.vehicleName = vehicleName;
return this;
}
public final String getModelManifestArn() {
return modelManifestArn;
}
public final void setModelManifestArn(String modelManifestArn) {
this.modelManifestArn = modelManifestArn;
}
@Override
public final Builder modelManifestArn(String modelManifestArn) {
this.modelManifestArn = modelManifestArn;
return this;
}
public final String getDecoderManifestArn() {
return decoderManifestArn;
}
public final void setDecoderManifestArn(String decoderManifestArn) {
this.decoderManifestArn = decoderManifestArn;
}
@Override
public final Builder decoderManifestArn(String decoderManifestArn) {
this.decoderManifestArn = decoderManifestArn;
return this;
}
public final Map getAttributes() {
if (attributes instanceof SdkAutoConstructMap) {
return null;
}
return attributes;
}
public final void setAttributes(Map attributes) {
this.attributes = _attributesMapCopier.copy(attributes);
}
@Override
public final Builder attributes(Map attributes) {
this.attributes = _attributesMapCopier.copy(attributes);
return this;
}
public final String getAssociationBehavior() {
return associationBehavior;
}
public final void setAssociationBehavior(String associationBehavior) {
this.associationBehavior = associationBehavior;
}
@Override
public final Builder associationBehavior(String associationBehavior) {
this.associationBehavior = associationBehavior;
return this;
}
@Override
public final Builder associationBehavior(VehicleAssociationBehavior associationBehavior) {
this.associationBehavior(associationBehavior == null ? null : associationBehavior.toString());
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 CreateVehicleRequestItem build() {
return new CreateVehicleRequestItem(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}