Class BulkDeploymentResult

java.lang.Object
software.amazon.awssdk.services.greengrass.model.BulkDeploymentResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BulkDeploymentResult.Builder,BulkDeploymentResult>
@Generated("software.amazon.awssdk:codegen") public final class BulkDeploymentResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BulkDeploymentResult.Builder,BulkDeploymentResult>
Information about an individual group deployment in a bulk deployment operation.
See Also:

  • Method Details

    • createdAt

      public final String createdAt()
      The time, in ISO format, when the deployment was created.
      Returns:
      The time, in ISO format, when the deployment was created.

    • deploymentArn

      public final String deploymentArn()
      The ARN of the group deployment.
      Returns:
      The ARN of the group deployment.

    • deploymentId

      public final String deploymentId()
      The ID of the group deployment.
      Returns:
      The ID of the group deployment.

    • deploymentStatus

      public final String deploymentStatus()
      The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
      Returns:
      The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.

    • deploymentType

      public final DeploymentType deploymentType()
      The type of the deployment.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

      Returns:
      The type of the deployment.
      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()
      The type of the deployment.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

      Returns:
      The type of the deployment.
      See Also:

    • hasErrorDetails

      public final boolean hasErrorDetails()
      For responses, this returns true if the service returned a value for the ErrorDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • errorDetails

      public final List<ErrorDetail> errorDetails()
      Details about the error.

      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 hasErrorDetails() method.

      Returns:
      Details about the error.

    • errorMessage

      public final String errorMessage()
      The error message for a failed deployment
      Returns:
      The error message for a failed deployment

    • groupArn

      public final String groupArn()
      The ARN of the Greengrass group.
      Returns:
      The ARN of the Greengrass group.

    • toBuilder

      public BulkDeploymentResult.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<BulkDeploymentResult.Builder,BulkDeploymentResult>
      Returns:
      a builder for type T

    • builder

      public static BulkDeploymentResult.Builder builder()

    • serializableBuilderClass

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