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

Class ComponentRequest

java.lang.Object

software.amazon.awssdk.services.iottwinmaker.model.ComponentRequest

All Implemented Interfaces:

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

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

An object that sets information about a component type create or update request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComponentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ComponentRequest.Builder	builder()
String	componentTypeId()	The ID of the component type.
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	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,PropertyRequest>	properties()	An object that maps strings to the properties to set in the component type.
Map<String,ComponentPropertyGroupRequest>	propertyGroups()	The property groups.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentRequest.Builder>	serializableBuilderClass()
ComponentRequest.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

description

public final String description()

The description of the component request.

Returns:

The description of the component request.

componentTypeId

public final String componentTypeId()

The ID of the component type.

Returns:

The ID of the component type.

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

toBuilder

public ComponentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentRequest.Builder,ComponentRequest>

builder

public static ComponentRequest.Builder builder()

serializableBuilderClass

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