common

package
v4.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Module dataprotection.v4.common of Nutanix Data Protection APIs

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BackupType

type BackupType int

The backup type specifies the criteria for identifying the files to be backed up. This property should be specified to the application-consistent recovery points for Windows VMs/agents. The following backup types are supported for the application-consistent recovery points: 1. FULL_BACKUP - All files are backed up irrespective of their last backup date/time and state. Also, this backup type updates the backup history of every file that was involved in the recovery point. 2. COPY_BACKUP - All files are backed up regardless of their last backup date/time and state. However, this backup type does not update the backup history of individual files involved in the recovery point.

const (
	BACKUPTYPE_UNKNOWN     BackupType = 0
	BACKUPTYPE_REDACTED    BackupType = 1
	BACKUPTYPE_FULL_BACKUP BackupType = 2
	BACKUPTYPE_COPY_BACKUP BackupType = 3
)

func (BackupType) GetName

func (e BackupType) GetName() string

Returns the name of the enum

func (*BackupType) MarshalJSON

func (e *BackupType) MarshalJSON() ([]byte, error)

func (BackupType) Ref

func (e BackupType) Ref() *BackupType

func (*BackupType) UnmarshalJSON

func (e *BackupType) UnmarshalJSON(b []byte) error

type BaseRecoveryPoint

type BaseRecoveryPoint struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  The UTC date and time in ISO-8601 format when the Recovery point is created.
	*/
	CreationTime *time.Time `json:"creationTime,omitempty"`
	/*
	  The UTC date and time in ISO-8601 format when the current Recovery point expires and will be garbage collected.
	*/
	ExpirationTime *time.Time `json:"expirationTime,omitempty"`
	/*
	  A globally unique identifier of an instance that is suitable for external consumption.
	*/
	ExtId *string `json:"extId,omitempty"`
	/*
	  A HATEOAS style link for the response.  Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
	*/
	Links []import1.ApiLink `json:"links,omitempty"`
	/*
	  Location agnostic identifier of the Recovery point.
	*/
	LocationAgnosticId *string `json:"locationAgnosticId,omitempty"`
	/*
	  The name of the Recovery point.
	*/
	Name *string `json:"name,omitempty"`

	RecoveryPointType *RecoveryPointType `json:"recoveryPointType,omitempty"`

	Status *RecoveryPointStatus `json:"status,omitempty"`
	/*
	  A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this ID to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
	*/
	TenantId *string `json:"tenantId,omitempty"`
	/*
	  Indicates the total exclusive usage of this recovery point, which is the total space that could be reclaimed after deleting this recovery point.
	*/
	TotalExclusiveUsageBytes *int64 `json:"totalExclusiveUsageBytes,omitempty"`
}

A model that represents common properties of a Recovery point resources

func NewBaseRecoveryPoint

func NewBaseRecoveryPoint() *BaseRecoveryPoint

func (*BaseRecoveryPoint) MarshalJSON added in v4.1.1

func (p *BaseRecoveryPoint) MarshalJSON() ([]byte, error)

func (*BaseRecoveryPoint) UnmarshalJSON added in v4.1.1

func (p *BaseRecoveryPoint) UnmarshalJSON(b []byte) error

type BaseVmRecoveryPoint

