Package com.ibm.cloud.is.vpc.v1.model

Class SnapshotPrototype

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.is.vpc.v1.model.SnapshotPrototype

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

Direct Known Subclasses:

SnapshotPrototypeSnapshotBySourceSnapshot, SnapshotPrototypeSnapshotBySourceVolume

public class SnapshotPrototype
extends com.ibm.cloud.sdk.core.service.model.GenericModel

SnapshotPrototype. Classes which extend this class: - SnapshotPrototypeSnapshotBySourceVolume - SnapshotPrototypeSnapshotBySourceSnapshot

Method Summary

Modifier and Type	Method	Description
List<SnapshotClonePrototype>	clones()	Gets the clones.
EncryptionKeyIdentity	encryptionKey()	Gets the encryptionKey.
String	name()	Gets the name.
ResourceGroupIdentity	resourceGroup()	Gets the resourceGroup.
SnapshotIdentityByCRN	sourceSnapshot()	Gets the sourceSnapshot.
VolumeIdentity	sourceVolume()	Gets the sourceVolume.
List<String>	userTags()	Gets the userTags.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

clones

public List<SnapshotClonePrototype> clones()

Gets the clones. Clones to create for this snapshot.

Returns:

the clones

name

public String name()

Gets the name. The name for this snapshot. The name must not be used by another snapshot in the region. If unspecified, the name will be a hyphenated list of randomly-selected words.

Returns:

the name

resourceGroup

public ResourceGroupIdentity resourceGroup()

Gets the resourceGroup. The resource group to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.

Returns:

the resourceGroup

userTags

public List<String> userTags()

Gets the userTags. The [user tags](https://cloud.ibm.com/apidocs/tagging#types-of-tags) associated with this snapshot.

Returns:

the userTags

sourceVolume

public VolumeIdentity sourceVolume()

Gets the sourceVolume. The volume to create this snapshot from.

Returns:

the sourceVolume

encryptionKey

public EncryptionKeyIdentity encryptionKey()

Gets the encryptionKey. The root key to use to wrap the data encryption key for this snapshot. A key must be specified if and only if the source snapshot has an `encryption` type of `user_managed`. To maximize snapshot availability and sharing of snapshot data, specify a key in the same region as the new snapshot, and use the same encryption key for all snapshots using the same source volume. The specified key may be in a different account, subject to IAM policies.

Returns:

the encryptionKey

sourceSnapshot

public SnapshotIdentityByCRN sourceSnapshot()

Gets the sourceSnapshot. The source snapshot (in another region) to create this snapshot from. The specified snapshot must not already be the source of another snapshot in this region.

Returns:

the sourceSnapshot