software.amazon.awssdk.services.iotfleetwise.model.CreateSignalCatalogRequest 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.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 CreateSignalCatalogRequest extends IoTFleetWiseRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(CreateSignalCatalogRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateSignalCatalogRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField> NODES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("nodes")
.getter(getter(CreateSignalCatalogRequest::nodes))
.setter(setter(Builder::nodes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nodes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Node::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateSignalCatalogRequest::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(NAME_FIELD, DESCRIPTION_FIELD,
NODES_FIELD, TAGS_FIELD));
private final String name;
private final String description;
private final List nodes;
private final List tags;
private CreateSignalCatalogRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.description = builder.description;
this.nodes = builder.nodes;
this.tags = builder.tags;
}
/**
*
* The name of the signal catalog to create.
*
*
* @return The name of the signal catalog to create.
*/
public final String name() {
return name;
}
/**
*
* A brief description of the signal catalog.
*
*
* @return A brief description of the signal catalog.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the Nodes 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 hasNodes() {
return nodes != null && !(nodes instanceof SdkAutoConstructList);
}
/**
*
* A list of information about nodes, which are a general abstraction of signals. For more information, see the API
* data type.
*
*
* 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 #hasNodes} method.
*
*
* @return A list of information about nodes, which are a general abstraction of signals. For more information, see
* the API data type.
*/
public final List nodes() {
return nodes;
}
/**
* 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 that can be used to manage the signal catalog.
*
*
* 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 that can be used to manage the signal catalog.
*/
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(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasNodes() ? nodes() : null);
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 CreateSignalCatalogRequest)) {
return false;
}
CreateSignalCatalogRequest other = (CreateSignalCatalogRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(description(), other.description())
&& hasNodes() == other.hasNodes() && Objects.equals(nodes(), other.nodes()) && 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("CreateSignalCatalogRequest").add("Name", name()).add("Description", description())
.add("Nodes", hasNodes() ? nodes() : null).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "nodes":
return Optional.ofNullable(clazz.cast(nodes()));
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((CreateSignalCatalogRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IoTFleetWiseRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the signal catalog to create.
*
*
* @param name
* The name of the signal catalog to create.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* A brief description of the signal catalog.
*
*
* @param description
* A brief description of the signal catalog.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* A list of information about nodes, which are a general abstraction of signals. For more information, see the
* API data type.
*
*
* @param nodes
* A list of information about nodes, which are a general abstraction of signals. For more information,
* see the API data type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nodes(Collection nodes);
/**
*
* A list of information about nodes, which are a general abstraction of signals. For more information, see the
* API data type.
*
*
* @param nodes
* A list of information about nodes, which are a general abstraction of signals. For more information,
* see the API data type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nodes(Node... nodes);
/**
*
* A list of information about nodes, which are a general abstraction of signals. For more information, see the
* API data type.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iotfleetwise.model.Node.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.iotfleetwise.model.Node#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.iotfleetwise.model.Node.Builder#build()} is called immediately and its
* result is passed to {@link #nodes(List)}.
*
* @param nodes
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.iotfleetwise.model.Node.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #nodes(java.util.Collection)
*/
Builder nodes(Consumer... nodes);
/**
*
* Metadata that can be used to manage the signal catalog.
*
*
* @param tags
* Metadata that can be used to manage the signal catalog.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* Metadata that can be used to manage the signal catalog.
*
*
* @param tags
* Metadata that can be used to manage the signal catalog.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* Metadata that can be used to manage the signal catalog.
*
* 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);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IoTFleetWiseRequest.BuilderImpl implements Builder {
private String name;
private String description;
private List nodes = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateSignalCatalogRequest model) {
super(model);
name(model.name);
description(model.description);
nodes(model.nodes);
tags(model.tags);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
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 List getNodes() {
List result = NodesCopier.copyToBuilder(this.nodes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setNodes(Collection nodes) {
this.nodes = NodesCopier.copyFromBuilder(nodes);
}
@Override
public final Builder nodes(Collection nodes) {
this.nodes = NodesCopier.copy(nodes);
return this;
}
@Override
@SafeVarargs
public final Builder nodes(Node... nodes) {
nodes(Arrays.asList(nodes));
return this;
}
@Override
@SafeVarargs
public final Builder nodes(Consumer... nodes) {
nodes(Stream.of(nodes).map(c -> Node.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 CreateSignalCatalogRequest build() {
return new CreateSignalCatalogRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}