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("software.amazon.awssdk:codegen") public final class CreateComponentTypeRequest extends IoTTwinMakerRequest implements ToCopyableBuilder<CreateComponentTypeRequest.Builder,CreateComponentTypeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateComponentTypeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateComponentTypeRequest.Builderbuilder()StringcomponentTypeId()The ID of the component type.StringcomponentTypeName()A friendly name for the component type.Map<String,CompositeComponentTypeRequest>compositeComponentTypes()This is an object that maps strings tocompositeComponentTypesof thecomponentType.Stringdescription()The description of the component type.booleanequals(Object obj)booleanequalsBySdkFields(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)booleanhasCompositeComponentTypes()For responses, this returns true if the service returned a value for the CompositeComponentTypes property.booleanhasExtendsFrom()For responses, this returns true if the service returned a value for the ExtendsFrom property.booleanhasFunctions()For responses, this returns true if the service returned a value for the Functions property.inthashCode()booleanhasPropertyDefinitions()For responses, this returns true if the service returned a value for the PropertyDefinitions property.booleanhasPropertyGroups()For responses, this returns true if the service returned a value for the PropertyGroups property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.BooleanisSingleton()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()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateComponentTypeRequest.Builder>serializableBuilderClass()Map<String,String>tags()Metadata that you can use to manage the component type.CreateComponentTypeRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringworkspaceId()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 theisEmpty()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 theisEmpty()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 theisEmpty()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 theisEmpty()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 theisEmpty()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.
-
hasCompositeComponentTypes
public final boolean hasCompositeComponentTypes()
For responses, this returns true if the service returned a value for the CompositeComponentTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
compositeComponentTypes
public final Map<String,CompositeComponentTypeRequest> compositeComponentTypes()
This is an object that maps strings to
compositeComponentTypesof thecomponentType.CompositeComponentTypeis referenced bycomponentTypeId.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
hasCompositeComponentTypes()method.- Returns:
- This is an object that maps strings to
compositeComponentTypesof thecomponentType.CompositeComponentTypeis referenced bycomponentTypeId.
-
toBuilder
public CreateComponentTypeRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateComponentTypeRequest.Builder,CreateComponentTypeRequest>- Specified by:
toBuilderin classIoTTwinMakerRequest
-
builder
public static CreateComponentTypeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateComponentTypeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-