com.amazonaws.services.greengrassv2.model

Class CloudComponentStatus

java.lang.Object

com.amazonaws.services.greengrassv2.model.CloudComponentStatus

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CloudComponentStatus
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CloudComponentStatus()

Method Summary

Modifier and Type	Method and Description
CloudComponentStatus	addErrorsEntry(String key, String value) Add a single Errors entry
CloudComponentStatus	clearErrorsEntries() Removes all the entries added into Errors.
CloudComponentStatus	clone()
boolean	equals(Object obj)
String	getComponentState() The state of the component version.
Map<String,String>	getErrors() A dictionary of errors that communicate why the component version is in an error state.
String	getMessage() A message that communicates details, such as errors, about the status of the component version.
String	getVendorGuidance() The vendor guidance state for the component version.
String	getVendorGuidanceMessage() A message that communicates details about the vendor guidance state of the component version.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setComponentState(String componentState) The state of the component version.
void	setErrors(Map<String,String> errors) A dictionary of errors that communicate why the component version is in an error state.
void	setMessage(String message) A message that communicates details, such as errors, about the status of the component version.
void	setVendorGuidance(String vendorGuidance) The vendor guidance state for the component version.
void	setVendorGuidanceMessage(String vendorGuidanceMessage) A message that communicates details about the vendor guidance state of the component version.
String	toString() Returns a string representation of this object.
CloudComponentStatus	withComponentState(CloudComponentState componentState) The state of the component version.
CloudComponentStatus	withComponentState(String componentState) The state of the component version.
CloudComponentStatus	withErrors(Map<String,String> errors) A dictionary of errors that communicate why the component version is in an error state.
CloudComponentStatus	withMessage(String message) A message that communicates details, such as errors, about the status of the component version.
CloudComponentStatus	withVendorGuidance(String vendorGuidance) The vendor guidance state for the component version.
CloudComponentStatus	withVendorGuidance(VendorGuidance vendorGuidance) The vendor guidance state for the component version.
CloudComponentStatus	withVendorGuidanceMessage(String vendorGuidanceMessage) A message that communicates details about the vendor guidance state of the component version.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CloudComponentStatus

public CloudComponentStatus()

Method Detail

setComponentState

public void setComponentState(String componentState)

The state of the component version.

Parameters:

componentState - The state of the component version.

See Also:

CloudComponentState

getComponentState

public String getComponentState()

The state of the component version.

Returns:

The state of the component version.

See Also:

CloudComponentState

withComponentState

public CloudComponentStatus withComponentState(String componentState)

The state of the component version.

Parameters:

componentState - The state of the component version.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CloudComponentState

withComponentState

public CloudComponentStatus withComponentState(CloudComponentState componentState)

The state of the component version.

Parameters:

componentState - The state of the component version.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CloudComponentState

setMessage

public void setMessage(String message)

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

Parameters:

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

getMessage

public String getMessage()

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.

withMessage

public CloudComponentStatus withMessage(String message)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getErrors

public Map<String,String> getErrors()

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.

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.

setErrors

public void setErrors(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.

Parameters:

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.

withErrors

public CloudComponentStatus withErrors(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addErrorsEntry

public CloudComponentStatus addErrorsEntry(String key,
                                           String value)

Add a single Errors entry

See Also:

withErrors(java.util.Map<java.lang.String, java.lang.String>)

clearErrorsEntries

public CloudComponentStatus clearErrorsEntries()

Removes all the entries added into Errors.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVendorGuidance

public void setVendorGuidance(String 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.

Parameters:

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.

See Also:

VendorGuidance

getVendorGuidance

public String getVendorGuidance()

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.

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

withVendorGuidance

public CloudComponentStatus withVendorGuidance(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VendorGuidance

withVendorGuidance

public CloudComponentStatus withVendorGuidance(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VendorGuidance

setVendorGuidanceMessage

public void setVendorGuidanceMessage(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.

Parameters:

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.

getVendorGuidanceMessage

public String getVendorGuidanceMessage()

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.

withVendorGuidanceMessage

public CloudComponentStatus withVendorGuidanceMessage(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CloudComponentStatus clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo