Snapshot (AWS SDK for Java 1.8.9 API)

java.lang.Object
- com.amazonaws.services.ec2.model.Snapshot

All Implemented Interfaces:

Serializable
```
public class Snapshot
extends Object
implements Serializable
```
Describes a snapshot.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Snapshot()

Constructors
Constructor and Description
`Snapshot()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getDescription()` The description for the snapshot.
`Boolean`	`getEncrypted()` Indicates whether the snapshot is encrypted.
`String`	`getOwnerAlias()` The AWS account alias (for example, `amazon`, `self`) or AWS account ID that owns the snapshot.
`String`	`getOwnerId()` The AWS account ID of the Amazon EBS snapshot owner.
`String`	`getProgress()` The progress of the snapshot, as a percentage.
`String`	`getSnapshotId()` The ID of the snapshot.
`Date`	`getStartTime()` The time stamp when the snapshot was initiated.
`String`	`getState()` The snapshot state.
`List<Tag>`	`getTags()` Any tags assigned to the snapshot.
`String`	`getVolumeId()` The ID of the volume.
`Integer`	`getVolumeSize()` The size of the volume, in GiB.
`int`	`hashCode()`
`Boolean`	`isEncrypted()` Indicates whether the snapshot is encrypted.
`void`	`setDescription(String description)` The description for the snapshot.
`void`	`setEncrypted(Boolean encrypted)` Indicates whether the snapshot is encrypted.
`void`	`setOwnerAlias(String ownerAlias)` The AWS account alias (for example, `amazon`, `self`) or AWS account ID that owns the snapshot.
`void`	`setOwnerId(String ownerId)` The AWS account ID of the Amazon EBS snapshot owner.
`void`	`setProgress(String progress)` The progress of the snapshot, as a percentage.
`void`	`setSnapshotId(String snapshotId)` The ID of the snapshot.
`void`	`setStartTime(Date startTime)` The time stamp when the snapshot was initiated.
`void`	`setState(SnapshotState state)` The snapshot state.
`void`	`setState(String state)` The snapshot state.
`void`	`setTags(Collection<Tag> tags)` Any tags assigned to the snapshot.
`void`	`setVolumeId(String volumeId)` The ID of the volume.
`void`	`setVolumeSize(Integer volumeSize)` The size of the volume, in GiB.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Snapshot`	`withDescription(String description)` The description for the snapshot.
`Snapshot`	`withEncrypted(Boolean encrypted)` Indicates whether the snapshot is encrypted.
`Snapshot`	`withOwnerAlias(String ownerAlias)` The AWS account alias (for example, `amazon`, `self`) or AWS account ID that owns the snapshot.
`Snapshot`	`withOwnerId(String ownerId)` The AWS account ID of the Amazon EBS snapshot owner.
`Snapshot`	`withProgress(String progress)` The progress of the snapshot, as a percentage.
`Snapshot`	`withSnapshotId(String snapshotId)` The ID of the snapshot.
`Snapshot`	`withStartTime(Date startTime)` The time stamp when the snapshot was initiated.
`Snapshot`	`withState(SnapshotState state)` The snapshot state.
`Snapshot`	`withState(String state)` The snapshot state.
`Snapshot`	`withTags(Collection<Tag> tags)` Any tags assigned to the snapshot.
`Snapshot`	`withTags(Tag... tags)` Any tags assigned to the snapshot.
`Snapshot`	`withVolumeId(String volumeId)` The ID of the volume.
`Snapshot`	`withVolumeSize(Integer volumeSize)` The size of the volume, in GiB.

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

- Constructor Detail
  - Snapshot
```
public Snapshot()
```
- Method Detail
  - getSnapshotId
```
public String getSnapshotId()
```
    The ID of the snapshot.
    
    Returns:
    The ID of the snapshot.
  - setSnapshotId
```
public void setSnapshotId(String snapshotId)
```
    The ID of the snapshot.
    
    Parameters:
    snapshotId - The ID of the snapshot.
  - withSnapshotId
```
public Snapshot withSnapshotId(String snapshotId)
```
    The ID of the snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    snapshotId - The ID of the snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getVolumeId
```
public String getVolumeId()
```
    The ID of the volume.
    
    Returns:
    The ID of the volume.
  - setVolumeId
```
public void setVolumeId(String volumeId)
```
    The ID of the volume.
    
    Parameters:
    volumeId - The ID of the volume.
  - withVolumeId
```
public Snapshot withVolumeId(String volumeId)
```
    The ID of the volume.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    volumeId - The ID of the volume.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getState
```
public String getState()
```
    The snapshot state.
    Constraints:
    Allowed Values: pending, completed, error
    
    Returns:
    The snapshot state.
    See Also:
    SnapshotState
  - setState
```
public void setState(String state)
```
    The snapshot state.
    Constraints:
    Allowed Values: pending, completed, error
    
    Parameters:
    state - The snapshot state.
    See Also:
    SnapshotState
  - withState
```
public Snapshot withState(String state)
```
    The snapshot state.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: pending, completed, error
    
    Parameters:
    state - The snapshot state.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    SnapshotState
  - setState
```
public void setState(SnapshotState state)
```
    The snapshot state.
    Constraints:
    Allowed Values: pending, completed, error
    
    Parameters:
    state - The snapshot state.
    See Also:
    SnapshotState
  - withState
```
public Snapshot withState(SnapshotState state)
```
    The snapshot state.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: pending, completed, error
    
    Parameters:
    state - The snapshot state.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    SnapshotState
  - getStartTime
```
public Date getStartTime()
```
    The time stamp when the snapshot was initiated.
    
    Returns:
    The time stamp when the snapshot was initiated.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The time stamp when the snapshot was initiated.
    
    Parameters:
    startTime - The time stamp when the snapshot was initiated.
  - withStartTime
```
public Snapshot withStartTime(Date startTime)
```
    The time stamp when the snapshot was initiated.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    startTime - The time stamp when the snapshot was initiated.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getProgress
```
public String getProgress()
```
    The progress of the snapshot, as a percentage.
    
    Returns:
    The progress of the snapshot, as a percentage.
  - setProgress
```
public void setProgress(String progress)
```
    The progress of the snapshot, as a percentage.
    
    Parameters:
    progress - The progress of the snapshot, as a percentage.
  - withProgress
```
public Snapshot withProgress(String progress)
```
    The progress of the snapshot, as a percentage.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    progress - The progress of the snapshot, as a percentage.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getOwnerId
```
public String getOwnerId()
```
    The AWS account ID of the Amazon EBS snapshot owner.
    
    Returns:
    The AWS account ID of the Amazon EBS snapshot owner.
  - setOwnerId
```
public void setOwnerId(String ownerId)
```
    The AWS account ID of the Amazon EBS snapshot owner.
    
    Parameters:
    ownerId - The AWS account ID of the Amazon EBS snapshot owner.
  - withOwnerId
```
public Snapshot withOwnerId(String ownerId)
```
    The AWS account ID of the Amazon EBS snapshot owner.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    ownerId - The AWS account ID of the Amazon EBS snapshot owner.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    The description for the snapshot.
    
    Returns:
    The description for the snapshot.
  - setDescription
```
public void setDescription(String description)
```
    The description for the snapshot.
    
    Parameters:
    description - The description for the snapshot.
  - withDescription
```
public Snapshot withDescription(String description)
```
    The description for the snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    description - The description for the snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getVolumeSize
```
public Integer getVolumeSize()
```
    The size of the volume, in GiB.
    
    Returns:
    The size of the volume, in GiB.
  - setVolumeSize
```
public void setVolumeSize(Integer volumeSize)
```
    The size of the volume, in GiB.
    
    Parameters:
    volumeSize - The size of the volume, in GiB.
  - withVolumeSize
```
public Snapshot withVolumeSize(Integer volumeSize)
```
    The size of the volume, in GiB.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    volumeSize - The size of the volume, in GiB.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getOwnerAlias
```
public String getOwnerAlias()
```
    The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
    
    Returns:
    The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
  - setOwnerAlias
```
public void setOwnerAlias(String ownerAlias)
```
    The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
    
    Parameters:
    ownerAlias - The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
  - withOwnerAlias
```
public Snapshot withOwnerAlias(String ownerAlias)
```
    The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    ownerAlias - The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Any tags assigned to the snapshot.
    
    Returns:
    Any tags assigned to the snapshot.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Any tags assigned to the snapshot.
    
    Parameters:
    tags - Any tags assigned to the snapshot.
  - withTags
```
public Snapshot withTags(Tag... tags)
```
    Any tags assigned to the snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - Any tags assigned to the snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public Snapshot withTags(Collection<Tag> tags)
```
    Any tags assigned to the snapshot.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - Any tags assigned to the snapshot.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isEncrypted
