Class DeploymentPolicies

java.lang.Object
software.amazon.awssdk.services.greengrassv2.model.DeploymentPolicies
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DeploymentPolicies.Builder,DeploymentPolicies>
@Generated("software.amazon.awssdk:codegen") public final class DeploymentPolicies extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DeploymentPolicies.Builder,DeploymentPolicies>

Contains information about policies that define how a deployment updates components and handles failure.

See Also:

  • Method Details

    • failureHandlingPolicy

      public final DeploymentFailureHandlingPolicy failureHandlingPolicy()

      The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.

      Default: ROLLBACK

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

      Returns:
      The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.

      Default: ROLLBACK

      See Also:

    • failureHandlingPolicyAsString

      public final String failureHandlingPolicyAsString()

      The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.

      Default: ROLLBACK

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

      Returns:
      The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.

      Default: ROLLBACK

      See Also:

    • componentUpdatePolicy

      public final DeploymentComponentUpdatePolicy componentUpdatePolicy()

      The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.

      Returns:
      The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.

    • configurationValidationPolicy

      public final DeploymentConfigurationValidationPolicy configurationValidationPolicy()

      The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.

      Returns:
      The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.

    • toBuilder

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

    • builder

      public static DeploymentPolicies.Builder builder()

    • serializableBuilderClass

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