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

Class CloudComponentStatus

java.lang.Object

software.amazon.awssdk.services.greengrassv2.model.CloudComponentStatus

All Implemented Interfaces:

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

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

Contains the status of a component version in the IoT Greengrass service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CloudComponentStatus.Builder

Method Summary

Modifier and Type	Method	Description
static CloudComponentStatus.Builder	builder()
CloudComponentState	componentState()	The state of the component version.
String	componentStateAsString()	The state of the component version.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,String>	errors()	A dictionary of errors that communicate why the component version is in an error state.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrors()	For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
String	message()	A message that communicates details, such as errors, about the status of the component version.
List<SdkField<?>>	sdkFields()
static Class<? extends CloudComponentStatus.Builder>	serializableBuilderClass()
CloudComponentStatus.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VendorGuidance	vendorGuidance()	The vendor guidance state for the component version.
String	vendorGuidanceAsString()	The vendor guidance state for the component version.
String	vendorGuidanceMessage()	A message that communicates details about the vendor guidance state of the component version.

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

componentState

public final CloudComponentState componentState()

The state of the component version.

If the service returns an enum value that is not available in the current SDK version, componentState will return CloudComponentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from componentStateAsString().

Returns:

The state of the component version.

See Also:

CloudComponentState

componentStateAsString

public final String componentStateAsString()

The state of the component version.

If the service returns an enum value that is not available in the current SDK version, componentState will return CloudComponentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from componentStateAsString().

Returns:

The state of the component version.

See Also:

CloudComponentState

message

public final String message()

A message that communicates details, such as errors, about the status of the component version.

Returns:

A message that communicates details, such as errors, about the status of the component version.

hasErrors

public final boolean hasErrors()

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

errors

public final Map<String,String> errors()

A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

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

Returns:

A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

vendorGuidance

public final VendorGuidance vendorGuidance()

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

• ACTIVE – This component version is available and recommended for use.

• DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

• DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

If the service returns an enum value that is not available in the current SDK version, vendorGuidance will return VendorGuidance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vendorGuidanceAsString().

Returns:

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

• ACTIVE – This component version is available and recommended for use.

• DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

• DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

See Also:

VendorGuidance

vendorGuidanceAsString

public final String vendorGuidanceAsString()

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

• ACTIVE – This component version is available and recommended for use.

• DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

• DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

If the service returns an enum value that is not available in the current SDK version, vendorGuidance will return VendorGuidance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vendorGuidanceAsString().

Returns:

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

• ACTIVE – This component version is available and recommended for use.

• DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

• DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

See Also:

VendorGuidance

vendorGuidanceMessage

public final String vendorGuidanceMessage()

A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

Returns:

A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

toBuilder

public CloudComponentStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CloudComponentStatus.Builder,CloudComponentStatus>

builder

public static CloudComponentStatus.Builder builder()

serializableBuilderClass

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