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

Class ComponentCandidate

java.lang.Object

software.amazon.awssdk.services.greengrassv2.model.ComponentCandidate

All Implemented Interfaces:

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

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

Contains information about a component that is a candidate to deploy to a Greengrass core device.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComponentCandidate.Builder

Method Summary

Modifier and Type	Method	Description
static ComponentCandidate.Builder	builder()
String	componentName()	The name of the component.
String	componentVersion()	The version of the component.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVersionRequirements()	For responses, this returns true if the service returned a value for the VersionRequirements property.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentCandidate.Builder>	serializableBuilderClass()
ComponentCandidate.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Map<String,String>	versionRequirements()	The version requirements for the component's dependencies.

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.

componentVersion

public final String componentVersion()

The version of the component.

Returns:

The version of the component.

hasVersionRequirements

public final boolean hasVersionRequirements()

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

versionRequirements

public final Map<String,String> versionRequirements()

The version requirements for the component's dependencies. Greengrass core devices get the version requirements from component recipes.

IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.

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

Returns:

The version requirements for the component's dependencies. Greengrass core devices get the version requirements from component recipes.

IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.

toBuilder

public ComponentCandidate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentCandidate.Builder,ComponentCandidate>

builder

public static ComponentCandidate.Builder builder()

serializableBuilderClass

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