```
public Boolean isEncrypted()
```
    Indicates whether the snapshot is encrypted.
    
    Returns:
    Indicates whether the snapshot is encrypted.
  - setEncrypted
```
public void setEncrypted(Boolean encrypted)
```
    Indicates whether the snapshot is encrypted.
    
    Parameters:
    encrypted - Indicates whether the snapshot is encrypted.
  - withEncrypted
```
public Snapshot withEncrypted(Boolean encrypted)
```
    Indicates whether the snapshot is encrypted.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    encrypted - Indicates whether the snapshot is encrypted.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEncrypted
```
public Boolean getEncrypted()
```
    Indicates whether the snapshot is encrypted.
    
    Returns:
    Indicates whether the snapshot is encrypted.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Snapshot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Snapshot

Method Detail

getSnapshotId

setSnapshotId

withSnapshotId

getVolumeId

setVolumeId

withVolumeId

getState

setState

withState

setState

withState

getStartTime

setStartTime

withStartTime

getProgress

setProgress

withProgress

getOwnerId

setOwnerId

withOwnerId

getDescription

setDescription

withDescription

getVolumeSize

setVolumeSize

withVolumeSize

getOwnerAlias

setOwnerAlias

withOwnerAlias

getTags

setTags

withTags

withTags

isEncrypted

setEncrypted

withEncrypted

getEncrypted

toString

hashCode

equals