Class CloudComponentStatus
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CloudComponentStatus.Builder,
CloudComponentStatus>
Contains the status of a component version in the IoT Greengrass service.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CloudComponentStatus.Builder
builder()
final CloudComponentState
The state of the component version.final String
The state of the component version.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.errors()
A dictionary of errors that communicate why the component version is in an error state.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Errors property.final int
hashCode()
final String
message()
A message that communicates details, such as errors, about the status of the component version.static Class
<? extends CloudComponentStatus.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VendorGuidance
The vendor guidance state for the component version.final String
The vendor guidance state for the component version.final String
A message that communicates details about the vendor guidance state of the component version.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnCloudComponentState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomponentStateAsString()
.- Returns:
- The state of the component version.
- See Also:
-
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 returnCloudComponentState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomponentStateAsString()
.- Returns:
- The state of the component version.
- See Also:
-
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 theisEmpty()
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
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
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 returnVendorGuidance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvendorGuidanceAsString()
.- 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:
-
-
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 returnVendorGuidance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvendorGuidanceAsString()
.- 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:
-
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CloudComponentStatus.Builder,
CloudComponentStatus> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-