Package software.amazon.awssdk.services.greengrassv2.model

Class ComponentPlatform

java.lang.Object

software.amazon.awssdk.services.greengrassv2.model.ComponentPlatform

All Implemented Interfaces:

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

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

Contains information about a platform that a component supports.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComponentPlatform.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	A dictionary of attributes for the platform.
static ComponentPlatform.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes()	For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
String	name()	The friendly name of the platform.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentPlatform.Builder>	serializableBuilderClass()
ComponentPlatform.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

name

public final String name()

The friendly name of the platform. This name helps you identify the platform.

If you omit this parameter, IoT Greengrass creates a friendly name from the os and architecture of the platform.

Returns:

The friendly name of the platform. This name helps you identify the platform.

If you omit this parameter, IoT Greengrass creates a friendly name from the os and architecture of the platform.

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes 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.

attributes

public final Map<String,String> attributes()

A dictionary of attributes for the platform. The IoT Greengrass Core software defines the os and architecture by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.

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 hasAttributes() method.

Returns:

A dictionary of attributes for the platform. The IoT Greengrass Core software defines the os and architecture by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.

toBuilder

public ComponentPlatform.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentPlatform.Builder,ComponentPlatform>

builder

public static ComponentPlatform.Builder builder()

serializableBuilderClass

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