com.iland.cohesity.iaas.backups.protectionsources

Interface ProtectionSourceApi

public interface ProtectionSourceApi

API for downloading, listing, and registering protection sources.

Author:

Tag Spilman

Method Summary

Modifier and Type	Method and Description
void	deleteProtectionSource(ProtectionSourceUid protectionSourceUid) Unregister a previously registered Protection Source.
Attachment	downloadPhysicalAgent(DownloadPhysicalAgentRequest request) Returns an InputStream containing the physical agent, i.e.
Stream<ScopedProtectionSource>	listProtectionSources(EntityFilters entityFilters) If no parameters are specified, all Protection Sources that are registered on the Cohesity Cluster are returned.
ScopedProtectionSource	registerProtectionSource(VdcUuid vdcUuid, com.iland.cohesity.sdk.api.model.RegisterProtectionSourceParameters parameters) Register a Protection Source on the Cohesity Cluster.
ScopedProtectionSource	updateProtectionSource(ProtectionSourceUid protectionSourceUid, com.iland.cohesity.sdk.api.model.UpdateProtectionSourceParameters parameters) Update a previously registered Protection Source with new details.

Method Detail

downloadPhysicalAgent

Attachment downloadPhysicalAgent(DownloadPhysicalAgentRequest request)

Returns an InputStream containing the physical agent, i.e. an installer.

Parameters:

request - a DownloadPhysicalAgentRequest request

Returns:

an InputStream an InputStream containing the physical agent

listProtectionSources

Stream<ScopedProtectionSource> listProtectionSources(EntityFilters entityFilters)

If no parameters are specified, all Protection Sources that are registered on the Cohesity Cluster are returned.

Parameters:

entityFilters - the filters

Returns:

a List of nodes

registerProtectionSource

ScopedProtectionSource registerProtectionSource(VdcUuid vdcUuid,
                                                com.iland.cohesity.sdk.api.model.RegisterProtectionSourceParameters parameters)

Register a Protection Source on the Cohesity Cluster. It could be the root node of a vCenter Server or a physical server.

Parameters:

vdcUuid - a VDC UUID

parameters - the parameters

Returns:

the newly registered Protection Source upon success

updateProtectionSource

ScopedProtectionSource updateProtectionSource(ProtectionSourceUid protectionSourceUid,
                                              com.iland.cohesity.sdk.api.model.UpdateProtectionSourceParameters parameters)

Update a previously registered Protection Source with new details.

Parameters:

protectionSourceUid - the ProtectionSourceUid to update

parameters - the parameters

Returns:

the updated ProtectionSourceNode

deleteProtectionSource

void deleteProtectionSource(ProtectionSourceUid protectionSourceUid)

Unregister a previously registered Protection Source.

Parameters:

protectionSourceUid - the ProtectionSourceUid to delete