com.vmware.snapservice

Class ProtectionGroupInfo

java.lang.Object

com.vmware.snapservice.ProtectionGroupInfo

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class ProtectionGroupInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The ProtectionGroupInfo class contains properties that provide detailed information regarding the protection group and the snapshot policies associated with it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtectionGroupInfo.Builder Builder class for ProtectionGroupInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	ProtectionGroupInfo() Default constructor.
protected	ProtectionGroupInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static ProtectionGroupInfo	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static ProtectionGroupInfo	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.util.Calendar	getLastSnapshotTime() Time at which the last protection group snapshot was taken.
boolean	getLocked() Indicates if the protection group is to be locked.
java.lang.String	getName() Name of the protection group.
java.util.Calendar	getOldestSnapshotTime() Time at which the current oldest protection group snapshot was taken.
java.util.List<SnapshotPolicy>	getSnapshotPolicies() Snapshot policies for the protection targets.
java.util.Set<java.lang.String>	getSnapshots() List of snapshots taken for the protection group.
ProtectionGroupStatus	getStatus() Current status of the protection group.
TargetEntities	getTargetEntities() User provided target entities that must belong to the protection group.
java.util.Set<java.lang.String>	getVms() List of virtual machines that belong to the protection group.
int	hashCode()
void	setLastSnapshotTime(java.util.Calendar lastSnapshotTime) Time at which the last protection group snapshot was taken.
void	setLocked(boolean locked) Indicates if the protection group is to be locked.
void	setName(java.lang.String name) Name of the protection group.
void	setOldestSnapshotTime(java.util.Calendar oldestSnapshotTime) Time at which the current oldest protection group snapshot was taken.
void	setSnapshotPolicies(java.util.List<SnapshotPolicy> snapshotPolicies) Snapshot policies for the protection targets.
void	setSnapshots(java.util.Set<java.lang.String> snapshots) List of snapshots taken for the protection group.
void	setStatus(ProtectionGroupStatus status) Current status of the protection group.
void	setTargetEntities(TargetEntities targetEntities) User provided target entities that must belong to the protection group.
void	setVms(java.util.Set<java.lang.String> vms) List of virtual machines that belong to the protection group.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

ProtectionGroupInfo

public ProtectionGroupInfo()

Default constructor.

ProtectionGroupInfo

protected ProtectionGroupInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getName

public java.lang.String getName()

Name of the protection group.

Returns:

The current value of the property.

setName

public void setName(java.lang.String name)

Name of the protection group.

Parameters:

name - New value for the property.

getStatus

public ProtectionGroupStatus getStatus()

Current status of the protection group.

Returns:

The current value of the property.

setStatus

public void setStatus(ProtectionGroupStatus status)

Current status of the protection group.

Parameters:

status - New value for the property.

getTargetEntities

public TargetEntities getTargetEntities()

User provided target entities that must belong to the protection group.

Returns:

The current value of the property.

setTargetEntities

public void setTargetEntities(TargetEntities targetEntities)

User provided target entities that must belong to the protection group.

Parameters:

targetEntities - New value for the property.

getSnapshotPolicies

public java.util.List<SnapshotPolicy> getSnapshotPolicies()

Snapshot policies for the protection targets.

Returns:

The current value of the property.

setSnapshotPolicies

public void setSnapshotPolicies(java.util.List<SnapshotPolicy> snapshotPolicies)

Snapshot policies for the protection targets.

Parameters:

snapshotPolicies - New value for the property.

getLastSnapshotTime

public java.util.Calendar getLastSnapshotTime()

Time at which the last protection group snapshot was taken. is null if there are no snapshots taken for the protection group.

Returns:

The current value of the property.

setLastSnapshotTime

public void setLastSnapshotTime(java.util.Calendar lastSnapshotTime)

Time at which the last protection group snapshot was taken. is null if there are no snapshots taken for the protection group.

Parameters:

lastSnapshotTime - New value for the property.

getOldestSnapshotTime

public java.util.Calendar getOldestSnapshotTime()

Time at which the current oldest protection group snapshot was taken. is null if there are no snapshots taken for the protection group.

Returns:

The current value of the property.

setOldestSnapshotTime

public void setOldestSnapshotTime(java.util.Calendar oldestSnapshotTime)

Time at which the current oldest protection group snapshot was taken. is null if there are no snapshots taken for the protection group.

Parameters:

oldestSnapshotTime - New value for the property.

getVms

public java.util.Set<java.lang.String> getVms()

List of virtual machines that belong to the protection group. This is a combined list of virtual machines from the dynamic vm name and the individual list of virtual machines specified during creation of the prtection group.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: VirtualMachine. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: VirtualMachine.

setVms

public void setVms(java.util.Set<java.lang.String> vms)

List of virtual machines that belong to the protection group. This is a combined list of virtual machines from the dynamic vm name and the individual list of virtual machines specified during creation of the prtection group.

Parameters:

vms - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: VirtualMachine. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: VirtualMachine.

getSnapshots

public java.util.Set<java.lang.String> getSnapshots()

List of snapshots taken for the protection group.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot.

setSnapshots

public void setSnapshots(java.util.Set<java.lang.String> snapshots)

List of snapshots taken for the protection group.

Parameters:

snapshots - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot.

getLocked

public boolean getLocked()

Indicates if the protection group is to be locked. A locked protection group cannot be modified or deleted by the user. All snapshots associated with the protection group will be secure and cannot be deleted. The system will automatically delete these snapshots upon expiry based on the retention period

Returns:

The current value of the property.

setLocked

public void setLocked(boolean locked)

Indicates if the protection group is to be locked. A locked protection group cannot be modified or deleted by the user. All snapshots associated with the protection group will be secure and cannot be deleted. The system will automatically delete these snapshots upon expiry based on the retention period

Parameters:

locked - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static ProtectionGroupInfo _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static ProtectionGroupInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.