com.vmware.vcenter.hvc.links.sync

Interface Providers

All Superinterfaces:

ProvidersTypes, Service

All Known Implementing Classes:

ProvidersStub

public interface Providers
extends Service, ProvidersTypes

The Providers interface provides methods to create a sync session, get information on Sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.hvc.links.sync.ProvidersTypes

ProvidersTypes.Credentials, ProvidersTypes.Info, ProvidersTypes.SessionInfo, ProvidersTypes.Status, ProvidersTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.hvc.links.sync.ProvidersTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
ProvidersTypes.Info	get(java.lang.String link, java.lang.String provider) Gets Sync information for a sync provider.
void	get(java.lang.String link, java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback) Gets Sync information for a sync provider.
void	get(java.lang.String link, java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Gets Sync information for a sync provider.
ProvidersTypes.Info	get(java.lang.String link, java.lang.String provider, InvocationConfig invocationConfig) Gets Sync information for a sync provider.
java.util.List<ProvidersTypes.Summary>	list(java.lang.String link) Enumerates the sync providers.
void	list(java.lang.String link, AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback) Enumerates the sync providers.
void	list(java.lang.String link, AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Enumerates the sync providers.
java.util.List<ProvidersTypes.Summary>	list(java.lang.String link, InvocationConfig invocationConfig) Enumerates the sync providers.
void	start(java.lang.String link, java.lang.String provider) Initiates synchronization between the local and remote replicas for the sync provider.
void	start(java.lang.String link, java.lang.String provider, AsyncCallback<java.lang.Void> asyncCallback) Initiates synchronization between the local and remote replicas for the sync provider.
void	start(java.lang.String link, java.lang.String provider, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Initiates synchronization between the local and remote replicas for the sync provider.
void	start(java.lang.String link, java.lang.String provider, InvocationConfig invocationConfig) Initiates synchronization between the local and remote replicas for the sync provider.

Method Detail

list

java.util.List<ProvidersTypes.Summary> list(java.lang.String link)

Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

Returns:

The List of sync provider information.

Throws:

Error - If list fails.

Unauthorized - If the user is not authorized to perform this operation.

list

java.util.List<ProvidersTypes.Summary> list(java.lang.String link,
                                            InvocationConfig invocationConfig)

Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

invocationConfig - Configuration for the method invocation.

Returns:

The List of sync provider information.

Throws:

Error - If list fails.

Unauthorized - If the user is not authorized to perform this operation.

list

void list(java.lang.String link,
          AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback)

Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The List of sync provider information.

Operation Errors:
Error - If list fails.
Unauthorized - If the user is not authorized to perform this operation.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String link,
          AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The List of sync provider information.

Operation Errors:
Error - If list fails.
Unauthorized - If the user is not authorized to perform this operation.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

ProvidersTypes.Info get(java.lang.String link,
                        java.lang.String provider)

Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

provider - Unique identifier of the sync provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

Returns:

The Info of sync information for the provider.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the sync provider associated with provider does not exist.

Unauthorized - if the user is not authorized to perform this operation.

get

ProvidersTypes.Info get(java.lang.String link,
                        java.lang.String provider,
                        InvocationConfig invocationConfig)

Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

provider - Unique identifier of the sync provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

invocationConfig - Configuration for the method invocation.

Returns:

The Info of sync information for the provider.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the sync provider associated with provider does not exist.

Unauthorized - if the user is not authorized to perform this operation.

get

void get(java.lang.String link,
         java.lang.String provider,
         AsyncCallback<ProvidersTypes.Info> asyncCallback)

Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The Info of sync information for the provider.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the sync provider associated with provider does not exist.
Unauthorized - if the user is not authorized to perform this operation.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

provider - Unique identifier of the sync provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String link,
         java.lang.String provider,
         AsyncCallback<ProvidersTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The Info of sync information for the provider.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the sync provider associated with provider does not exist.
Unauthorized - if the user is not authorized to perform this operation.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

provider - Unique identifier of the sync provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

start

void start(java.lang.String link,
           java.lang.String provider)

Initiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

provider - Unique identifier representing the sync provider The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the link associated with link does not exist if the provider associated with provider is not registered for sync

Unauthorized - if the user is not authorized to perform this operation.

ResourceBusy - if a sync is already running.

start

void start(java.lang.String link,
           java.lang.String provider,
           InvocationConfig invocationConfig)

Initiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

provider - Unique identifier representing the sync provider The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the link associated with link does not exist if the provider associated with provider is not registered for sync

Unauthorized - if the user is not authorized to perform this operation.

ResourceBusy - if a sync is already running.

start

void start(java.lang.String link,
           java.lang.String provider,
           AsyncCallback<java.lang.Void> asyncCallback)

Initiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the link associated with link does not exist if the provider associated with provider is not registered for sync
Unauthorized - if the user is not authorized to perform this operation.
ResourceBusy - if a sync is already running.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

provider - Unique identifier representing the sync provider The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

start

void start(java.lang.String link,
           java.lang.String provider,
           AsyncCallback<java.lang.Void> asyncCallback,
           InvocationConfig invocationConfig)

Initiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the link associated with link does not exist if the provider associated with provider is not registered for sync
Unauthorized - if the user is not authorized to perform this operation.
ResourceBusy - if a sync is already running.

Parameters:

link - Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

provider - Unique identifier representing the sync provider The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.