Package software.amazon.awssdk.services.iottwinmaker.model

Class ComponentSummary

java.lang.Object

software.amazon.awssdk.services.iottwinmaker.model.ComponentSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ComponentSummary.Builder,ComponentSummary>

@Generated("software.amazon.awssdk:codegen")
public final class ComponentSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ComponentSummary.Builder,ComponentSummary>

An object that returns information about a component summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComponentSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ComponentSummary.Builder	builder()
String	componentName()	The name of the component.
String	componentPath()	This string specifies the path to the composite component, starting from the top-level component.
String	componentTypeId()	The ID of the component type.
String	definedIn()	The name of the property definition set in the request.
String	description()	The description of the component request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPropertyGroups()	For responses, this returns true if the service returned a value for the PropertyGroups property.
Map<String,ComponentPropertyGroupResponse>	propertyGroups()	The property groups.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentSummary.Builder>	serializableBuilderClass()
Status	status()	The status of the component type.
String	syncSource()	The syncSource of the sync job, if this entity was created by a sync job.
ComponentSummary.Builder	toBuilder()
String	toString()	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.

componentTypeId

public final String componentTypeId()

The ID of the component type.

Returns:

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

description

public final String description()

The description of the component request.

Returns:

The description of the component request.

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

status

public final Status status()

The status of the component type.

Returns:

The status of the component type.

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.

componentPath

public final String componentPath()

This string specifies the path to the composite component, starting from the top-level component.

Returns:

This string specifies the path to the composite component, starting from the top-level component.

toBuilder

public ComponentSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentSummary.Builder,ComponentSummary>

builder

public static ComponentSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo