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

Class DeploymentComponentUpdatePolicy

java.lang.Object

software.amazon.awssdk.services.greengrassv2.model.DeploymentComponentUpdatePolicy

All Implemented Interfaces:

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

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

Contains information about a deployment's policy that defines when components are safe to update.

Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeploymentComponentUpdatePolicy.Builder

Method Summary

Modifier and Type	Method	Description
DeploymentComponentUpdatePolicyAction	action()	Whether or not to notify components and wait for components to become safe to update.
String	actionAsString()	Whether or not to notify components and wait for components to become safe to update.
static DeploymentComponentUpdatePolicy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DeploymentComponentUpdatePolicy.Builder>	serializableBuilderClass()
Integer	timeoutInSeconds()	The amount of time in seconds that each component on a device has to report that it's safe to update.
DeploymentComponentUpdatePolicy.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

timeoutInSeconds

public final Integer timeoutInSeconds()

The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.

Default: 60

Returns:

The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.

Default: 60

action

public final DeploymentComponentUpdatePolicyAction action()

Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

• NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.

• SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

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

Returns:

Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

• NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.

• SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

See Also:

DeploymentComponentUpdatePolicyAction

actionAsString

public final String actionAsString()

Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

• NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.

• SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

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

Returns:

Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

• NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.

• SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

See Also:

DeploymentComponentUpdatePolicyAction

toBuilder

public DeploymentComponentUpdatePolicy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeploymentComponentUpdatePolicy.Builder,DeploymentComponentUpdatePolicy>

builder

public static DeploymentComponentUpdatePolicy.Builder builder()

serializableBuilderClass

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