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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<EffectiveDeployment.Builder,EffectiveDeployment>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.