LegalHold (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.backup.model.LegalHold

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LegalHold
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LegalHold()

Constructors
Constructor and Description
`LegalHold()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LegalHold`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCancellationDate()` This is the time in number format when legal hold was cancelled.
`Date`	`getCreationDate()` This is the time in number format when legal hold was created.
`String`	`getDescription()` This is the description of a legal hold.
`String`	`getLegalHoldArn()` This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`String`	`getLegalHoldId()` ID of specific legal hold on one or more recovery points.
`String`	`getStatus()` This is the status of the legal hold.
`String`	`getTitle()` This is the title of a legal hold.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCancellationDate(Date cancellationDate)` This is the time in number format when legal hold was cancelled.
`void`	`setCreationDate(Date creationDate)` This is the time in number format when legal hold was created.
`void`	`setDescription(String description)` This is the description of a legal hold.
`void`	`setLegalHoldArn(String legalHoldArn)` This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`void`	`setLegalHoldId(String legalHoldId)` ID of specific legal hold on one or more recovery points.
`void`	`setStatus(String status)` This is the status of the legal hold.
`void`	`setTitle(String title)` This is the title of a legal hold.
`String`	`toString()` Returns a string representation of this object.
`LegalHold`	`withCancellationDate(Date cancellationDate)` This is the time in number format when legal hold was cancelled.
`LegalHold`	`withCreationDate(Date creationDate)` This is the time in number format when legal hold was created.
`LegalHold`	`withDescription(String description)` This is the description of a legal hold.
`LegalHold`	`withLegalHoldArn(String legalHoldArn)` This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`LegalHold`	`withLegalHoldId(String legalHoldId)` ID of specific legal hold on one or more recovery points.
`LegalHold`	`withStatus(LegalHoldStatus status)` This is the status of the legal hold.
`LegalHold`	`withStatus(String status)` This is the status of the legal hold.
`LegalHold`	`withTitle(String title)` This is the title of a legal hold.

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

- Constructor Detail
  - LegalHold
```
public LegalHold()
```
- Method Detail
  - setTitle
```
public void setTitle(String title)
```
    This is the title of a legal hold.
    
    Parameters:
    
    title - This is the title of a legal hold.
  - getTitle
```
public String getTitle()
```
    This is the title of a legal hold.
    
    Returns:
    
    This is the title of a legal hold.
  - withTitle
```
public LegalHold withTitle(String title)
```
    This is the title of a legal hold.
    
    Parameters:
    
    title - This is the title of a legal hold.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
    
    Parameters:
    
    status - This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
    
    See Also:
    
    LegalHoldStatus
  - getStatus
```
public String getStatus()
```
    This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
    
    Returns:
    
    This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
    
    See Also:
    
    LegalHoldStatus
  - withStatus
```
public LegalHold withStatus(String status)
```
    This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
    
    Parameters:
    
    status - This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LegalHoldStatus
  - withStatus
```
public LegalHold withStatus(LegalHoldStatus status)
```
    This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
    
    Parameters:
    
    status - This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LegalHoldStatus
  - setDescription
```
public void setDescription(String description)
```
    This is the description of a legal hold.
    
    Parameters:
    
    description - This is the description of a legal hold.
  - getDescription
```
public String getDescription()
```
    This is the description of a legal hold.
    
    Returns:
    
    This is the description of a legal hold.
  - withDescription
```
public LegalHold withDescription(String description)
```
    This is the description of a legal hold.
    
    Parameters:
    
    description - This is the description of a legal hold.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLegalHoldId
```
public void setLegalHoldId(String legalHoldId)
```
    ID of specific legal hold on one or more recovery points.
    
    Parameters:
    
    legalHoldId - ID of specific legal hold on one or more recovery points.
  - getLegalHoldId
```
public String getLegalHoldId()
```
    ID of specific legal hold on one or more recovery points.
    
    Returns:
    
    ID of specific legal hold on one or more recovery points.
  - withLegalHoldId
```
public LegalHold withLegalHoldId(String legalHoldId)
```
    ID of specific legal hold on one or more recovery points.
    
    Parameters:
    
    legalHoldId - ID of specific legal hold on one or more recovery points.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLegalHoldArn
```
public void setLegalHoldArn(String legalHoldArn)
```
    This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Parameters:
    
    legalHoldArn - This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
  - getLegalHoldArn
```
public String getLegalHoldArn()
```
    This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Returns:
    
    This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
  - withLegalHoldArn
```
public LegalHold withLegalHoldArn(String legalHoldArn)
```
    This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Parameters:
    
    legalHoldArn - This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    This is the time in number format when legal hold was created.
    
    Parameters:
    
    creationDate - This is the time in number format when legal hold was created.
  - getCreationDate
```
public Date getCreationDate()
```
    This is the time in number format when legal hold was created.
    
    Returns:
    
    This is the time in number format when legal hold was created.
  - withCreationDate
```
public LegalHold withCreationDate(Date creationDate)
```
    This is the time in number format when legal hold was created.
    
    Parameters:
    
    creationDate - This is the time in number format when legal hold was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCancellationDate
```
public void setCancellationDate(Date cancellationDate)
```
    This is the time in number format when legal hold was cancelled.
    
    Parameters:
    
    cancellationDate - This is the time in number format when legal hold was cancelled.
  - getCancellationDate
```
public Date getCancellationDate()
```
    This is the time in number format when legal hold was cancelled.
    
    Returns:
    
    This is the time in number format when legal hold was cancelled.
  - withCancellationDate
```
public LegalHold withCancellationDate(Date cancellationDate)
```
    This is the time in number format when legal hold was cancelled.
    
    Parameters:
    
    cancellationDate - This is the time in number format when legal hold was cancelled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 LegalHold 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.778

Class LegalHold

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LegalHold

Method Detail

setTitle

getTitle

withTitle

setStatus

getStatus

withStatus

withStatus

setDescription

getDescription

withDescription

setLegalHoldId

getLegalHoldId

withLegalHoldId

setLegalHoldArn

getLegalHoldArn

withLegalHoldArn

setCreationDate

getCreationDate

withCreationDate

setCancellationDate

getCancellationDate

withCancellationDate

toString

equals

hashCode

clone

marshall