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

Class EffectiveDeployment

java.lang.Object

software.amazon.awssdk.services.greengrassv2.model.EffectiveDeployment

All Implemented Interfaces:

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

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

Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EffectiveDeployment.Builder

Method Summary

Modifier and Type	Method	Description
static EffectiveDeployment.Builder	builder()
EffectiveDeploymentExecutionStatus	coreDeviceExecutionStatus()	The status of the deployment job on the Greengrass core device.
String	coreDeviceExecutionStatusAsString()	The status of the deployment job on the Greengrass core device.
Instant	creationTimestamp()	The time at which the deployment was created, expressed in ISO 8601 format.
String	deploymentId()	The ID of the deployment.
String	deploymentName()	The name of the deployment.
String	description()	The description of the deployment job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iotJobArn()	The ARN of the IoT job that applies the deployment to target devices.
String	iotJobId()	The ID of the IoT job that applies the deployment to target devices.
Instant	modifiedTimestamp()	The time at which the deployment job was last modified, expressed in ISO 8601 format.
String	reason()	The reason code for the update, if the job was updated.
List<SdkField<?>>	sdkFields()
static Class<? extends EffectiveDeployment.Builder>	serializableBuilderClass()
EffectiveDeploymentStatusDetails	statusDetails()	The status details that explain why a deployment has an error.
String	targetArn()	The ARN of the target IoT thing or thing group.
EffectiveDeployment.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

deploymentId

public final String deploymentId()

The ID of the deployment.

Returns:

The ID of the deployment.

deploymentName

public final String deploymentName()

The name of the deployment.

Returns:

The name of the deployment.

iotJobId

public final String 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

public final String 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

public final String description()

The description of the deployment job.

Returns:

The description of the deployment job.

targetArn

public final String targetArn()

The ARN of the target IoT thing or thing group.

Returns:

The ARN of the target IoT thing or thing group.

coreDeviceExecutionStatus

public final EffectiveDeploymentExecutionStatus 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 the statusDetails 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 the statusDetails 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 return EffectiveDeploymentExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from coreDeviceExecutionStatusAsString().

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 the statusDetails 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 the statusDetails field.

• SUCCEEDED – The deployment to an IoT thing group was completed successfully.

See Also:

EffectiveDeploymentExecutionStatus

coreDeviceExecutionStatusAsString

public final String 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 the statusDetails 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 the statusDetails 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 return EffectiveDeploymentExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from coreDeviceExecutionStatusAsString().

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 the statusDetails 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 the statusDetails field.

• SUCCEEDED – The deployment to an IoT thing group was completed successfully.

See Also:

EffectiveDeploymentExecutionStatus

reason

public final String 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

public final Instant 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

public final Instant 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

public final EffectiveDeploymentStatusDetails 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

public EffectiveDeployment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EffectiveDeployment.Builder,EffectiveDeployment>

builder

public static EffectiveDeployment.Builder builder()

serializableBuilderClass

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