software.amazon.awssdk.services.iottwinmaker.model

Class ComponentResponse

java.lang.Object

software.amazon.awssdk.services.iottwinmaker.model.ComponentResponse

All Implemented Interfaces:

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

@Generated(value="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 and Description
static interface	ComponentResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ComponentResponse.Builder	builder()
String	componentName() The name of the 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 type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProperties() For responses, this returns true if the service returned a value for the Properties property.
boolean	hasPropertyGroups() 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.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentResponse.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.
ComponentResponse.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.

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

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

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.

toBuilder

public ComponentResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentResponse.Builder,ComponentResponse>

builder

public static ComponentResponse.Builder builder()

serializableBuilderClass

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