type BaseVmRecoveryPoint struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	ApplicationConsistentPropertiesItemDiscriminator_ *string `json:"$applicationConsistentPropertiesItemDiscriminator,omitempty"`
	/*
	  User-defined application-consistent properties for the recovery point.
	*/
	ApplicationConsistentProperties *OneOfBaseVmRecoveryPointApplicationConsistentProperties `json:"applicationConsistentProperties,omitempty"`
	/*
	  External identifier of the Consistency group which the VM was part of at the time of recovery point creation.
	*/
	ConsistencyGroupExtId *string `json:"consistencyGroupExtId,omitempty"`
	/*
	  The UTC date and time in ISO-8601 format when the Recovery point is created.
	*/
	CreationTime *time.Time `json:"creationTime,omitempty"`

	DiskRecoveryPoints []DiskRecoveryPoint `json:"diskRecoveryPoints,omitempty"`
	/*
	  The UTC date and time in ISO-8601 format when the current Recovery point expires and will be garbage collected.
	*/
	ExpirationTime *time.Time `json:"expirationTime,omitempty"`
	/*
	  A globally unique identifier of an instance that is suitable for external consumption.
	*/
	ExtId *string `json:"extId,omitempty"`
	/*
	  A HATEOAS style link for the response.  Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
	*/
	Links []import1.ApiLink `json:"links,omitempty"`
	/*
	  Location agnostic identifier of the Recovery point.
	*/
	LocationAgnosticId *string `json:"locationAgnosticId,omitempty"`
	/*
	  The name of the Recovery point.
	*/
	Name *string `json:"name,omitempty"`

	RecoveryPointType *RecoveryPointType `json:"recoveryPointType,omitempty"`

	Status *RecoveryPointStatus `json:"status,omitempty"`
	/*
	  A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this ID to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
	*/
	TenantId *string `json:"tenantId,omitempty"`
	/*
	  Indicates the total exclusive usage of this recovery point, which is the total space that could be reclaimed after deleting this recovery point.
	*/
	TotalExclusiveUsageBytes *int64 `json:"totalExclusiveUsageBytes,omitempty"`
	/*
	  Category key-value pairs associated with the VM at the time of recovery point creation. The category key and value are separated by '/'. For example, a category with key 'dept' and value 'hr' is displayed as 'dept/hr'.
	*/
	VmCategories []string `json:"vmCategories,omitempty"`
	/*
	  VM external identifier which is captured as a part of this recovery point.
	*/
	VmExtId *string `json:"vmExtId,omitempty"`
}

A model that represents common properties of a VM Recovery point resources

func NewBaseVmRecoveryPoint

func NewBaseVmRecoveryPoint() *BaseVmRecoveryPoint

func (*BaseVmRecoveryPoint) GetApplicationConsistentProperties

func (p *BaseVmRecoveryPoint) GetApplicationConsistentProperties() interface{}

func (*BaseVmRecoveryPoint) MarshalJSON added in v4.1.1

func (p *BaseVmRecoveryPoint) MarshalJSON() ([]byte, error)

func (*BaseVmRecoveryPoint) SetApplicationConsistentProperties

func (p *BaseVmRecoveryPoint) SetApplicationConsistentProperties(v interface{}) error

func (*BaseVmRecoveryPoint) UnmarshalJSON added in v4.1.1

func (p *BaseVmRecoveryPoint) UnmarshalJSON(b []byte) error

type ClusterInfo

