software.amazon.awssdk.services.iottwinmaker.model.CreateSceneRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of iottwinmaker Show documentation
Show all versions of iottwinmaker Show documentation
The AWS Java SDK for Io T Twin Maker module holds the client classes that are used for
communicating with Io T Twin Maker.
/*
* 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.iottwinmaker.model;
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 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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateSceneRequest extends IoTTwinMakerRequest implements
ToCopyableBuilder {
private static final SdkField> CAPABILITIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("capabilities")
.getter(getter(CreateSceneRequest::capabilities))
.setter(setter(Builder::capabilities))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("capabilities").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CONTENT_LOCATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("contentLocation").getter(getter(CreateSceneRequest::contentLocation))
.setter(setter(Builder::contentLocation))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("contentLocation").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateSceneRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField SCENE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("sceneId").getter(getter(CreateSceneRequest::sceneId)).setter(setter(Builder::sceneId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("sceneId").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(CreateSceneRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").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 WORKSPACE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("workspaceId").getter(getter(CreateSceneRequest::workspaceId)).setter(setter(Builder::workspaceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("workspaceId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CAPABILITIES_FIELD,
CONTENT_LOCATION_FIELD, DESCRIPTION_FIELD, SCENE_ID_FIELD, TAGS_FIELD, WORKSPACE_ID_FIELD));
private final List capabilities;
private final String contentLocation;
private final String description;
private final String sceneId;
private final Map tags;
private final String workspaceId;
private CreateSceneRequest(BuilderImpl builder) {
super(builder);
this.capabilities = builder.capabilities;
this.contentLocation = builder.contentLocation;
this.description = builder.description;
this.sceneId = builder.sceneId;
this.tags = builder.tags;
this.workspaceId = builder.workspaceId;
}
/**
* For responses, this returns true if the service returned a value for the Capabilities 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 hasCapabilities() {
return capabilities != null && !(capabilities instanceof SdkAutoConstructList);
}
/**
*
* A list of capabilities that the scene uses to render itself.
*
*
* 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 #hasCapabilities} method.
*
*
* @return A list of capabilities that the scene uses to render itself.
*/
public final List capabilities() {
return capabilities;
}
/**
*
* The relative path that specifies the location of the content definition file.
*
*
* @return The relative path that specifies the location of the content definition file.
*/
public final String contentLocation() {
return contentLocation;
}
/**
*
* The description for this scene.
*
*
* @return The description for this scene.
*/
public final String description() {
return description;
}
/**
*
* The ID of the scene.
*
*
* @return The ID of the scene.
*/
public final String sceneId() {
return sceneId;
}
/**
* 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 SdkAutoConstructMap);
}
/**
*
* Metadata that you can use to manage the scene.
*
*
* 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 you can use to manage the scene.
*/
public final Map tags() {
return tags;
}
/**
*
* The ID of the workspace that contains the scene.
*
*
* @return The ID of the workspace that contains the scene.
*/
public final String workspaceId() {
return workspaceId;
}
@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(hasCapabilities() ? capabilities() : null);
hashCode = 31 * hashCode + Objects.hashCode(contentLocation());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(sceneId());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(workspaceId());
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 CreateSceneRequest)) {
return false;
}
CreateSceneRequest other = (CreateSceneRequest) obj;
return hasCapabilities() == other.hasCapabilities() && Objects.equals(capabilities(), other.capabilities())
&& Objects.equals(contentLocation(), other.contentLocation())
&& Objects.equals(description(), other.description()) && Objects.equals(sceneId(), other.sceneId())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& Objects.equals(workspaceId(), other.workspaceId());
}
/**
* 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("CreateSceneRequest").add("Capabilities", hasCapabilities() ? capabilities() : null)
.add("ContentLocation", contentLocation()).add("Description", description()).add("SceneId", sceneId())
.add("Tags", hasTags() ? tags() : null).add("WorkspaceId", workspaceId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "capabilities":
return Optional.ofNullable(clazz.cast(capabilities()));
case "contentLocation":
return Optional.ofNullable(clazz.cast(contentLocation()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "sceneId":
return Optional.ofNullable(clazz.cast(sceneId()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "workspaceId":
return Optional.ofNullable(clazz.cast(workspaceId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateSceneRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IoTTwinMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of capabilities that the scene uses to render itself.
*
*
* @param capabilities
* A list of capabilities that the scene uses to render itself.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capabilities(Collection capabilities);
/**
*
* A list of capabilities that the scene uses to render itself.
*
*
* @param capabilities
* A list of capabilities that the scene uses to render itself.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capabilities(String... capabilities);
/**
*
* The relative path that specifies the location of the content definition file.
*
*
* @param contentLocation
* The relative path that specifies the location of the content definition file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentLocation(String contentLocation);
/**
*
* The description for this scene.
*
*
* @param description
* The description for this scene.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The ID of the scene.
*
*
* @param sceneId
* The ID of the scene.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sceneId(String sceneId);
/**
*
* Metadata that you can use to manage the scene.
*
*
* @param tags
* Metadata that you can use to manage the scene.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The ID of the workspace that contains the scene.
*
*
* @param workspaceId
* The ID of the workspace that contains the scene.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workspaceId(String workspaceId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IoTTwinMakerRequest.BuilderImpl implements Builder {
private List capabilities = DefaultSdkAutoConstructList.getInstance();
private String contentLocation;
private String description;
private String sceneId;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String workspaceId;
private BuilderImpl() {
}
private BuilderImpl(CreateSceneRequest model) {
super(model);
capabilities(model.capabilities);
contentLocation(model.contentLocation);
description(model.description);
sceneId(model.sceneId);
tags(model.tags);
workspaceId(model.workspaceId);
}
public final Collection getCapabilities() {
if (capabilities instanceof SdkAutoConstructList) {
return null;
}
return capabilities;
}
public final void setCapabilities(Collection capabilities) {
this.capabilities = SceneCapabilitiesCopier.copy(capabilities);
}
@Override
public final Builder capabilities(Collection capabilities) {
this.capabilities = SceneCapabilitiesCopier.copy(capabilities);
return this;
}
@Override
@SafeVarargs
public final Builder capabilities(String... capabilities) {
capabilities(Arrays.asList(capabilities));
return this;
}
public final String getContentLocation() {
return contentLocation;
}
public final void setContentLocation(String contentLocation) {
this.contentLocation = contentLocation;
}
@Override
public final Builder contentLocation(String contentLocation) {
this.contentLocation = contentLocation;
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 getSceneId() {
return sceneId;
}
public final void setSceneId(String sceneId) {
this.sceneId = sceneId;
}
@Override
public final Builder sceneId(String sceneId) {
this.sceneId = sceneId;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
public final String getWorkspaceId() {
return workspaceId;
}
public final void setWorkspaceId(String workspaceId) {
this.workspaceId = workspaceId;
}
@Override
public final Builder workspaceId(String workspaceId) {
this.workspaceId = workspaceId;
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 CreateSceneRequest build() {
return new CreateSceneRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy