Class ComponentResponse
- java.lang.Object
-
- software.amazon.awssdk.services.iottwinmaker.model.ComponentResponse
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ComponentResponse.Builder,ComponentResponse>
@Generated("software.amazon.awssdk:codegen") public final class ComponentResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ComponentResponse.Builder,ComponentResponse>
An object that returns information about a component type create or update request.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceComponentResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanareAllCompositeComponentsReturned()This flag notes whether allcompositeComponentsare returned in the API response.BooleanareAllPropertiesReturned()This flag notes whether all properties of the component are returned in the API response.static ComponentResponse.Builderbuilder()StringcomponentName()The name of the component.StringcomponentTypeId()The ID of the component type.Map<String,ComponentSummary>compositeComponents()This lists objects that contain information about thecompositeComponents.StringdefinedIn()The name of the property definition set in the request.Stringdescription()The description of the component type.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCompositeComponents()For responses, this returns true if the service returned a value for the CompositeComponents property.inthashCode()booleanhasProperties()For responses, this returns true if the service returned a value for the Properties property.booleanhasPropertyGroups()For responses, this returns true if the service returned a value for the PropertyGroups property.Map<String,PropertyResponse>properties()An object that maps strings to the properties to set in the component type.Map<String,ComponentPropertyGroupResponse>propertyGroups()The property groups.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ComponentResponse.Builder>serializableBuilderClass()Statusstatus()The status of the component type.StringsyncSource()The syncSource of the sync job, if this entity was created by a sync job.ComponentResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
componentName
public final String componentName()
The name of the component.
- Returns:
- The name of the component.
-
description
public final String description()
The description of the component type.
- Returns:
- The description of the component type.
-
componentTypeId
public final String componentTypeId()
The ID of the component type.
- Returns:
- The ID of the component type.
-
status
public final Status status()
The status of the component type.
- Returns:
- The status of the component type.
-
definedIn
public final String definedIn()
The name of the property definition set in the request.
- Returns:
- The name of the property definition set in the request.
-
hasProperties
public final boolean hasProperties()
For responses, this returns true if the service returned a value for the Properties 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.
-
properties
public final Map<String,PropertyResponse> properties()
An object that maps strings to the properties to set 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
hasProperties()method.- Returns:
- An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
-
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,ComponentPropertyGroupResponse> propertyGroups()
The property groups.
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 property groups.
-
syncSource
public final String syncSource()
The syncSource of the sync job, if this entity was created by a sync job.
- Returns:
- The syncSource of the sync job, if this entity was created by a sync job.
-
areAllPropertiesReturned
public final Boolean areAllPropertiesReturned()
This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
- Returns:
- This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
-
hasCompositeComponents
public final boolean hasCompositeComponents()
For responses, this returns true if the service returned a value for the CompositeComponents 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.
-
compositeComponents
public final Map<String,ComponentSummary> compositeComponents()
This lists objects that contain information about the
compositeComponents.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
hasCompositeComponents()method.- Returns:
- This lists objects that contain information about the
compositeComponents.
-
areAllCompositeComponentsReturned
public final Boolean areAllCompositeComponentsReturned()
This flag notes whether all
compositeComponentsare returned in the API response.- Returns:
- This flag notes whether all
compositeComponentsare returned in the API response.
-
toBuilder
public ComponentResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ComponentResponse.Builder,ComponentResponse>
-
builder
public static ComponentResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ComponentResponse.Builder> serializableBuilderClass()
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-