type ClusterInfo struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`

	ClusterIp *import2.IPAddress `json:"clusterIp,omitempty"`
	/*
	  JWT token in string format. This token must be set as a session cookie while making the second call for CBT/VSS.
	*/
	JwtToken *string `json:"jwtToken,omitempty"`
}

It contains a redirect IP and a certificate. Use the certificate to invoke the compute changed regions endpoint. Set the certificate as a header when invoking the CBT endpoint with NTNX_IGW_SESSION='CERTIFICATE'.

func NewClusterInfo

func NewClusterInfo() *ClusterInfo

func (*ClusterInfo) MarshalJSON added in v4.1.1

func (p *ClusterInfo) MarshalJSON() ([]byte, error)

func (*ClusterInfo) UnmarshalJSON added in v4.1.1

func (p *ClusterInfo) UnmarshalJSON(b []byte) error

type DiskRecoveryPoint

type DiskRecoveryPoint struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  Disk external identifier which is captured as a part of this recovery point.
	*/
	DiskExtId *string `json:"diskExtId,omitempty"`
	/*
	  Disk recovery point identifier.
	*/
	DiskRecoveryPointExtId *string `json:"diskRecoveryPointExtId,omitempty"`
}

A model that represents the disk recovery point properties.

func NewDiskRecoveryPoint

func NewDiskRecoveryPoint() *DiskRecoveryPoint

func (*DiskRecoveryPoint) MarshalJSON added in v4.1.1

func (p *DiskRecoveryPoint) MarshalJSON() ([]byte, error)

func (*DiskRecoveryPoint) UnmarshalJSON added in v4.1.1

func (p *DiskRecoveryPoint) UnmarshalJSON(b []byte) error

type FileDetail

type FileDetail struct {
	Path        *string `json:"-"`
	ObjectType_ *string `json:"-"`
}

func NewFileDetail

func NewFileDetail() *FileDetail

type OneOfBaseVmRecoveryPointApplicationConsistentProperties

type OneOfBaseVmRecoveryPointApplicationConsistentProperties struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func (*OneOfBaseVmRecoveryPointApplicationConsistentProperties) GetValue

func (*OneOfBaseVmRecoveryPointApplicationConsistentProperties) MarshalJSON

func (*OneOfBaseVmRecoveryPointApplicationConsistentProperties) SetValue

func (*OneOfBaseVmRecoveryPointApplicationConsistentProperties) UnmarshalJSON

type RecoveryPointStatus

type RecoveryPointStatus int

The status of the Recovery point, which indicates whether this Recovery point is fit to be consumed.

const (
	RECOVERYPOINTSTATUS_UNKNOWN  RecoveryPointStatus = 0
	RECOVERYPOINTSTATUS_REDACTED RecoveryPointStatus = 1
	RECOVERYPOINTSTATUS_COMPLETE RecoveryPointStatus = 2
)

func (RecoveryPointStatus) GetName

func (e RecoveryPointStatus) GetName() string

Returns the name of the enum

func (*RecoveryPointStatus) MarshalJSON

func (e *RecoveryPointStatus) MarshalJSON() ([]byte, error)

func (RecoveryPointStatus) Ref

func (*RecoveryPointStatus) UnmarshalJSON

func (e *RecoveryPointStatus) UnmarshalJSON(b []byte) error

type RecoveryPointType

type RecoveryPointType int

Type of the Recovery point.

const (
	RECOVERYPOINTTYPE_UNKNOWN                RecoveryPointType = 0
	RECOVERYPOINTTYPE_REDACTED               RecoveryPointType = 1
	RECOVERYPOINTTYPE_CRASH_CONSISTENT       RecoveryPointType = 2
	RECOVERYPOINTTYPE_APPLICATION_CONSISTENT RecoveryPointType = 3
)

func (RecoveryPointType) GetName

func (e RecoveryPointType) GetName() string

Returns the name of the enum

func (*RecoveryPointType) MarshalJSON

func (e *RecoveryPointType) MarshalJSON() ([]byte, error)

func (RecoveryPointType) Ref

func (*RecoveryPointType) UnmarshalJSON

func (e *RecoveryPointType) UnmarshalJSON(b []byte) error

type VssProperties

type VssProperties struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`

	BackupType *BackupType `json:"backupType"`
	/*
	  Indicates whether the given set of VSS writers' UUIDs should be included or excluded from the application consistent recovery point. By default, the value is set to false, indicating that all listed VSS writers' UUIDs will be excluded.
	*/
	ShouldIncludeWriters *bool `json:"shouldIncludeWriters,omitempty"`
	/*
	  Indicates whether to store the VSS metadata if the user is interested in application-specific backup/restore. The VSS metadata consists of VSS writers and requester metadata details. These are compressed into a cabinet file(.cab file) during a VSS backup operation. This cabinet file must be saved to the backup media during a backup operation, as it is required during the restore operation.
	*/
	ShouldStoreVssMetadata *bool `json:"shouldStoreVssMetadata,omitempty"`
	/*
	  List of VSS writer UUIDs that are used in an application consistent recovery point. The default values are the system and the registry writer UUIDs.
	*/
	Writers []string `json:"writers,omitempty"`
}

For Windows VMs/agents, application-consistent recovery points are selected using the Windows-specific Volume Shadow Copy Service (VSS). The enclosed properties, also called VSS properties, are used by the Windows platform to decide the type of application-consistent recovery points to consider.

func NewVssProperties

func NewVssProperties() *VssProperties

func (*VssProperties) MarshalJSON

func (p *VssProperties) MarshalJSON() ([]byte, error)

func (*VssProperties) UnmarshalJSON added in v4.1.1

func (p *VssProperties) UnmarshalJSON(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL