Documentation
¶
Overview ¶
Api classes for dataprotection's golang SDK
Index ¶
- type ProtectedResourcesApi
- func (api *ProtectedResourcesApi) GetProtectedResourceById(extId *string, args ...map[string]interface{}) (*import1.GetProtectedResourceApiResponse, error)
- func (api *ProtectedResourcesApi) PromoteProtectedResource(extId *string, args ...map[string]interface{}) (*import1.ProtectedResourcePromoteApiResponse, error)
- func (api *ProtectedResourcesApi) RestoreProtectedResource(extId *string, body *import1.ProtectedResourceRestoreSpec, ...) (*import1.ProtectedResourceRestoreApiResponse, error)
- type RecoveryPointsApi
- func (api *RecoveryPointsApi) CreateRecoveryPoint(body *import1.RecoveryPoint, args ...map[string]interface{}) (*import1.CreateRecoveryPointApiResponse, error)
- func (api *RecoveryPointsApi) DeleteRecoveryPointById(extId *string, args ...map[string]interface{}) (*import1.DeleteRecoveryPointApiResponse, error)
- func (api *RecoveryPointsApi) DiscoverClusterForRecoveryPointId(extId *string, body *import2.ClusterDiscoverSpec, ...) (*import1.ClusterInfoApiResponse, error)
- func (api *RecoveryPointsApi) GetRecoveryPointById(extId *string, args ...map[string]interface{}) (*import1.GetRecoveryPointApiResponse, error)
- func (api *RecoveryPointsApi) GetVmRecoveryPointById(recoveryPointExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetVmRecoveryPointApiResponse, error)
- func (api *RecoveryPointsApi) GetVssMetadataByVmRecoveryPointId(recoveryPointExtId *string, vmRecoveryPointExtId *string, ...) (*import2.GetVssMetadataApiResponse, error)
- func (api *RecoveryPointsApi) ListRecoveryPoints(xClusterId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, ...) (*import1.ListRecoveryPointsApiResponse, error)
- func (api *RecoveryPointsApi) ReplicateRecoveryPoint(extId *string, body *import1.RecoveryPointReplicationSpec, ...) (*import1.RecoveryPointReplicateApiResponse, error)
- func (api *RecoveryPointsApi) RestoreRecoveryPoint(extId *string, body *import1.RecoveryPointRestorationSpec, ...) (*import1.RecoveryPointRestoreApiResponse, error)
- func (api *RecoveryPointsApi) SetRecoveryPointExpirationTime(extId *string, body *import1.ExpirationTimeSpec, ...) (*import1.UpdateRecoveryPointExpirationTimeApiResponse, error)
- func (api *RecoveryPointsApi) VmRecoveryPointComputeChangedRegions(recoveryPointExtId *string, vmRecoveryPointExtId *string, extId *string, ...) (*import2.ChangedVmRegionsApiResponse, error)
- func (api *RecoveryPointsApi) VolumeGroupRecoveryPointComputeChangedRegions(recoveryPointExtId *string, volumeGroupRecoveryPointExtId *string, ...) (*import2.ChangedVolumeGroupRegionsApiResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ProtectedResourcesApi ¶
type ProtectedResourcesApi struct {
ApiClient *client.ApiClient
// contains filtered or unexported fields
}
func NewProtectedResourcesApi ¶
func NewProtectedResourcesApi(apiClient *client.ApiClient) *ProtectedResourcesApi
func (*ProtectedResourcesApi) GetProtectedResourceById ¶
func (api *ProtectedResourcesApi) GetProtectedResourceById(extId *string, args ...map[string]interface{}) (*import1.GetProtectedResourceApiResponse, error)
Get the details of the specified protected resource such as the restorable time ranges available on the local Prism Central and the state of replication to the targets specified in the applied protection policies. This applies only if the entity is protected in a minutely or synchronous schedule. Other protection schedules are not served by this endpoint yet, and are considered not protected.
func (*ProtectedResourcesApi) PromoteProtectedResource ¶
func (api *ProtectedResourcesApi) PromoteProtectedResource(extId *string, args ...map[string]interface{}) (*import1.ProtectedResourcePromoteApiResponse, error)
Promotes the specified synced entity at the target site. This is only relevant if the synced entity is protected in a synchronous schedule.
func (*ProtectedResourcesApi) RestoreProtectedResource ¶
func (api *ProtectedResourcesApi) RestoreProtectedResource(extId *string, body *import1.ProtectedResourceRestoreSpec, args ...map[string]interface{}) (*import1.ProtectedResourceRestoreApiResponse, error)
Restore the specified protected resource from its state at the given timestamp on the given cluster. This is only relevant if the entity is protected in a minutely schedule at the given timestamp.
type RecoveryPointsApi ¶
type RecoveryPointsApi struct {
ApiClient *client.ApiClient
// contains filtered or unexported fields
}
func NewRecoveryPointsApi ¶
func NewRecoveryPointsApi(apiClient *client.ApiClient) *RecoveryPointsApi
func (*RecoveryPointsApi) CreateRecoveryPoint ¶
func (api *RecoveryPointsApi) CreateRecoveryPoint(body *import1.RecoveryPoint, args ...map[string]interface{}) (*import1.CreateRecoveryPointApiResponse, error)
Create a new recovery point.<br> #### Task Completion Details <br> External identifier of the created recovery point can be found in the task completion details under the key `recoveryPointExtId`.
func (*RecoveryPointsApi) DeleteRecoveryPointById ¶
func (api *RecoveryPointsApi) DeleteRecoveryPointById(extId *string, args ...map[string]interface{}) (*import1.DeleteRecoveryPointApiResponse, error)
Delete the recovery point identified by {extId}.
func (*RecoveryPointsApi) DiscoverClusterForRecoveryPointId ¶
func (api *RecoveryPointsApi) DiscoverClusterForRecoveryPointId(extId *string, body *import2.ClusterDiscoverSpec, args ...map[string]interface{}) (*import1.ClusterInfoApiResponse, error)
It returns cluster details, where given recovery point resides, and a certificate to access endpoint. The certificate must be set as the NTNX_IGW_SESSION cookie in the header. For example: Cookie: NTNX_IGW_SESSION='certificate'
func (*RecoveryPointsApi) GetRecoveryPointById ¶
func (api *RecoveryPointsApi) GetRecoveryPointById(extId *string, args ...map[string]interface{}) (*import1.GetRecoveryPointApiResponse, error)
Query the recovery point identified by {extId}.
func (*RecoveryPointsApi) GetVmRecoveryPointById ¶
func (api *RecoveryPointsApi) GetVmRecoveryPointById(recoveryPointExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetVmRecoveryPointApiResponse, error)
Query the VM recovery point identified by {extId}.
func (*RecoveryPointsApi) GetVssMetadataByVmRecoveryPointId ¶
func (api *RecoveryPointsApi) GetVssMetadataByVmRecoveryPointId(recoveryPointExtId *string, vmRecoveryPointExtId *string, args ...map[string]interface{}) (*import2.GetVssMetadataApiResponse, error)
The metadata documents of Volume Shadow Copy Service(VSS) writers and requesters are called VSS metadata. During a VSS backup operation, the VSS metadata is compressed into a cabinet file, which is in a .cab file format designed for storing compressed files. This cabinet file must be saved to the backup media during a backup operation, as required during a restore operation. This API returns the VSS metadata (data of the cabinet file) of a VM recovery point under a composite recovery point identified by an external identifier, which was saved during the create recovery point operation.
func (*RecoveryPointsApi) ListRecoveryPoints ¶
func (api *RecoveryPointsApi) ListRecoveryPoints(xClusterId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListRecoveryPointsApiResponse, error)
List of recovery point.
func (*RecoveryPointsApi) ReplicateRecoveryPoint ¶
func (api *RecoveryPointsApi) ReplicateRecoveryPoint(extId *string, body *import1.RecoveryPointReplicationSpec, args ...map[string]interface{}) (*import1.RecoveryPointReplicateApiResponse, error)
Replicate the recovery point identified by {extId}.<br> #### Task Completion Details <br> External identifier of the replicated recovery point can be found in the task completion details under the key `recoveryPointExtId`.
func (*RecoveryPointsApi) RestoreRecoveryPoint ¶
func (api *RecoveryPointsApi) RestoreRecoveryPoint(extId *string, body *import1.RecoveryPointRestorationSpec, args ...map[string]interface{}) (*import1.RecoveryPointRestoreApiResponse, error)
Restore a recovery point identified by {extId}.<br> #### Task Completion Details <br> A comma separated list of the created VM and volume group external identifiers can be found in the task completion details under the keys `vmExtIds` and `volumeGroupExtIds` respectively.
func (*RecoveryPointsApi) SetRecoveryPointExpirationTime ¶
func (api *RecoveryPointsApi) SetRecoveryPointExpirationTime(extId *string, body *import1.ExpirationTimeSpec, args ...map[string]interface{}) (*import1.UpdateRecoveryPointExpirationTimeApiResponse, error)
Set the expiration time for the recovery point identified by {extId}.
func (*RecoveryPointsApi) VmRecoveryPointComputeChangedRegions ¶
func (api *RecoveryPointsApi) VmRecoveryPointComputeChangedRegions(recoveryPointExtId *string, vmRecoveryPointExtId *string, extId *string, body *import2.VmRecoveryPointChangedRegionsComputeSpec, args ...map[string]interface{}) (*import2.ChangedVmRegionsApiResponse, error)
Displays the calculated metadata with the changed region details between any two VM disk recovery points of a file. This API can be used for incremental and differential backups, as well as for a full backup, because it indicates the regions that are zeros, helping to avoid copying zero regions.
func (*RecoveryPointsApi) VolumeGroupRecoveryPointComputeChangedRegions ¶
func (api *RecoveryPointsApi) VolumeGroupRecoveryPointComputeChangedRegions(recoveryPointExtId *string, volumeGroupRecoveryPointExtId *string, extId *string, body *import2.VolumeGroupRecoveryPointChangedRegionsComputeSpec, args ...map[string]interface{}) (*import2.ChangedVolumeGroupRegionsApiResponse, error)
Displays the calculated metadata with the changed region details between any two volume group disk recovery points of a file. This API can be used for incremental and differential backups, as well as for a full backup, because it indicates the regions that are zeros, helping to avoid copying zero regions.