com.vmware.vcenter.hvc

Interface Links

All Superinterfaces:

LinksTypes, Service

All Known Implementing Classes:

LinksStub

public interface Links
extends Service, LinksTypes

The Links interface provides methods to create, delete, get information, and list hybrid links between the local and foreign Platform Service Controller (PSC). 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.LinksTypes

LinksTypes.CertificateInfo, LinksTypes.CreateSpec, LinksTypes.Credentials, LinksTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.hvc.LinksTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(LinksTypes.CreateSpec spec) Creates a new hybrid link between the local and foreign PSC.
void	create(LinksTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a new hybrid link between the local and foreign PSC.
void	create(LinksTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a new hybrid link between the local and foreign PSC.
java.lang.String	create(LinksTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a new hybrid link between the local and foreign PSC.
void	delete(java.lang.String link) Deletes an existing hybrid link.
void	delete(java.lang.String link, AsyncCallback<java.lang.Void> asyncCallback) Deletes an existing hybrid link.
void	delete(java.lang.String link, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes an existing hybrid link.
void	delete(java.lang.String link, InvocationConfig invocationConfig) Deletes an existing hybrid link.
java.util.List<LinksTypes.Summary>	list() Enumerates the list of registered hybrid links.
void	list(AsyncCallback<java.util.List<LinksTypes.Summary>> asyncCallback) Enumerates the list of registered hybrid links.
void	list(AsyncCallback<java.util.List<LinksTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Enumerates the list of registered hybrid links.
java.util.List<LinksTypes.Summary>	list(InvocationConfig invocationConfig) Enumerates the list of registered hybrid links.

Method Detail

create

java.lang.String create(LinksTypes.CreateSpec spec)

Creates a new hybrid link between the local and foreign PSC. 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:

spec - Specification for the new link to be created.

Returns:

The identifier of the newly linked domain. The return value will be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

Throws:

AlreadyExists - If the link already exists.

InvalidArgument - If the values of any of the properties of the spec parameter are not valid.

Unsupported - If the PSC or the VC version is not supported.

Unauthorized - If the user is not authorized.

UnverifiedPeer - If the SSL certificate of the foreign PSC cannot be validated by comparing with the thumbprint provided in LinksTypes.CreateSpec.getSslThumbprint() or if LinksTypes.CreateSpec.getSslThumbprint() is null. The value of the UnverifiedPeer#data) property will be a class that contains all the properties defined in {@link com.vmware.vcenter.hvc.LinksTypes.CertificateInfo}.

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

create

java.lang.String create(LinksTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Creates a new hybrid link between the local and foreign PSC. 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:

spec - Specification for the new link to be created.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the newly linked domain. The return value will be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

Throws:

AlreadyExists - If the link already exists.

InvalidArgument - If the values of any of the properties of the spec parameter are not valid.

Unsupported - If the PSC or the VC version is not supported.

Unauthorized - If the user is not authorized.

UnverifiedPeer - If the SSL certificate of the foreign PSC cannot be validated by comparing with the thumbprint provided in LinksTypes.CreateSpec.getSslThumbprint() or if LinksTypes.CreateSpec.getSslThumbprint() is null. The value of the UnverifiedPeer#data) property will be a class that contains all the properties defined in {@link com.vmware.vcenter.hvc.LinksTypes.CertificateInfo}.

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

create

void create(LinksTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Creates a new hybrid link between the local and foreign PSC. 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 identifier of the newly linked domain. The return value will be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

Operation Errors:
AlreadyExists - If the link already exists.
InvalidArgument - If the values of any of the properties of the spec parameter are not valid.
Unsupported - If the PSC or the VC version is not supported.
Unauthorized - If the user is not authorized.
UnverifiedPeer - If the SSL certificate of the foreign PSC cannot be validated by comparing with the thumbprint provided in LinksTypes.CreateSpec.getSslThumbprint() or if LinksTypes.CreateSpec.getSslThumbprint() is null. The value of the UnverifiedPeer#data) property will be a class that contains all the properties defined in {@link com.vmware.vcenter.hvc.LinksTypes.CertificateInfo}.
{@link com.vmware.vapi.std.errors.Error} - if the system reports an error while responding to the request.

Parameters:

spec - Specification for the new link to be created.

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

create

void create(LinksTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Creates a new hybrid link between the local and foreign PSC. 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 identifier of the newly linked domain. The return value will be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

Operation Errors:
AlreadyExists - If the link already exists.
InvalidArgument - If the values of any of the properties of the spec parameter are not valid.
Unsupported - If the PSC or the VC version is not supported.
Unauthorized - If the user is not authorized.
UnverifiedPeer - If the SSL certificate of the foreign PSC cannot be validated by comparing with the thumbprint provided in LinksTypes.CreateSpec.getSslThumbprint() or if LinksTypes.CreateSpec.getSslThumbprint() is null. The value of the UnverifiedPeer#data) property will be a class that contains all the properties defined in {@link com.vmware.vcenter.hvc.LinksTypes.CertificateInfo}.
{@link com.vmware.vapi.std.errors.Error} - if the system reports an error while responding to the request.

Parameters:

spec - Specification for the new link to be created.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String link)

Deletes an existing hybrid link. 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 - Identifier of the hybrid link. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

Throws:

NotFound - If the hybrid link associated with link does not exist.

Unauthorized - If the user is not authorized.

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

delete

void delete(java.lang.String link,
            InvocationConfig invocationConfig)

Deletes an existing hybrid link. 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 - Identifier of the hybrid link. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - If the hybrid link associated with link does not exist.

Unauthorized - If the user is not authorized.

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

delete

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

Deletes an existing hybrid link. 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:
NotFound - If the hybrid link associated with link does not exist.
Unauthorized - If the user is not authorized.
Error - if the system reports an error while responding to the request.

Parameters:

link - Identifier of the hybrid 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.

delete

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

Deletes an existing hybrid link. 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:
NotFound - If the hybrid link associated with link does not exist.
Unauthorized - If the user is not authorized.
Error - if the system reports an error while responding to the request.

Parameters:

link - Identifier of the hybrid 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.

list

java.util.List<LinksTypes.Summary> list()

Enumerates the list of registered hybrid links. 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.

Returns:

The List of hybrid link information.

Throws:

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

list

java.util.List<LinksTypes.Summary> list(InvocationConfig invocationConfig)

Enumerates the list of registered hybrid links. 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:

invocationConfig - Configuration for the method invocation.

Returns:

The List of hybrid link information.

Throws:

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

list

void list(AsyncCallback<java.util.List<LinksTypes.Summary>> asyncCallback)

Enumerates the list of registered hybrid links. 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 hybrid link information.

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

Parameters:

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

list

void list(AsyncCallback<java.util.List<LinksTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Enumerates the list of registered hybrid links. 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 hybrid link information.

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

Parameters:

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

invocationConfig - Configuration for the method invocation.