software.amazon.awssdk.services.iottwinmaker.model

Class CreateEntityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerRequest

software.amazon.awssdk.services.iottwinmaker.model.CreateEntityRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEntityRequest.Builder,CreateEntityRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEntityRequest
extends IoTTwinMakerRequest
implements ToCopyableBuilder<CreateEntityRequest.Builder,CreateEntityRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEntityRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateEntityRequest.Builder	builder()
Map<String,ComponentRequest>	components() An object that maps strings to the components in the entity.
String	description() The description of the entity.
String	entityId() The ID of the entity.
String	entityName() The name of the entity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasComponents() For responses, this returns true if the service returned a value for the Components property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	parentEntityId() The ID of the entity's parent entity.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEntityRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Metadata that you can use to manage the entity.
CreateEntityRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workspaceId() The ID of the workspace that contains the entity.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

workspaceId

public final String workspaceId()

The ID of the workspace that contains the entity.

Returns:

The ID of the workspace that contains the entity.

entityId

public final String entityId()

The ID of the entity.

Returns:

The ID of the entity.

entityName

public final String entityName()

The name of the entity.

Returns:

The name of the entity.

description

public final String description()

The description of the entity.

Returns:

The description of the entity.

hasComponents

public final boolean hasComponents()

For responses, this returns true if the service returned a value for the Components property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

components

public final Map<String,ComponentRequest> components()

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

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 hasComponents() method.

Returns:

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

parentEntityId

public final String parentEntityId()

The ID of the entity's parent entity.

Returns:

The ID of the entity's parent entity.

hasTags

public final boolean hasTags()

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 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.

tags

public final Map<String,String> tags()

Metadata that you can use to manage the entity.

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 hasTags() method.

Returns:

Metadata that you can use to manage the entity.

toBuilder

public CreateEntityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEntityRequest.Builder,CreateEntityRequest>

Specified by:

toBuilder in class IoTTwinMakerRequest

builder

public static CreateEntityRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateEntityRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo