com.vmware.nsx.fabric

Class VirtualMachinesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.fabric.VirtualMachinesStub

All Implemented Interfaces:

VirtualMachines, VirtualMachinesTypes, com.vmware.vapi.bindings.Service

public class VirtualMachinesStub
extends com.vmware.vapi.internal.bindings.Stub
implements VirtualMachines

Remote stub implementation of the VirtualMachines API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.fabric.VirtualMachinesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
VirtualMachinesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
VirtualMachinesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
void	addtags(VirtualMachineTagUpdate virtualMachineTagUpdate) Perform action on a specific virtual machine.
void	addtags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Perform action on a specific virtual machine.
void	addtags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Perform action on a specific virtual machine.
void	addtags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Perform action on a specific virtual machine.
VirtualMachineListResult	list(java.lang.String cursor, java.lang.String displayName, java.lang.String excludeVmType, java.lang.String externalId, java.lang.String hostId, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all virtual machines.
void	list(java.lang.String cursor, java.lang.String displayName, java.lang.String excludeVmType, java.lang.String externalId, java.lang.String hostId, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<VirtualMachineListResult> asyncCallback) Returns information about all virtual machines.
void	list(java.lang.String cursor, java.lang.String displayName, java.lang.String excludeVmType, java.lang.String externalId, java.lang.String hostId, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<VirtualMachineListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all virtual machines.
VirtualMachineListResult	list(java.lang.String cursor, java.lang.String displayName, java.lang.String excludeVmType, java.lang.String externalId, java.lang.String hostId, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all virtual machines.
void	removetags(VirtualMachineTagUpdate virtualMachineTagUpdate) Perform action on a specific virtual machine.
void	removetags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Perform action on a specific virtual machine.
void	removetags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Perform action on a specific virtual machine.
void	removetags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Perform action on a specific virtual machine.
void	updatetags(VirtualMachineTagUpdate virtualMachineTagUpdate) Perform action on a specific virtual machine.
void	updatetags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Perform action on a specific virtual machine.
void	updatetags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Perform action on a specific virtual machine.
void	updatetags(VirtualMachineTagUpdate virtualMachineTagUpdate, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Perform action on a specific virtual machine.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VirtualMachinesStub

public VirtualMachinesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                           com.vmware.vapi.bindings.StubConfigurationBase config)

VirtualMachinesStub

public VirtualMachinesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                           com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

addtags

public void addtags(VirtualMachineTagUpdate virtualMachineTagUpdate)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

addtags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

addtags

public void addtags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

addtags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

invocationConfig - Configuration for the method invocation.

addtags

public void addtags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                    com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

addtags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

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

addtags

public void addtags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                    com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

addtags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

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

invocationConfig - Configuration for the method invocation.

list

public VirtualMachineListResult list(java.lang.String cursor,
                                     java.lang.String displayName,
                                     java.lang.String excludeVmType,
                                     java.lang.String externalId,
                                     java.lang.String hostId,
                                     java.lang.String includedFields,
                                     java.lang.Long pageSize,
                                     java.lang.Boolean sortAscending,
                                     java.lang.String sortBy)

Description copied from interface: VirtualMachines

Returns information about all virtual machines. If you have not added NSX tags on the VM or removed all the NSX tags that were earlier added to the VM, then tags property is not returned in the API response.

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

Specified by:

list in interface VirtualMachines

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

displayName - Display Name of the virtual machine (optional)

excludeVmType - VM types to be excluded (optional)

externalId - External id of the virtual machine (optional)

hostId - Id of the host where this vif is located (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.VirtualMachineListResult

list

public VirtualMachineListResult list(java.lang.String cursor,
                                     java.lang.String displayName,
                                     java.lang.String excludeVmType,
                                     java.lang.String externalId,
                                     java.lang.String hostId,
                                     java.lang.String includedFields,
                                     java.lang.Long pageSize,
                                     java.lang.Boolean sortAscending,
                                     java.lang.String sortBy,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VirtualMachines

Returns information about all virtual machines. If you have not added NSX tags on the VM or removed all the NSX tags that were earlier added to the VM, then tags property is not returned in the API response.

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

Specified by:

list in interface VirtualMachines

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

displayName - Display Name of the virtual machine (optional)

excludeVmType - VM types to be excluded (optional)

externalId - External id of the virtual machine (optional)

hostId - Id of the host where this vif is located (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.VirtualMachineListResult

list

public void list(java.lang.String cursor,
                 java.lang.String displayName,
                 java.lang.String excludeVmType,
                 java.lang.String externalId,
                 java.lang.String hostId,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<VirtualMachineListResult> asyncCallback)

Description copied from interface: VirtualMachines

Returns information about all virtual machines. If you have not added NSX tags on the VM or removed all the NSX tags that were earlier added to the VM, then tags property is not returned in the API response.

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

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

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

Specified by:

list in interface VirtualMachines

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

displayName - Display Name of the virtual machine (optional)

excludeVmType - VM types to be excluded (optional)

externalId - External id of the virtual machine (optional)

hostId - Id of the host where this vif is located (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

public void list(java.lang.String cursor,
                 java.lang.String displayName,
                 java.lang.String excludeVmType,
                 java.lang.String externalId,
                 java.lang.String hostId,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<VirtualMachineListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VirtualMachines

Returns information about all virtual machines. If you have not added NSX tags on the VM or removed all the NSX tags that were earlier added to the VM, then tags property is not returned in the API response.

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.VirtualMachineListResult

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

Specified by:

list in interface VirtualMachines

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

displayName - Display Name of the virtual machine (optional)

excludeVmType - VM types to be excluded (optional)

externalId - External id of the virtual machine (optional)

hostId - Id of the host where this vif is located (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.

removetags

public void removetags(VirtualMachineTagUpdate virtualMachineTagUpdate)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

removetags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

removetags

public void removetags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

removetags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

invocationConfig - Configuration for the method invocation.

removetags

public void removetags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                       com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

removetags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

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

removetags

public void removetags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                       com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

removetags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

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

invocationConfig - Configuration for the method invocation.

updatetags

public void updatetags(VirtualMachineTagUpdate virtualMachineTagUpdate)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

updatetags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

updatetags

public void updatetags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

updatetags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

invocationConfig - Configuration for the method invocation.

updatetags

public void updatetags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                       com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

updatetags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

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

updatetags

public void updatetags(VirtualMachineTagUpdate virtualMachineTagUpdate,
                       com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VirtualMachines

Perform action on a specific virtual machine. External id of the virtual machine needs to be provided in the request body. Some of the actions that can be performed are update tags, add tags, remove tags. To add tags to existing list of tag, use action parameter add_tags. To remove tags from existing list of tag, use action parameter remove_tags. To replace existing tags with new tags, use action parameter update_tags. To clear all tags, provide an empty list and action parameter as update_tags. The vmw-async: True HTTP header cannot be used with this API.

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

Specified by:

updatetags in interface VirtualMachines

Parameters:

virtualMachineTagUpdate - (required)

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

invocationConfig - Configuration for the method invocation.