com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt

Class BackupSchedule

java.lang.Object

com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt.BackupSchedule

All Implemented Interfaces:

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

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

The BackupSchedule class contains fields to be specified for creating a new schedule. The structure includes parts, location information, encryption password and enable flag.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	BackupSchedule() Default constructor.
protected	BackupSchedule(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 BackupSchedule	_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 BackupSchedule	_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)
char[]	getBackupPassword() Password for a backup piece.
java.lang.Boolean	getEnable() Enable or disable a schedule.
java.net.URI	getLocation() URL of the backup location.
char[]	getLocationPassword() Password for the given location.
java.lang.String	getLocationUser() Username for the given location.
java.util.List<java.lang.String>	getParts() List of optional parts to be backed up.
RecurrenceInfo	getRecurrenceInfo() Recurrence information for the schedule.
RetentionInfo	getRetentionInfo() Retention information for the schedule.
java.lang.String	getScheduleId() Identifier of the schedule.
int	hashCode()
void	setBackupPassword(char[] backupPassword) Password for a backup piece.
void	setEnable(java.lang.Boolean enable) Enable or disable a schedule.
void	setLocation(java.net.URI location) URL of the backup location.
void	setLocationPassword(char[] locationPassword) Password for the given location.
void	setLocationUser(java.lang.String locationUser) Username for the given location.
void	setParts(java.util.List<java.lang.String> parts) List of optional parts to be backed up.
void	setRecurrenceInfo(RecurrenceInfo recurrenceInfo) Recurrence information for the schedule.
void	setRetentionInfo(RetentionInfo retentionInfo) Retention information for the schedule.
void	setScheduleId(java.lang.String scheduleId) Identifier of the schedule.
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

BackupSchedule

public BackupSchedule()

Default constructor.

BackupSchedule

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

Method Detail

getParts

public java.util.List<java.lang.String> getParts()

List of optional parts to be backed up. Use the Parts.list() method to get information about the supported parts. If null all the optional parts will not be backed up.

Returns:

The current value of the property.

setParts

public void setParts(java.util.List<java.lang.String> parts)

List of optional parts to be backed up. Use the Parts.list() method to get information about the supported parts. If null all the optional parts will not be backed up.

Parameters:

parts - New value for the property.

getBackupPassword

public char[] getBackupPassword()

Password for a backup piece. The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). If null the backup piece will not be encrypted.

Returns:

The current value of the property.

setBackupPassword

public void setBackupPassword(char[] backupPassword)

Password for a backup piece. The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). If null the backup piece will not be encrypted.

Parameters:

backupPassword - New value for the property.

getLocation

public java.net.URI getLocation()

URL of the backup location. Only Set if URL is set in BackupSchedule

Returns:

The current value of the property.

setLocation

public void setLocation(java.net.URI location)

URL of the backup location. Only Set if URL is set in BackupSchedule

Parameters:

location - New value for the property.

getLocationUser

public java.lang.String getLocationUser()

Username for the given location. If null authentication will not be used for the specified location.

Returns:

The current value of the property.

setLocationUser

public void setLocationUser(java.lang.String locationUser)

Username for the given location. If null authentication will not be used for the specified location.

Parameters:

locationUser - New value for the property.

getLocationPassword

public char[] getLocationPassword()

Password for the given location. If null authentication will not be used for the specified location.

Returns:

The current value of the property.

setLocationPassword

public void setLocationPassword(char[] locationPassword)

Password for the given location. If null authentication will not be used for the specified location.

Parameters:

locationPassword - New value for the property.

getEnable

public java.lang.Boolean getEnable()

Enable or disable a schedule. If null the schedule will be enabled.

Returns:

The current value of the property.

setEnable

public void setEnable(java.lang.Boolean enable)

Enable or disable a schedule. If null the schedule will be enabled.

Parameters:

enable - New value for the property.

getRecurrenceInfo

public RecurrenceInfo getRecurrenceInfo()

Recurrence information for the schedule. If null backup job will not be scheduled. See RecurrenceInfo

Returns:

The current value of the property.

setRecurrenceInfo

public void setRecurrenceInfo(RecurrenceInfo recurrenceInfo)

Recurrence information for the schedule. If null backup job will not be scheduled. See RecurrenceInfo

Parameters:

recurrenceInfo - New value for the property.

getRetentionInfo

public RetentionInfo getRetentionInfo()

Retention information for the schedule. If null all the completed backup jobs will be retained forever. See RetentionInfo

Returns:

The current value of the property.

setRetentionInfo

public void setRetentionInfo(RetentionInfo retentionInfo)

Retention information for the schedule. If null all the completed backup jobs will be retained forever. See RetentionInfo

Parameters:

retentionInfo - New value for the property.

getScheduleId

public java.lang.String getScheduleId()

Identifier of the schedule.

Returns:

The current value of the property.

setScheduleId

public void setScheduleId(java.lang.String scheduleId)

Identifier of the schedule.

Parameters:

scheduleId - 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 BackupSchedule _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 BackupSchedule _newInstance2(com.vmware.vapi.data.StructValue structValue)

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