com.vmware.nsx.serviceinsertion.services

Interface ServiceDeployments

All Superinterfaces:

com.vmware.vapi.bindings.Service, ServiceDeploymentsTypes

All Known Implementing Classes:

ServiceDeploymentsStub

public interface ServiceDeployments
extends com.vmware.vapi.bindings.Service, ServiceDeploymentsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.serviceinsertion.services.ServiceDeploymentsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ServiceDeployment	create(java.lang.String serviceId, ServiceDeployment serviceDeployment) This will deploy a particular service on a given cluster / host.
void	create(java.lang.String serviceId, ServiceDeployment serviceDeployment, com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback) This will deploy a particular service on a given cluster / host.
void	create(java.lang.String serviceId, ServiceDeployment serviceDeployment, com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This will deploy a particular service on a given cluster / host.
ServiceDeployment	create(java.lang.String serviceId, ServiceDeployment serviceDeployment, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This will deploy a particular service on a given cluster / host.
void	delete(java.lang.String serviceId, java.lang.String serviceDeploymentId, java.lang.Boolean force) Remove the service deployment.
void	delete(java.lang.String serviceId, java.lang.String serviceDeploymentId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Remove the service deployment.
void	delete(java.lang.String serviceId, java.lang.String serviceDeploymentId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Remove the service deployment.
void	delete(java.lang.String serviceId, java.lang.String serviceDeploymentId, java.lang.Boolean force, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Remove the service deployment.
ServiceDeployment	get(java.lang.String serviceId, java.lang.String serviceDeploymentId) Returns detail of service deployment.
void	get(java.lang.String serviceId, java.lang.String serviceDeploymentId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback) Returns detail of service deployment.
void	get(java.lang.String serviceId, java.lang.String serviceDeploymentId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detail of service deployment.
ServiceDeployment	get(java.lang.String serviceId, java.lang.String serviceDeploymentId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detail of service deployment.
ServiceDeploymentListResult	list(java.lang.String serviceId) Returns the list of deployments for the given service
void	list(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeploymentListResult> asyncCallback) Returns the list of deployments for the given service
void	list(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeploymentListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of deployments for the given service
ServiceDeploymentListResult	list(java.lang.String serviceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of deployments for the given service
ServiceDeployment	update(java.lang.String serviceId, java.lang.String serviceDeploymentId, ServiceDeployment serviceDeployment) Deprecated.
void	update(java.lang.String serviceId, java.lang.String serviceDeploymentId, ServiceDeployment serviceDeployment, com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback) Deprecated.
void	update(java.lang.String serviceId, java.lang.String serviceDeploymentId, ServiceDeployment serviceDeployment, com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
ServiceDeployment	update(java.lang.String serviceId, java.lang.String serviceDeploymentId, ServiceDeployment serviceDeployment, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	upgrade(java.lang.String serviceId, java.lang.String serviceDeploymentId, DeploymentSpecName deploymentSpecName) If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store
void	upgrade(java.lang.String serviceId, java.lang.String serviceDeploymentId, DeploymentSpecName deploymentSpecName, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store
void	upgrade(java.lang.String serviceId, java.lang.String serviceDeploymentId, DeploymentSpecName deploymentSpecName, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store
void	upgrade(java.lang.String serviceId, java.lang.String serviceDeploymentId, DeploymentSpecName deploymentSpecName, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store

Method Detail

create

ServiceDeployment create(java.lang.String serviceId,
                         ServiceDeployment serviceDeployment)

This will deploy a particular service on a given cluster / host. Internally multiple service instance can be created during the deployment. If there are no issues in the parameters, the call returns immediately, and the service VMs will be deployed asynchronously. To get the overall status of the deployment or to get the status of individual service vm, please use the deployment status APIs.

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

Parameters:

serviceId - (required)

serviceDeployment - (required)

Returns:

com.vmware.nsx.model.ServiceDeployment

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

ServiceDeployment create(java.lang.String serviceId,
                         ServiceDeployment serviceDeployment,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This will deploy a particular service on a given cluster / host. Internally multiple service instance can be created during the deployment. If there are no issues in the parameters, the call returns immediately, and the service VMs will be deployed asynchronously. To get the overall status of the deployment or to get the status of individual service vm, please use the deployment status APIs.

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:

serviceId - (required)

serviceDeployment - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ServiceDeployment

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

create

void create(java.lang.String serviceId,
            ServiceDeployment serviceDeployment,
            com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback)

This will deploy a particular service on a given cluster / host. Internally multiple service instance can be created during the deployment. If there are no issues in the parameters, the call returns immediately, and the service VMs will be deployed asynchronously. To get the overall status of the deployment or to get the status of individual service vm, please use the deployment status APIs.

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

Invocation Result:
com.vmware.nsx.model.ServiceDeployment

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeployment - (required)

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

create

void create(java.lang.String serviceId,
            ServiceDeployment serviceDeployment,
            com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This will deploy a particular service on a given cluster / host. Internally multiple service instance can be created during the deployment. If there are no issues in the parameters, the call returns immediately, and the service VMs will be deployed asynchronously. To get the overall status of the deployment or to get the status of individual service vm, please use the deployment status APIs.

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:
com.vmware.nsx.model.ServiceDeployment

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeployment - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String serviceId,
            java.lang.String serviceDeploymentId,
            java.lang.Boolean force)

Remove the service deployment. Will remove all the Service VMs that were created as part of this deployment. User can send optional force delete option which will force remove the deployment, but should be used only when the regular delete is not working. Regular delete will ensure proper cleanup of Service VMs and related objects. Directly calling this API without trying regular undeploy will result in unexpected results, and orphan objects.

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

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(java.lang.String serviceId,
            java.lang.String serviceDeploymentId,
            java.lang.Boolean force,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Remove the service deployment. Will remove all the Service VMs that were created as part of this deployment. User can send optional force delete option which will force remove the deployment, but should be used only when the regular delete is not working. Regular delete will ensure proper cleanup of Service VMs and related objects. Directly calling this API without trying regular undeploy will result in unexpected results, and orphan objects.

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:

serviceId - (required)

serviceDeploymentId - (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

delete

void delete(java.lang.String serviceId,
            java.lang.String serviceDeploymentId,
            java.lang.Boolean force,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Remove the service deployment. Will remove all the Service VMs that were created as part of this deployment. User can send optional force delete option which will force remove the deployment, but should be used only when the regular delete is not working. Regular delete will ensure proper cleanup of Service VMs and related objects. Directly calling this API without trying regular undeploy will result in unexpected results, and orphan objects.

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

delete

void delete(java.lang.String serviceId,
            java.lang.String serviceDeploymentId,
            java.lang.Boolean force,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Remove the service deployment. Will remove all the Service VMs that were created as part of this deployment. User can send optional force delete option which will force remove the deployment, but should be used only when the regular delete is not working. Regular delete will ensure proper cleanup of Service VMs and related objects. Directly calling this API without trying regular undeploy will result in unexpected results, and orphan objects.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

get

ServiceDeployment get(java.lang.String serviceId,
                      java.lang.String serviceDeploymentId)

Returns detail of service deployment.

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

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

Returns:

com.vmware.nsx.model.ServiceDeployment

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

ServiceDeployment get(java.lang.String serviceId,
                      java.lang.String serviceDeploymentId,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns detail of service deployment.

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:

serviceId - (required)

serviceDeploymentId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ServiceDeployment

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String serviceId,
         java.lang.String serviceDeploymentId,
         com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback)

Returns detail of service deployment.

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

Invocation Result:
com.vmware.nsx.model.ServiceDeployment

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

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

get

void get(java.lang.String serviceId,
         java.lang.String serviceDeploymentId,
         com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns detail of service deployment.

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:
com.vmware.nsx.model.ServiceDeployment

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

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

invocationConfig - Configuration for the method invocation.

list

ServiceDeploymentListResult list(java.lang.String serviceId)

Returns the list of deployments for the given service

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

Parameters:

serviceId - (required)

Returns:

com.vmware.nsx.model.ServiceDeploymentListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

ServiceDeploymentListResult list(java.lang.String serviceId,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the list of deployments for the given service

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:

serviceId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ServiceDeploymentListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String serviceId,
          com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeploymentListResult> asyncCallback)

Returns the list of deployments for the given service

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

Invocation Result:
com.vmware.nsx.model.ServiceDeploymentListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

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

list

void list(java.lang.String serviceId,
          com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeploymentListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the list of deployments for the given service

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:
com.vmware.nsx.model.ServiceDeploymentListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

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

invocationConfig - Configuration for the method invocation.

update

@Deprecated
ServiceDeployment update(java.lang.String serviceId,
                                     java.lang.String serviceDeploymentId,
                                     ServiceDeployment serviceDeployment)

Deprecated.

Update an existing Service Deployment.
This API is deprecated since only property we can change on service deployment is display name, which is used for the SVM name. Changing the name will cause the name of the deployment to go out of sync with the deployed VM.

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

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

serviceDeployment - (required)

Returns:

com.vmware.nsx.model.ServiceDeployment

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

@Deprecated
ServiceDeployment update(java.lang.String serviceId,
                                     java.lang.String serviceDeploymentId,
                                     ServiceDeployment serviceDeployment,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Update an existing Service Deployment.
This API is deprecated since only property we can change on service deployment is display name, which is used for the SVM name. Changing the name will cause the name of the deployment to go out of sync with the deployed VM.

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:

serviceId - (required)

serviceDeploymentId - (required)

serviceDeployment - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ServiceDeployment

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

@Deprecated
void update(java.lang.String serviceId,
                        java.lang.String serviceDeploymentId,
                        ServiceDeployment serviceDeployment,
                        com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback)

Deprecated.

Update an existing Service Deployment.
This API is deprecated since only property we can change on service deployment is display name, which is used for the SVM name. Changing the name will cause the name of the deployment to go out of sync with the deployed VM.

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

Invocation Result:
com.vmware.nsx.model.ServiceDeployment

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

serviceDeployment - (required)

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

update

@Deprecated
void update(java.lang.String serviceId,
                        java.lang.String serviceDeploymentId,
                        ServiceDeployment serviceDeployment,
                        com.vmware.vapi.bindings.client.AsyncCallback<ServiceDeployment> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Update an existing Service Deployment.
This API is deprecated since only property we can change on service deployment is display name, which is used for the SVM name. Changing the name will cause the name of the deployment to go out of sync with the deployed VM.

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:
com.vmware.nsx.model.ServiceDeployment

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

serviceDeployment - (required)

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

invocationConfig - Configuration for the method invocation.

upgrade

void upgrade(java.lang.String serviceId,
             java.lang.String serviceDeploymentId,
             DeploymentSpecName deploymentSpecName)

If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store

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

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

deploymentSpecName - (required)

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

upgrade

void upgrade(java.lang.String serviceId,
             java.lang.String serviceDeploymentId,
             DeploymentSpecName deploymentSpecName,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store

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:

serviceId - (required)

serviceDeploymentId - (required)

deploymentSpecName - (required)

invocationConfig - Configuration for the method invocation.

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

upgrade

void upgrade(java.lang.String serviceId,
             java.lang.String serviceDeploymentId,
             DeploymentSpecName deploymentSpecName,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store

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

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

deploymentSpecName - (required)

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

upgrade

void upgrade(java.lang.String serviceId,
             java.lang.String serviceDeploymentId,
             DeploymentSpecName deploymentSpecName,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If new deployment spec is provided, the deployment will be moved to the provided spec provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL If same deployment spec is provided, upgrade will be done only if current deployment state is UPGRADE_FAILED If the exisiting data store is upgraded or changed, there is an optional parameter to supply the new storage Id during upgrade which would perform the deployment upgrade on the new data store

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

serviceId - (required)

serviceDeploymentId - (required)

deploymentSpecName - (required)

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

invocationConfig - Configuration for the method invocation.