Class GetComponentTypeResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetComponentTypeResponse.Builder,
GetComponentTypeResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the component type.builder()
final String
The ID of the component type.final String
The component type name.This is an object that maps strings tocompositeComponentTypes
of thecomponentType
.final Instant
The date and time when the component type was created.final String
The description of the component type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The name of the parent component type that this component type extends.final Map
<String, FunctionResponse> An object that maps strings to the functions in the component type.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the CompositeComponentTypes property.final boolean
For responses, this returns true if the service returned a value for the ExtendsFrom property.final boolean
For responses, this returns true if the service returned a value for the Functions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PropertyDefinitions property.final boolean
For responses, this returns true if the service returned a value for the PropertyGroups property.final Boolean
A Boolean value that specifies whether the component type is abstract.final Boolean
A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.final Boolean
A Boolean value that specifies whether an entity can have more than one component of this type.final Map
<String, PropertyDefinitionResponse> An object that maps strings to the property definitions in the component type.final Map
<String, PropertyGroupResponse> The maximum number of results to return at one time.static Class
<? extends GetComponentTypeResponse.Builder> final Status
status()
The current status of the component type.final String
The syncSource of the SyncJob, if this entity was created by a SyncJob.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The date and time when the component was last updated.final String
The ID of the workspace that contains the component type.Methods inherited from class software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
workspaceId
The ID of the workspace that contains the component type.
- Returns:
- The ID of the workspace that contains the component type.
-
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
The ID of the component type.
- Returns:
- The ID of the component type.
-
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
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
The name of the parent component type that this component type extends.
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:
- The name of the parent component type that this component type extends.
-
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
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.
-
creationDateTime
The date and time when the component type was created.
- Returns:
- The date and time when the component type was created.
-
updateDateTime
The date and time when the component was last updated.
- Returns:
- The date and time when the component was last updated.
-
arn
The ARN of the component type.
- Returns:
- The ARN of the component type.
-
isAbstract
A Boolean value that specifies whether the component type is abstract.
- Returns:
- A Boolean value that specifies whether the component type is abstract.
-
isSchemaInitialized
A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
- Returns:
- A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
-
status
The current status of the component type.
- Returns:
- The current status of 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
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
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:
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
-
syncSource
The syncSource of the SyncJob, if this entity was created by a SyncJob.
- Returns:
- The syncSource of the SyncJob, if this entity was created by a SyncJob.
-
componentTypeName
The component type name.
- Returns:
- The component type name.
-
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
This is an object that maps strings to
compositeComponentTypes
of thecomponentType
.CompositeComponentType
is 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
compositeComponentTypes
of thecomponentType
.CompositeComponentType
is referenced bycomponentTypeId
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetComponentTypeResponse.Builder,
GetComponentTypeResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-