DeploymentComponentUpdatePolicy (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.greengrassv2.model.DeploymentComponentUpdatePolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeploymentComponentUpdatePolicy
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DeploymentComponentUpdatePolicy()

Constructors
Constructor and Description
`DeploymentComponentUpdatePolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeploymentComponentUpdatePolicy`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` Whether or not to notify components and wait for components to become safe to update.
`Integer`	`getTimeoutInSeconds()` The amount of time in seconds that each component on a device has to report that it's safe to update.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(String action)` Whether or not to notify components and wait for components to become safe to update.
`void`	`setTimeoutInSeconds(Integer timeoutInSeconds)` The amount of time in seconds that each component on a device has to report that it's safe to update.
`String`	`toString()` Returns a string representation of this object.
`DeploymentComponentUpdatePolicy`	`withAction(DeploymentComponentUpdatePolicyAction action)` Whether or not to notify components and wait for components to become safe to update.
`DeploymentComponentUpdatePolicy`	`withAction(String action)` Whether or not to notify components and wait for components to become safe to update.
`DeploymentComponentUpdatePolicy`	`withTimeoutInSeconds(Integer timeoutInSeconds)` The amount of time in seconds that each component on a device has to report that it's safe to update.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DeploymentComponentUpdatePolicy
```
public DeploymentComponentUpdatePolicy()
```
- Method Detail
  - setTimeoutInSeconds
```
public void setTimeoutInSeconds(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
    
    Parameters:
    
    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
  - getTimeoutInSeconds
```
public Integer getTimeoutInSeconds()
```
    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
  - withTimeoutInSeconds
```
public DeploymentComponentUpdatePolicy withTimeoutInSeconds(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(String 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
    Parameters:
    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
    See Also:
    
    DeploymentComponentUpdatePolicyAction
  - getAction
```
public String getAction()
```
    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
    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
  - withAction
```
public DeploymentComponentUpdatePolicy withAction(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentComponentUpdatePolicyAction
  - withAction
```
public DeploymentComponentUpdatePolicy withAction(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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentComponentUpdatePolicyAction
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DeploymentComponentUpdatePolicy clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class DeploymentComponentUpdatePolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeploymentComponentUpdatePolicy

Method Detail

setTimeoutInSeconds

getTimeoutInSeconds

withTimeoutInSeconds

setAction

getAction

withAction

withAction

toString

equals

hashCode

clone

marshall