Class EffectiveDeployment
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EffectiveDeployment.Builder,
EffectiveDeployment>
Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EffectiveDeployment.Builder
builder()
The status of the deployment job on the Greengrass core device.final String
The status of the deployment job on the Greengrass core device.final Instant
The time at which the deployment was created, expressed in ISO 8601 format.final String
The ID of the deployment.final String
The name of the deployment.final String
The description of the deployment job.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The ARN of the IoT job that applies the deployment to target devices.final String
iotJobId()
The ID of the IoT job that applies the deployment to target devices.final Instant
The time at which the deployment job was last modified, expressed in ISO 8601 format.final String
reason()
The reason code for the update, if the job was updated.static Class
<? extends EffectiveDeployment.Builder> The status details that explain why a deployment has an error.final String
The ARN of the target IoT thing or thing group.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
deploymentId
The ID of the deployment.
- Returns:
- The ID of the deployment.
-
deploymentName
The name of the deployment.
- Returns:
- The name of the deployment.
-
iotJobId
The ID of the IoT job that applies the deployment to target devices.
- Returns:
- The ID of the IoT job that applies the deployment to target devices.
-
iotJobArn
The ARN of the IoT job that applies the deployment to target devices.
- Returns:
- The ARN of the IoT job that applies the deployment to target devices.
-
description
The description of the deployment job.
- Returns:
- The description of the deployment job.
-
targetArn
The ARN of the target IoT thing or thing group.
- Returns:
- The ARN of the target IoT thing or thing group.
-
coreDeviceExecutionStatus
The status of the deployment job on the Greengrass core device.
-
IN_PROGRESS
– The deployment job is running. -
QUEUED
– The deployment job is in the job queue and waiting to run. -
FAILED
– The deployment failed. For more information, see thestatusDetails
field. -
COMPLETED
– The deployment to an IoT thing was completed successfully. -
TIMED_OUT
– The deployment didn't complete in the allotted time. -
CANCELED
– The deployment was canceled by the user. -
REJECTED
– The deployment was rejected. For more information, see thestatusDetails
field. -
SUCCEEDED
– The deployment to an IoT thing group was completed successfully.
If the service returns an enum value that is not available in the current SDK version,
coreDeviceExecutionStatus
will returnEffectiveDeploymentExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcoreDeviceExecutionStatusAsString()
.- Returns:
- The status of the deployment job on the Greengrass core device.
-
IN_PROGRESS
– The deployment job is running. -
QUEUED
– The deployment job is in the job queue and waiting to run. -
FAILED
– The deployment failed. For more information, see thestatusDetails
field. -
COMPLETED
– The deployment to an IoT thing was completed successfully. -
TIMED_OUT
– The deployment didn't complete in the allotted time. -
CANCELED
– The deployment was canceled by the user. -
REJECTED
– The deployment was rejected. For more information, see thestatusDetails
field. -
SUCCEEDED
– The deployment to an IoT thing group was completed successfully.
-
- See Also:
-
-
coreDeviceExecutionStatusAsString
The status of the deployment job on the Greengrass core device.
-
IN_PROGRESS
– The deployment job is running. -
QUEUED
– The deployment job is in the job queue and waiting to run. -
FAILED
– The deployment failed. For more information, see thestatusDetails
field. -
COMPLETED
– The deployment to an IoT thing was completed successfully. -
TIMED_OUT
– The deployment didn't complete in the allotted time. -
CANCELED
– The deployment was canceled by the user. -
REJECTED
– The deployment was rejected. For more information, see thestatusDetails
field. -
SUCCEEDED
– The deployment to an IoT thing group was completed successfully.
If the service returns an enum value that is not available in the current SDK version,
coreDeviceExecutionStatus
will returnEffectiveDeploymentExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcoreDeviceExecutionStatusAsString()
.- Returns:
- The status of the deployment job on the Greengrass core device.
-
IN_PROGRESS
– The deployment job is running. -
QUEUED
– The deployment job is in the job queue and waiting to run. -
FAILED
– The deployment failed. For more information, see thestatusDetails
field. -
COMPLETED
– The deployment to an IoT thing was completed successfully. -
TIMED_OUT
– The deployment didn't complete in the allotted time. -
CANCELED
– The deployment was canceled by the user. -
REJECTED
– The deployment was rejected. For more information, see thestatusDetails
field. -
SUCCEEDED
– The deployment to an IoT thing group was completed successfully.
-
- See Also:
-
-
reason
The reason code for the update, if the job was updated.
- Returns:
- The reason code for the update, if the job was updated.
-
creationTimestamp
The time at which the deployment was created, expressed in ISO 8601 format.
- Returns:
- The time at which the deployment was created, expressed in ISO 8601 format.
-
modifiedTimestamp
The time at which the deployment job was last modified, expressed in ISO 8601 format.
- Returns:
- The time at which the deployment job was last modified, expressed in ISO 8601 format.
-
statusDetails
The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.
- Returns:
- The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.
-
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<EffectiveDeployment.Builder,
EffectiveDeployment> - 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
-