software.amazon.awssdk.services.iottwinmaker.model

Class CreateComponentTypeRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateComponentTypeRequest.Builder,CreateComponentTypeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateComponentTypeRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateComponentTypeRequest.Builder	builder()
String	componentTypeId() The ID of the component type.
String	componentTypeName() A friendly name for the component type.
String	description() The description of the component type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	extendsFrom() Specifies the parent component type to extend.
Map<String,FunctionRequest>	functions() An object that maps strings to the functions in the component type.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExtendsFrom() For responses, this returns true if the service returned a value for the ExtendsFrom property.
boolean	hasFunctions() For responses, this returns true if the service returned a value for the Functions property.
int	hashCode()
boolean	hasPropertyDefinitions() For responses, this returns true if the service returned a value for the PropertyDefinitions property.
boolean	hasPropertyGroups() For responses, this returns true if the service returned a value for the PropertyGroups property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Boolean	isSingleton() A Boolean value that specifies whether an entity can have more than one component of this type.
Map<String,PropertyDefinitionRequest>	propertyDefinitions() An object that maps strings to the property definitions in the component type.
Map<String,PropertyGroupRequest>	propertyGroups()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateComponentTypeRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Metadata that you can use to manage the component type.
CreateComponentTypeRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workspaceId() The ID of the workspace that contains the component type.

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

Returns:

The ID of the workspace that contains the component type.

isSingleton

public final Boolean isSingleton()

A Boolean value that specifies whether an entity can have more than one component of this type.

Returns:

A Boolean value that specifies whether an entity can have more than one component of this type.

componentTypeId

public final String componentTypeId()

The ID of the component type.

Returns:

The ID of the component type.

description

public final String description()

The description of the component type.

Returns:

The description of the component type.

hasPropertyDefinitions

public final boolean hasPropertyDefinitions()

For responses, this returns true if the service returned a value for the PropertyDefinitions 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.

propertyDefinitions

public final Map<String,PropertyDefinitionRequest> propertyDefinitions()

An object that maps strings to the property definitions in the component type. 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 hasPropertyDefinitions() method.

Returns:

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

hasExtendsFrom

public final boolean hasExtendsFrom()

For responses, this returns true if the service returned a value for the ExtendsFrom 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.

extendsFrom

public final List<String> extendsFrom()

Specifies the parent component type to extend.

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

Returns:

Specifies the parent component type to extend.

hasFunctions

public final boolean hasFunctions()

For responses, this returns true if the service returned a value for the Functions 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.

functions

public final Map<String,FunctionRequest> functions()

An object that maps strings to the functions in the component type. 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 hasFunctions() method.

Returns:

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

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

Returns:

Metadata that you can use to manage the component type.

hasPropertyGroups

public final boolean hasPropertyGroups()

For responses, this returns true if the service returned a value for the PropertyGroups 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.

propertyGroups

public final Map<String,PropertyGroupRequest> propertyGroups()

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

Returns:

componentTypeName

public final String componentTypeName()

A friendly name for the component type.

Returns:

A friendly name for the component type.

toBuilder

public CreateComponentTypeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateComponentTypeRequest.Builder,CreateComponentTypeRequest>

Specified by:

toBuilder in class IoTTwinMakerRequest

builder

public static CreateComponentTypeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateComponentTypeRequest.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