Package com.vmware.nsx_policy.infra.realized_state

Interface SystemVirtualMachines

All Superinterfaces:

com.vmware.vapi.bindings.Service, SystemVirtualMachinesTypes

All Known Implementing Classes:

SystemVirtualMachinesStub

public interface SystemVirtualMachines
extends com.vmware.vapi.bindings.Service, SystemVirtualMachinesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.realized_state.SystemVirtualMachinesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
VirtualMachineListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String query, java.lang.Boolean sortAscending, java.lang.String sortBy)	Lists all the system virtual machines (example -Partner and Edge VMs etc)
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String query, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<VirtualMachineListResult> asyncCallback)	Lists all the system virtual machines (example -Partner and Edge VMs etc)
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String query, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<VirtualMachineListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Lists all the system virtual machines (example -Partner and Edge VMs etc)
VirtualMachineListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String query, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Lists all the system virtual machines (example -Partner and Edge VMs etc)

Method Detail

list

VirtualMachineListResult list(java.lang.String cursor,
                              java.lang.String includedFields,
                              java.lang.Long pageSize,
                              java.lang.String query,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy)

Lists all the system virtual machines (example -Partner and Edge VMs etc)

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (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)

query - Search query (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx_policy.model.VirtualMachineListResult

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

VirtualMachineListResult list(java.lang.String cursor,
                              java.lang.String includedFields,
                              java.lang.Long pageSize,
                              java.lang.String query,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Lists all the system virtual machines (example -Partner and Edge VMs etc)

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:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (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)

query - Search query (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.VirtualMachineListResult

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 cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String query,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<VirtualMachineListResult> asyncCallback)

Lists all the system virtual machines (example -Partner and Edge VMs etc)

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

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

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (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)

query - Search query (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

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

Lists all the system virtual machines (example -Partner and Edge VMs etc)

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

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (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)

query - Search query (optional)

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.